AnnotationSettings

6 Jul 20261 minute to read

The AnnotationSettings module is used to provide the properties to annotations.

<div id="pdfViewer" style="height: 100%;width: 100%;"></div>

 let viewer: PdfViewer = new PdfViewer();
 // Change the annotation settings.
 viewer.annotationSettings = {
     author: 'Guest',
     minHeight: 0,
     minWidth: 0,
     maxWidth: 0,
     maxHeight: 0,
     isLock: false,
     skipPrint: false,
     skipDownload: false,
     customData: null,
     allowedInteractions: ['None'],
     subject: ''
 };
 viewer.appendTo("#pdfViewer");

Properties

allowedInteractions AllowedInteraction[]

Gets or sets the allowed interactions for the locked annotations.
IsLock can be configured using annotation settings.

Defaults to [‘None’]

author string

specifies the author of the annotation.

Defaults to ‘Guest’

customData object

specifies the custom data of the annotation.

Defaults to null

isLock boolean

specifies the locked action of the annotation.

Defaults to false

maxHeight number

specifies the maxHeight of the annotation.

Defaults to 0

maxWidth number

specifies the maxWidth of the annotation.

Defaults to 0

minHeight number

specifies the minHeight of the annotation.

Defaults to 0

minWidth number

specifies the minWidth of the annotation.

Defaults to 0

skipDownload boolean

specifies whether the annotations are included or not in download actions.

Defaults to false

skipPrint boolean

specifies whether the annotations are included or not in print actions.

Defaults to false

subject string

specifies the subject of the annotation.

Defaults to ’’