Edit, add, and find annotations

Use APIs to edit, add, and find annotations.

startAnnotation(string annotationType, boolean isSticky)
Use this method to programmatically activate an annotation type to be used.
cancelAnnotation(string annotationType)
Use this method to cancel the drawing of an annotation where you mistakenly initiated an annotation draw with the existing startAnnotation() API method.
addAnnotation(String annotationProperties)
Adds one or more annotations with properties.
deleteAllAnnotations(String type, Int page)
Deletes the annotation of the specified type from the specified page.
deleteAnnotation(String annotationLabel)
This method deletes the annotation that has the specified label.
getActiveAnnotation()
Returns the label of the active annotation where the active annotation is the annotation that is currently selected.
getAnnotations(String json)
Use this method to get annotations from the viewer based on their status.
getAnnotationById(String id)
This method returns the properties of the specified annotation with the specified ID.
getAnnotation(String annotationLabel)
Returns a delimited list that contains the properties of the annotation for the label that you specify on the current page.
getAnnotationLabels(String type, Int page, Int order)
Returns a delimited list that contains the labels of the annotations that are on the specified page, for the specified type.
getDelimiter()
Sets the string that IBM Daeja ViewONE must use as a delimiter in returned Strings that contain multiple values.
setDelimiter()
Sets the string that IBM Daeja ViewONE is to use as a delimiter in returned Strings that contain multiple values.
modifyAnnotation(String label, String annotationProperties)
Calling this method modifies the properties of the annotation with the specified label to the properties that you specify.
setAnnotationsSemiTransparent()
Sets whether the annotations are semitransparent or not.

Parent topic: Annotations options