DistanceSettings

23 Sep 20253 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.

author string

specifies the author of the annotation.

borderDashArray number

specifies the border dash array of the annotation.

customData object

specifies the custom data of the annotation.

fillColor string

specifies the fill color of the annotation.

isLock boolean

specifies the locked action of the annotation.

isPrint boolean

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

leaderLength number

specifies the leader length of the annotation.

lineHeadEndStyle LineHeadStyle

specifies the line head end style of the annotation.

lineHeadStartStyle LineHeadStyle

specifies the line head start style of the annotation.

maxHeight number

specifies the maxHeight of the annotation.

maxWidth number

specifies the maxWidth of the annotation.

minHeight number

specifies the minHeight of the annotation.

minWidth number

specifies the minWidth of the annotation.

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.

resizeCursorType CursorType

Defines the cursor type for distance annotation.

strokeColor string

specifies the stroke color of the annotation.

subject string

specifies the subject of the annotation.

thickness number

specified the thickness of the annotation.

vertexPoints PointModel[]

Get or set vertex points of the annotation.

Defaults to []