Skip to main content
Version: Version 5

Abstract Class: MarkupAnnotation

Base class for all markup annotations

Extends​

Extended by​

Constructors​

Constructor​

new MarkupAnnotation(options): MarkupAnnotation

Parameters​

options​

MarkupAnnotationOptions

Returns​

MarkupAnnotation

Overrides​

Annotation.constructor

Accessors​

author​

Get Signature​

get author(): string

The author.

Returns​

string

Set Signature​

set author(author): void

Parameters​
author​

string

Returns​

void

blendMode​

Get Signature​

get blendMode(): BlendMode

Experimental

blend mode

Returns​

BlendMode

Set Signature​

set blendMode(blendMode): void

Parameters​
blendMode​

BlendMode

Returns​

void

boundingBox​

Get Signature​

get 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.

Returns​

Rectangle<PdfPoint>

Set Signature​

set boundingBox(rectangle): void

Parameters​
rectangle​

Rectangle<PdfPoint>

Returns​

void

Inherited from​

Annotation.boundingBox

content​

Get Signature​

get 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.

Returns​

string

Set Signature​

set content(content): void

Parameters​
content​

string

Returns​

void

Inherited from​

Annotation.content

creationDate​

Get Signature​

get creationDate(): Date

The date and time when the annotation was created.

This property retrieves the creation date from the annotation and converts it to a JavaScript Date object.

Returns​

Date

The creation date as a JavaScript Date object, or null if no creation date is available in the annotation.

dateModified​

Get Signature​

get dateModified(): Date

Experimental

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

Returns​

Date

Set Signature​

set dateModified(date): void

Parameters​
date​

Date

Returns​

void

Inherited from​

Annotation.dateModified

hasChanges​

Get Signature​

get hasChanges(): boolean

Experimental

Indicates if the annotation has been changed since the document was opened

Returns​

boolean

Inherited from​

Annotation.hasChanges

hidden​

Get Signature​

get hidden(): boolean

If set to true, the annotation will not be displayed or printed, and it will not allow interaction with the user.

Returns​

boolean

Set Signature​

set hidden(hidden): void

Parameters​
hidden​

boolean

Returns​

void

Inherited from​

Annotation.hidden

id​

Get Signature​

get id(): void

Experimental

A unique identifier for the annotation.

Returns​

void

Inherited from​

Annotation.id

interactive​

Get Signature​

get interactive(): boolean

Specifies whether the annotation allows user interaction.

Returns​

boolean

Set Signature​

set interactive(interactive): void

Parameters​
interactive​

boolean

Returns​

void

Inherited from​

Annotation.interactive

isAdded​

Get Signature​

get isAdded(): boolean

Experimental

Indicates whether the annotation was added to a page

Returns​

boolean

Inherited from​

Annotation.isAdded

isMaintainingAspectRatio​

Get Signature​

get abstract isMaintainingAspectRatio(): boolean

Indicates if the annotation is maintaining its aspect ratio

Returns​

boolean

Inherited from​

Annotation.isMaintainingAspectRatio

isMarkupAnnotation​

Get Signature​

get isMarkupAnnotation(): boolean

Pdf.Annotations.Annotation.isMarkupAnnotation

Returns​

boolean

Overrides​

Annotation.isMarkupAnnotation

isModified​

Get Signature​

get isModified(): boolean

Experimental

Indicates if the annotation has changes that have not yet been saved to the document

Returns​

boolean

Inherited from​

Annotation.isModified

isMoveable​

Get Signature​

get abstract isMoveable(): boolean

Indicates if the annotation can be moved by the user

Returns​

boolean

Inherited from​

Annotation.isMoveable

isResizable​

Get Signature​

get abstract isResizable(): boolean

Indicates if the annotation can be resized by the user

Returns​

boolean

Inherited from​

Annotation.isResizable

isRotatable​

Get Signature​

get abstract isRotatable(): boolean

Indicates if the annotation can be rotated by the user

Returns​

boolean

Inherited from​

Annotation.isRotatable

isSelectable​

Get Signature​

get abstract isSelectable(): boolean

Indicates if the annotation can be selected by the user

Returns​

boolean

Inherited from​

Annotation.isSelectable

isWidgetAnnotation​

Get Signature​

get isWidgetAnnotation(): boolean

Pdf.Annotations.Annotation.isWidgetAnnotation

Returns​

boolean

Overrides​

Annotation.isWidgetAnnotation

locked​

Get Signature​

get locked(): AnnotationLockedState

Represents the locked state of the annotation.

Returns​

AnnotationLockedState

Set Signature​

set locked(locked): void

Parameters​
locked​

AnnotationLockedState

Returns​

void

Inherited from​

Annotation.locked

modificationDate​

Get Signature​

get modificationDate(): Date

The date and time when the annotation was last modified.

This property will retrieve the modification date from the annotation and convert it to a JavaScript Date object.

Returns​

Date

The modification date as a JavaScript Date object, or null if no modification date is available in the annotation.

opacity​

Get Signature​

get opacity(): number

Gets the annotation opacity.

Returns​

number

Set Signature​

set opacity(o): void

Sets the annotation opacity.

Parameters​
o​

number

Returns​

void

page​

Get Signature​

get page(): Page

Page in which the annotation is embedded.

Returns​

Page

Set Signature​

set page(page): void

Set the page in which the annotation is embedded.

Parameters​
page​

Page

The page to set as the annotation’s page.

Returns​

void

Inherited from​

Annotation.page

pageNumber​

Get Signature​

get pageNumber(): number

Experimental

Number of the page in which the annotation is embedded.

Returns​

number

Inherited from​

Annotation.pageNumber

privateData​

Get Signature​

get privateData(): object

Experimental

Custom data to be stored with the annotation

Returns​

object

Set Signature​

set privateData(privateData): void

Parameters​
privateData​

object

Returns​

void

Inherited from​

Annotation.privateData

renderProperties​

Get Signature​

get renderProperties(): AnnotationRenderProperties

Object which encapsulates the rendering properties of a PDF annotation, providing a set of flags that control its visibility, interactivity, and other rendering behaviors.

Returns​

AnnotationRenderProperties

Set Signature​

set renderProperties(v): void

Parameters​
v​

AnnotationRenderProperties

Returns​

void

Inherited from​

Annotation.renderProperties

source​

Get Signature​

get source(): void

Experimental

Tag that identifies the source the annotation is coming from, if the source is an input PDF or an input FDF. Newly created annotations always return null.

Returns​

void

Inherited from​

Annotation.source

subject​

Get Signature​

get subject(): string

The subject.

Returns​

string

Set Signature​

set subject(subject): void

Parameters​
subject​

string

Returns​

void

type​

Get Signature​

get abstract type(): AnnotationType

The PDF annotation type

Returns​

AnnotationType

Inherited from​

Annotation.type

Methods​

dispose()​

dispose(): void

Disposes of the object, releasing any resources it holds.

The dispose method is responsible for performing cleanup operations and releasing any resources acquired by the object. Once an object is disposed, it should not be used, and attempts to do so may result in undefined behavior.

Returns​

void

Inherited from​

Annotation.dispose