Class: LinkAnnotation

Experimental

A link annotation

Extends

• Annotation

Constructors

new LinkAnnotation()

new LinkAnnotation(options): LinkAnnotation

Experimental

Parameters

• options: LinkAnnotationOptions

Options used to initialize annotation.

Returns

LinkAnnotation

Overrides

Annotation.constructor

Properties

action

action: Action

Experimental

The action that is performed when the link annotation is clicked on

Accessors

__annotation

get __annotation(): Annotation

Experimental

set __annotation(v): void

Experimental

Parameters

• v: Annotation

Returns

Annotation

Inherited from

Annotation.__annotation

---

boundingBox

get boundingBox(): Rectangle<PdfPoint>

Experimental

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.

set boundingBox(rectangle): void

Experimental

Parameters

• rectangle: Rectangle<PdfPoint>

Returns

Rectangle<PdfPoint>

Inherited from

Annotation.boundingBox

---

content

get content(): string

Experimental

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.

set content(content): void

Experimental

Parameters

• content: string

Returns

string

Inherited from

Annotation.content

---

dateModified

get dateModified(): Date

Experimental

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

set dateModified(date): void

Experimental

Parameters

• date: Date

Returns

Date

Inherited from

Annotation.dateModified

---

hasChanges

get hasChanges(): boolean

Experimental

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

Returns

boolean

Inherited from

Annotation.hasChanges

---

hidden

get hidden(): boolean

Experimental

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

set hidden(hidden): void

Experimental

Parameters

• hidden: boolean

Returns

boolean

Inherited from

Annotation.hidden

---

id

get id(): void

Experimental

A unique identifier for the annotation.

Returns

void

Inherited from

Annotation.id

---

interactive

get interactive(): boolean

Experimental

Specifies whether the annotation allows user interaction.

set interactive(interactive): void

Experimental

Parameters

• interactive: boolean

Returns

boolean

Inherited from

Annotation.interactive

---

isAdded

get isAdded(): boolean

Experimental

Indicates whether the annotation was added to a page

Returns

boolean

Inherited from

Annotation.isAdded

---

isMaintainingAspectRatio

get isMaintainingAspectRatio(): boolean

Experimental

Indicates if the annotation is maintaining its aspect ratio

Returns

boolean

Overrides

Annotation.isMaintainingAspectRatio

---

isMarkupAnnotation

get isMarkupAnnotation(): boolean

Experimental

Indicates if the annotation is a markup annotation

Returns

boolean

Overrides

Annotation.isMarkupAnnotation

---

isModified

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 isMoveable(): boolean

Experimental

Indicates if the annotation can be moved by the user

Returns

boolean

Overrides

Annotation.isMoveable

---

isResizable

get isResizable(): boolean

Experimental

Indicates if the annotation can be resized by the user

Returns

boolean

Overrides

Annotation.isResizable

---

isRotatable

get isRotatable(): boolean

Experimental

Indicates if the annotation can be rotated by the user

Returns

boolean

Overrides

Annotation.isRotatable

---

isSelectable

get isSelectable(): boolean

Experimental

Indicates if the annotation can be selected by the user

Returns

boolean

Overrides

Annotation.isSelectable

---

isWidgetAnnotation

get isWidgetAnnotation(): boolean

Experimental

Indicates if the annotation is a widget annotation

Returns

boolean

Overrides

Annotation.isWidgetAnnotation

---

locked

get locked(): AnnotationLockedState

Experimental

Represents the locked state of the annotation.

set locked(locked): void

Experimental

Parameters

• locked: AnnotationLockedState

Returns

AnnotationLockedState

Inherited from

Annotation.locked

---

page

get page(): Page

Experimental

Page in which the annotation is embedded.

set page(page): void

Experimental

Set the page in which the annotation is embedded.

Parameters

• page: Page

The page to set as the annotation's page.

Returns

Page

Inherited from

Annotation.page

---

pageNumber

get pageNumber(): number

Experimental

Number of the page in which the annotation is embedded.

Returns

number

Inherited from

Annotation.pageNumber

---

privateData

get privateData(): object

Experimental

Custom data to be stored with the annotation

set privateData(privateData): void

Experimental

Parameters

• privateData: object

Returns

object

Inherited from

Annotation.privateData

---

renderProperties

get renderProperties(): AnnotationRenderProperties

Experimental

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

set renderProperties(v): void

Experimental

Parameters

• v: AnnotationRenderProperties

Returns

AnnotationRenderProperties

Inherited from

Annotation.renderProperties

---

source

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

---

type

get type(): AnnotationType

Experimental

The PDF annotation type

Default Value

AnnotationType.Link

Returns

AnnotationType

Overrides

Annotation.type