PdfAnnotationBaseModel API in JavaScript PDF Viewer API control

Interface for a class PdfAnnotationBase

Properties

allowedInteractions

AllowedInteraction

specifies the allowed interactions of the locked annotation.

annotName

string

Represents the unique annotName of the annotation

annotationAddMode

string

specifies the particular annotation mode.

annotationSelectorSettings

AnnotationSelectorSettingsModel

Represents the selection settings of the annotation

annotationSettings

object

specifies the default settings of the annotation.

author

string

Represents the auther value of the annotation

borderDashArray

string

Represents the border dash array of annotation

borderStyle

string

Represents the border style of annotation

bounds

PdfBoundsModel

Represents bounds of the annotation

cloudIntensity

number

Represents the cloud intensity

comments

ICommentsCollection[]

Represents the comments collection of the annotation

customData

object

specifies the custom data of the annotation.

data

string

Represents the path data of the annotation

dynamicText

string

Represents the dynamic text.

enableShapeLabel

boolean

Represents the shape annotation label add flag

fillColor

string

Represents the fill color of the annotation

font

PdfFontModel

Represents the text style of annotation

fontColor

string

Represents the comments collection of the annotation

fontFamily

string

Represents the font family of the annotation content

fontSize

number

Represents the font size of the annotation content

fontStyle

string

Represents the font style of the annotation content

formFieldAnnotationType

FormFieldAnnotationType

Represents the annotation type of the form field

id

string

Represents the unique id of annotation

isCloudShape

boolean

Represents the annotation as cloud shape

isCommentLock

boolean

specifies the locked action of the comment

isDynamicStamp

boolean

Represents the dynamic stamp

isLock

boolean

specifies the locked action of the annotation.

isPrint

boolean

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

isReadonly

boolean

Allows to edit the free text annotation

labelBorderColor

string

Represents the shape annotation label content border color

labelBounds

PdfBoundsModel

Represents the shape annotation label content bounds

labelContent

string

Represents the shape annotation label content

labelFillColor

string

Represents the shape annotation label content fill color

labelMaxLength

number

Represents the shape annotation label content max-length

labelOpacity

number

Represents the opecity value of the annotation

leaderHeight

number

Represents the height of the leader of distance shapes

lineHeadEnd

string

Represents the line end shape style

lineHeadStart

string

Represents the line start shape style

maxHeight

number

specifies the minHeight of the annotation.

maxWidth

number

specifies the maxWidth of the annotation.

measureType

string

Represents the measure type of the annotation

minHeight

number

specifies the minHeight of the annotation.

minWidth

number

specifies the minWidth of the annotation.

modifiedDate

string

Represents the modified date of the annotation

notes

string

Represents the notes of the annotation

opacity

number

Represents the opecity value of the annotation

pageIndex

number

Represents the cloud intensity

previousFontSize

number

specifies the previous font size of the annotation.

review

IReviewCollection

Represents the review collection of the annotation

rotateAngle

number

Represents the rotate angle of annotation

segments

PointModel[]

Represents vertex points in the line annotation or shape annotation.

shapeAnnotationType

PdfAnnotationType

Represents the annotation type of the pdf

signatureName

string

Represents the unique Name of the annotation

sourceDecoraterShapes

DecoratorShapes

Represents vertex points in the line annotation or shape annotation.

sourcePoint

PointModel

Represents vertex points in the line annotation or shape annotation.

stampFillColor

string

Represents the fill color of the annotation

stampStrokeColor

string

Represents the stroke color of the annotation

strokeColor

string

Represents the stroke color of the annotation

subject

string

Represents the subject of the annotation

taregetDecoraterShapes

DecoratorShapes

Represents vertex points in the line annotation or shape annotation.

targetPoint

PointModel

Represents vertex points in the line annotation or shape annotation.

textAlign

string

Represents the text anlignment style of annotation

thickness

number

Represents the thickness value of annotation

vertexPoints

PointModel[]

Represents vertex points in the line annotation or shape annotation.

wrapper

Container

Represents the cloud intensity

zIndex

number

Represents the cloud intensity