Skip to main content
Version: Version 5

Interface: ShapeAnnotationOptions

Extends​

Extended by​

Properties​

author?​

optional author?: string

Inherited from​

DrawingAnnotationOptions.author

blendMode?​

optional blendMode?: BlendMode

Experimental

blend mode

Inherited from​

DrawingAnnotationOptions.blendMode

boundingBox?​

optional boundingBox?: Rectangle<PdfPoint>

Represents the bounding box of the annotation, which defines its position and size on the page. The bounding box is specified as a Rectangle of PdfPoint coordinates.

Default Value​

null

Inherited from​

DrawingAnnotationOptions.boundingBox

content?​

optional content?: string

Text that shall be displayed for the annotation or, if this type of annotation does not display text, an alternative description of the annotation’s contents in human-readable form.

Default Value​

""

Inherited from​

DrawingAnnotationOptions.content

dateModified?​

optional dateModified?: Date

The date and time when the annotation was most recently modified.

Inherited from​

DrawingAnnotationOptions.dateModified

fill?​

optional fill?: string

annotation fill

opacity?​

optional opacity?: number

Experimental

annotation opacity

Inherited from​

DrawingAnnotationOptions.opacity

page​

page: Page

Page in which the annotation is embedded.

Inherited from​

DrawingAnnotationOptions.page

privateData?​

optional privateData?: string

Custom data to be stored with the annotation. This can be used to store any additional information relevant to the annotation that is not covered by the standard properties.

Default Value​

undefined

Inherited from​

DrawingAnnotationOptions.privateData

renderProperties?​

optional renderProperties?: AnnotationRenderProperties

The AnnotationRenderProperties class encapsulates the rendering properties of a PDF annotation, providing a set of flags that control its rendering behaviors.

Inherited from​

DrawingAnnotationOptions.renderProperties

stroke?​

optional stroke?: Stroke

annotation stroke

Inherited from​

DrawingAnnotationOptions.stroke

subject?​

optional subject?: string

Inherited from​

DrawingAnnotationOptions.subject