Skip to main content
Version: Version 5

Interface: TextMarkupAnnotationOptions

Interface representing options for text markup annotations.

This interface extends MarkupAnnotationOptions and provides additional properties specific to text markup annotations, such as the marked area, annotation subtype, and fill color.

Extends​

Properties​

author?​

optional author: string

Inherited from​

MarkupAnnotationOptions.author

blendMode?​

optional blendMode: BlendMode

Experimental

blend mode

Inherited from​

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

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

MarkupAnnotationOptions.content

dateModified?​

optional dateModified: Date

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

Inherited from​

MarkupAnnotationOptions.dateModified

fillColor?​

optional fillColor: RgbColor

The color used to fill the marked-up area.

opacity?​

optional opacity: number

Experimental

annotation opacity

Inherited from​

MarkupAnnotationOptions.opacity

page​

page: Page

Page in which the annotation is embedded.

Inherited from​

MarkupAnnotationOptions.page

privateData?​

optional privateData: object

Custom data to be stored with the annotation

Default Value​

undefined

Inherited from​

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

MarkupAnnotationOptions.renderProperties

subject?​

optional subject: string

Inherited from​

MarkupAnnotationOptions.subject

subtype?​

optional subtype: TextMarkupType

Specifies the subtype of text markup annotation. Determines how the text is visually marked, such as highlight, underline, strikethrough, squiggly, or redact.

textMarkupArea?​

optional textMarkupArea: Quadrilateral<PdfPoint>[]

An array of quadrilateral regions defining the marked-up text area. Each quadrilateral represents a portion of the text affected by the annotation.