VolumeSettings

23 Sep 20252 minutes to read

The VolumeSettings module is used to provide the properties to volume calibrate annotation.

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

 let viewer: PdfViewer = new PdfViewer();
 // Change the volume annotation settings.
 viewer.volumeSettings = {
     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 volume annotations.
IsLock can be configured using volume settings.

Defaults to [‘None’]

annotationSelectorSettings AnnotationSelectorSettingsModel

specifies the annotation selector settings of the annotation.

author string

specifies the author 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.

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.

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