Class CPDFLinkAnnotation

CPDFLinkAnnotation

Hierarchy (View Summary)

CPDFAnnotation
- CPDFLinkAnnotation

Index

Constructors

Methods

fromJson fromJsonArray update toJSON

Properties

type title page content uuid createDate markState reviewState rect action?

Constructors

constructor

new CPDFLinkAnnotation(params: Partial<CPDFLinkAnnotation>): CPDFLinkAnnotation
Parameters
- params: Partial<CPDFLinkAnnotation>
Returns CPDFLinkAnnotation
Overrides CPDFAnnotation.constructor

Methods

`Static`fromJson

fromJson<T extends CPDFAnnotation>(
this: new (params: Partial<T>) => T,
json: any,
): T
Type Parameters
- T extends CPDFAnnotation
Parameters
- this: new (params: Partial<T>) => T
- json: any
Returns T
Inherited from CPDFAnnotation.fromJson

`Static`fromJsonArray

fromJsonArray<T extends CPDFAnnotation>(
this: new (params: Partial<T>) => T,
jsonArray: any[],
): T[]
Type Parameters
- T extends CPDFAnnotation
Parameters
- this: new (params: Partial<T>) => T
- jsonArray: any[]
Returns T[]
Inherited from CPDFAnnotation.fromJsonArray

update

update(
    updates: Partial<
        Pick<CPDFLinkAnnotation, "title" | "content" | "action">,
    >,
): this
Update link annotation properties with type safety
Parameters
- updates: Partial<Pick<CPDFLinkAnnotation, "title" | "content" | "action">>
  Partial object containing properties to update
Returns this
this instance for chaining
Example
```
linkAnnotation.update({
  title: 'Updated Title',
  content: 'Updated content',
  action: CPDFGoToAction.toPage(2)
});
await document.updateAnnotation(linkAnnotation);
```
Overrides CPDFAnnotation.update

toJSON

toJSON(): Omit<CPDFLinkAnnotation, "createDate" | "update" | "toJSON"> & {
    createDate?: number;
    action: { actionType: CPDFActionType } | undefined;
}
Returns Omit<CPDFLinkAnnotation, "createDate" | "update" | "toJSON"> & {
    createDate?: number;
    action: { actionType: CPDFActionType } | undefined;
}
Overrides CPDFAnnotation.toJSON

Properties

type

type: CPDFAnnotationType

Annotation type identifier

title

title: string

Annotation title

`Readonly`page

page: number

The page number where the note is located

content

content: string

annotation content.

`Readonly`uuid

uuid: string

annotation uuid.

createDate

createDate: Date | null = null

annotation create date.

markState

markState: CPDFAnnotationMarkState = CPDFAnnotationMarkState.UNMARKED

annotation mark state.

reviewState

reviewState: CPDFAnnotationReviewState = CPDFAnnotationReviewState.NONE

annotation review state.

rect

rect: CPDFRectF | null = null

annotation rect.

`Optional`action

action?: CPDFAction

The action associated with the link annotation.