getAnnotations(String json)

Use this method to get annotations from the viewer based on their status.

This method gets the annotations based on the status that is specified in the JSON string parameter supplied. The JSON format is as follows:
{"status":"<status>"}
Where <status> can be replaced with one of the following values:
  • 'all': Gets all annotations that are currently present in the document. Deleted annotations are not included.
  • 'new': Gets any annotations that were added to the document since a user last saved or loaded annotations.
  • 'modified': Gets any annotations that were modified in the document since a user last saved or loaded annotations.
  • 'deleted': Gets any annotations that were deleted in the document since a user last saved or loaded annotations.
  • 'unchanged': Gets all annotations that are not new, modified, or deleted.

If the JSON entry is empty or null, all annotations that are present in the document are returned. Deleted annotations are not included.

If the status is an invalid entry and if the traceException parameter is set to true, an exception is logged. In this case, the method returns undefined.

Sample syntax

var strAnnotations = ViewONE.getAnnotations('{"status":"new"}');