Skip to main content
Version: Version 5 beta

Interface: WidgetAnnotationOptions

Base options for all annotations

Extends​

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

Inherited from​

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

AnnotationOptions.content

dateModified?​

optional dateModified: Date

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

Inherited from​

AnnotationOptions.dateModified

page​

page: Page

Page in which the annotation is embedded.

Inherited from​

AnnotationOptions.page

privateData?​

optional privateData: object

Custom data to be stored with the annotation

Default Value​

undefined

Inherited from​

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

AnnotationOptions.renderProperties