Skip to main content
Version: Version 5

Interface: AnnotationOptions

Base options for all annotations

Extended by​

Properties​

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

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​

""

dateModified?​

optional dateModified?: Date

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

page​

page: Page

Page in which the annotation is embedded.

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

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.