AreaSettings

9 Jul 20263 minutes to read

The AreaSettings module is used to provide the properties to area calibrate annotation.

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

Properties

allowedInteractions AllowedInteraction[]

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

Defaults to [‘None’]

annotationSelectorSettings AnnotationSelectorSettingsModel

specifies the annotation selector settings of the annotation.

Defaults to ’’

author string

specifies the author of the annotation.

Defaults to ‘Guest’

fillColor string

specifies the fill color of the annotation.

Defaults to ‘#ffffff00’

isLock boolean

specifies the locked action of the annotation.

Defaults to false

isPrint boolean

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

Defaults to true

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

offset IPoint

Get or set offset of the annotation.

Defaults to { x: 0, y: 0}

opacity number

specifies the opacity of the annotation.

Defaults to 1

pageNumber number

Get or set page number of the annotation.

Defaults to 1

strokeColor string

specifies the stroke color of the annotation.

Defaults to ‘#ff0000’

subject string

specifies the subject of the annotation.

Defaults to ’’

thickness number

specified the thickness of the annotation.

Defaults to 1

vertexPoints PointModel[]

Get or set vertex points of the annotation.

Defaults to []