Annotations options

You can use the annotations parameters to determine annotation options such as availability, color, deletion, error message display, text, redaction, and save options.

annotate
The annotate parameter is used to toggle the annotation feature on or off. When this parameter is set to false, all annotations features are disabled in the viewer: the annotation toolbar is removed from the viewer interface, and annotations cannot be viewed or edited, and are not retrieved.
annotateEdit
The annotateEdit parameter is used to toggle the ability to edit annotations on or off.
annotationFile
The annotationFile parameter defines the URL from which the annotation data is retrieved when the document loads.
annotationsSticky
Use the annotationsSticky parameter to enable the annotation sticky mode, which keeps the cursor in annotations drawing mode and allows you to reuse a selected annotation type without having to reselect it from the annotations toolbar.
annotationDefaults
This parameter specifies the annotation types that are burnable, rather than a separate layer. You can also use this parameter to set the default annotation security settings.
suppressExcelAnnotWarning
Use this method to control the display of the warning message when rendering Excel documents in versions later than V5.0.7.
Encoding and error messages
You can use the encoding parameters determine whether the viewer uses a text encoding type that allows multiple-byte characters to be used, or whether the viewer converts characters to their HTML-encoded counterparts.
Module version and migration
Use the annotation migration support parameters to configure version checking, determine when the user is notified of annotation changes, and how the viewer handles misplaced annotations.
Saving
You can use the save parameters to determine whether annotations are saved automatically and whether users are prompted to save annotations. POST data is also configured by the save parameters. You can also determine how annotations are handled by server-side components. By managing server-side components, you can reduce the amount of data that is sent to the server.
Security
You can use the annotation security parameters to determine the default security settings for specified annotations. You can specify whether the viewer accepts calls for certain JavaScript methods to provide an extra level of security. The parameters also configure the administrator that can edit security settings and password options in the security dialog box.
Toolbars, buttons, and menus
You can use the parameters to determine which annotation types are affected when you display and hide toolbars, buttons, and menus.
Annotation style
You can use the style parameters to determine the default line width for new annotations.

Parent topic: Viewer modes