field.text-annotation

A component for text segmentation.

Use it to select multiple words, individual words, or letters in the text and label them with values. You can create multiple categories to label parts of the text, like all nouns and adjectives.

View example in the sandbox.

You can use plugin.field.text-annotation.hotkeys to assign keyboard shortcuts for selecting categories.

Component properties

NameTypeDescription
type*"field.text-annotation"

Set component type

data*writable

Data with values that will be processed or changed.

labelstring

Label above the component.

adjuststring

If the property value is set to words, only words can be selected in the text. If you don't use this property, any part of a line can be selected.

content*string

The text where the performer has to select part of a line.

disabledboolean

This property blocks the component. If true, the component is unavailable to the performer. The default value is false.

hintstring

Hint text.

labels*array

An array of categories that the performer uses to label parts of the text.

labels[]object

A category.

labels[].label*string

Specify the category name in the label property.

labels[].value*string

Specify the category value in the value property.

validationcondition

Validation based on condition.