Text Annotate

Overview

A text field used for highlighting and tagging text.

Properties

Name	Type	Description
name	string	Component name
annotations	UITextAnnotation[]	An array of annotation objects
addedAnnotation	TextAnnotationAddedEvent	Last added annotation event
removedAnnotation	TextAnnotationRemovedEvent	Last removed annotation event

Methods

Name	Parameters	Returns	Description
setTags	tags: string[] | object[]	void	Set component tags. Tags is an array of strings or objects with the following structure: { label: string; key: string; color: string }
setText	value: string	void	Set component text setting
setAnnotations	annotations: object[]	void	Set component annotations setting. Annotations is an array of object with the following structure: { startIndex: number; endIndex: number; key: string; label: string text: string }

Triggers

Name	Description
On Init	Triggered when the component is initialized
On Change	Triggered when the component's state changes
On Annotation Add	Triggered when an annotation is added
On Annotation Remove	Triggered when an annotation is removed