Skip to main content
Version: Version 5

Interface: LineAnnotationOptions

Base options for all annotations

Extends​

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

color?​

optional color?: RgbaColor

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

endPoint?​

optional endPoint?: PdfPoint

lineEndingAtEnd?​

optional lineEndingAtEnd?: LineEnding

lineEndingAtStart?​

optional lineEndingAtStart?: LineEnding

lineWidth?​

optional lineWidth?: number

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?: object

Custom data to be stored with the annotation

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

startPoint?​

optional startPoint?: PdfPoint

stroke?​

optional stroke?: Stroke

annotation stroke

Inherited from​

DrawingAnnotationOptions.stroke

subject?​

optional subject?: string

Inherited from​

DrawingAnnotationOptions.subject