HighlightSettings

23 Sep 20252 minutes to read

The HighlightSettings module is used to provide the properties to Highlight annotation.

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

 let viewer: PdfViewer = new PdfViewer();
 // Change the highlight annotation settings.
 viewer.highlightSettings = {
     pageNumber: 1,
     bounds: [],
     opacity: 1,
     color: '#ff0000',
     author: 'Guest',
     annotationSelectorSettings: {
         selectionBorderColor: '',
         resizerBorderColor: 'black',
         resizerFillColor: '#FF4081',
         resizerSize: 8,
         selectionBorderThickness: 1,
         resizerShape: 'Square',
         selectorLineDashArray: [],
         resizerLocation: AnnotationResizerLocation.Corners | AnnotationResizerLocation.Edges
     },
     customData: null,
     isLock: false,
     enableMultiPageAnnotation: false,
     enableTextMarkupResizer: false,
     allowedInteractions: ['None'],
     isPrint: true,
     subject: ''
 };
 viewer.appendTo("#pdfViewer");

Properties

allowedInteractions AllowedInteraction[]

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

Defaults to [‘None’]

annotationSelectorSettings AnnotationSelectorSettingsModel

specifies the annotation selector settings of the annotation.

author string

specifies the author of the annotation.

bounds IAnnotationPoint[]

Get or set bounds of the annotation.

Defaults to []

color string

specifies the color of the annotation.

customData object

specifies the custom data of the annotation.

enableMultiPageAnnotation boolean

Enables or disables the multi-page text markup annotation selection in UI.

Defaults to false

enableTextMarkupResizer boolean

Enable or disable the text markup resizer to modify the bounds in UI.

Defaults to false

isLock boolean

specifies the locked action of the annotation.

isPrint boolean

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

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.