DistanceSettings

9 Jul 20263 minutes to read

The DistanceSettings module is used to provide the properties to distance calibrate annotation.

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

 let viewer: PdfViewer = new PdfViewer();
 // Change the distance annotation settings.
 viewer.distanceSettings = {
     offset: { x:0, y:0 },
     pageNumber: 1,
     vertexPoints: [],
     opacity: 1,
     fillColor: '#4070FF',
     strokeColor: '#ff0000',
     author: 'Guest',
     thickness: 1,
     borderDashArray: 0,
     lineHeadStartStyle: 'Closed',
     lineHeadEndStyle: 'Closed',
     annotationSelectorSettings: {
         selectionBorderColor: '',
         resizerBorderColor: 'black',
         resizerFillColor: '#FF4081',
         resizerSize: 8,
         selectionBorderThickness: 1,
         resizerShape: 'Square',
         selectorLineDashArray: [],
         resizerLocation: AnnotationResizerLocation.Corners | AnnotationResizerLocation.Edges,
         resizerCursorType: null
     },
     minHeight: 0,
     minWidth: 0,
     maxWidth: 0,
     maxHeight: 0,
     isLock: false,
     customData: null,
     leaderLength: 40,
     resizeCursorType: CursorType.move,
     allowedInteractions: ['None'],
     isPrint: true,
     subject: ''
 };
 viewer.appendTo("#pdfViewer");

Properties

allowedInteractions AllowedInteraction[]

Gets or sets the allowed interactions for the locked distance annotations.
IsLock can be configured using distance 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’

borderDashArray number

specifies the border dash array of the annotation.

Defaults to 0

customData object

specifies the custom data of the annotation.

Defaults to null

fillColor string

specifies the fill color of the annotation.

Defaults to ‘#ff0000’

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

leaderLength number

specifies the leader length of the annotation.

Defaults to 40

lineHeadEndStyle LineHeadStyle

specifies the line head end style of the annotation.

Defaults to ‘None’

lineHeadStartStyle LineHeadStyle

specifies the line head start style of the annotation.

Defaults to ‘None’

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

resizeCursorType CursorType

Defines the cursor type for distance annotation.

Defaults to ‘move’

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 []