Output fields

active 

sbool 

True when in annotation mode, false otherwise.

annotations 

sjson 

Provides the information about the annotations in scene. See Example JSON for definition.

existsAnnotations

sbool

True when at least one annotation is in scene, false otherwise.

mode

senum

Accepted values are:

• idle when entering or exiting annotation mode, or when no annotation in scene is selected.

• edit when an annotation is selected and can be edited.

• delete when in delete state, where the selected annotation is deleted.

• arrow when an AnnotationArrow is in creation.

• callout when a callout annotation is in creation.

• circle when an AnnotationCircle is in creation.

• freeHand when an AnnotationFreeHand is in creation.

• line when an AnnotationArrow is in creation.

• rect when an AnnotationRect is in creation.

• shape when an AnnotationShape is in creation.

• text when an AnnotationText is in creation.

selectedAnnotation

sstring

Name of the annotation currently selected in scene. Note that only one annotation can be selected at any given time.

selectedAnnotationHasText

sbool

True when the currently selected annotation is a text or a callout, false otherwise.