Search results

CircleSettings API in Vue PDF Viewer API component

The CircleSettings module is used to provide the properties to circle annotation.

<div id="pdfViewer" style="height: 100%;width: 100%;"></div>
 let viewer: PdfViewer = new PdfViewer();
 // Change the circle annotation settings.
 viewer.circleSettings = {
     opacity: 1,
     fillColor: '#9c2592',
     strokeColor: '#ff0000',
     author: 'Guest',
     thickness: 1,
     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,
     allowedInteractions: ['None'],
     isPrint: true
 };
 viewer.appendTo("#pdfViewer");

Properties

allowedInteractions

AllowedInteraction[]

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

Defaults to [‘None’]

annotationSelectorSettings

AnnotationSelectorSettingsModel

specifies the annotation selector settings of the annotation.

author

string

specifies the author of the annotation.

customData

object

specifies the custom data of the annotation.

fillColor

string

specifies the fill color of the annotation.

height

number

specifies the height 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 minHeight 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.

width

number

specifies the width of the annotation.