StickyNotesSettings

23 Sep 20252 minutes to read

The stickyNotesSettings module is used to provide the properties to sticky notes annotation.

<div id="pdfViewer" style="height: 100%;width: 100%;"></div>
 let viewer: PdfViewer = new PdfViewer();
 // Change the sticky notes annotation settings.
 viewer.stickyNotesSettings = {
     offset: { x:0, y:0 },
     pageNumber: 1,
     author: 'Guest',
     opacity: 1,
     annotationSelectorSettings: {
         selectionBorderColor: '',
         resizerBorderColor: 'red',
         resizerFillColor: '#4070FF',
         resizerSize: 8,
         selectionBorderThickness: 1,
         resizerShape: 'Circle',
         selectorLineDashArray: [],
         resizerLocation: AnnotationResizerLocation.Corners | AnnotationResizerLocation.Edges,
         resizerCursorType: null
     },
     isLock: false,
     customData: null,
     allowedInteractions: ['None'],
     isPrint: true,
     subject: ''
 };
 viewer.appendTo("#pdfViewer");

Properties

allowedInteractions AllowedInteraction[]

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

Defaults to [‘None’]

annotationSelectorSettings AnnotationSelectorSettingsModel

specifies the annotation selector settings of the annotation.

author string

specifies the author of the annotation.

customData object

specifies the custom data of the annotation.

isLock boolean

specifies the lock action of the annotation.

isPrint boolean

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

offset IPoint

Get or set offset of the annotation.

opacity number

specifies the opacity of the annotation.

pageNumber number

Get or set page number of the annotation.

subject string

specifies the subject of the annotation.