Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA™ XR Studio

Input fields

  • Last UpdatedMar 16, 2026
  • 1 minute read

The input fields in the Annotation module.

Name 

Type 

Description 

enter

sevent 

Invoke to enter annotation mode.

exit 

sevent 

Invoke to exit annotation mode.

hideAllAnnotations 

sevent 

Invoke to hide all the annotations in scene. 

mode

senum 

Accepted values are:

  • idle to enter the default state, such as. when entering or exiting annotation mode, or when no annotation in scene is selected.

  • edit to enter edit state, where selected annotation can be resized or moved and texts can be written.

  • delete to enter delete state, where the selected annotion is deleted.

  • arrow to start the creation of an AnnotationArrow.

  • callout to start the creation of an callout annotation, such as an AnnotationArrow with an AnnotationText.

  • circle to start the creation of an AnnotationCircle.

  • freeHand to start the creation of an AnnotationFreeHand.

  • line to start the creation of an AnnotationArrow, since line is an AnnotationArrow with shapeHeadParams set to 0 0.

  • rect to start the creation of an AnnotationRect.

  • shape to start the creation of an AnnotationShape.

  • text to start the creation of an AnnotationText.

setFromJson 

sjson

Provides the required information to create new annotations. See Example JSON for definition.

setText

sjson 

Provides the required information to override the text of the currently selected annotation, if it is of type text or callout. The example JSON string is {"text":"' + text + '"}.

showAllAnnotations 

sevent 

Invoke to show all the annotations hidden in scene. 

Related Links
TitleResults for “How to create a CRG?”Also Available in