LineSettings API in React PDF Viewer API component

The LineSettings module is used to provide the properties to line annotation.

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

 let viewer: PdfViewer = new PdfViewer();
 // Change the line annotation settings.
 viewer.lineSettings = {
     opacity: 1,
     color: '#9c2592',
     author: 'Guest',
     annotationSelectorSettings: {
         selectionBorderColor: '',
         resizerBorderColor: 'black',
         resizerFillColor: '#FF4081',
         resizerSize: 8,
         selectionBorderThickness: 1,
         resizerShape: 'Square',
         selectorLineDashArray: [],
         resizerLocation: AnnotationResizerLocation.Corners | AnnotationResizerLocation.Edges
     },
     isLock: false,
     enableMultiPageAnnotation: false,
     enableTextMarkupResizer: false,
     allowedInteractions: ['None'],
     isPrint: true
 };
 viewer.appendTo("#pdfViewer");

Properties

allowedInteractions

AllowedInteraction[]

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

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 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.

thickness

number

specified the thickness of the annotation.

vertexPoints

PointModel[]

Get or set vertex points of the annotation.

Defaults to []