modern-pdf-lib

---

modern-pdf-lib / PdfCaretAnnotation

Class: PdfCaretAnnotation

Defined in: src/annotation/types/caretAnnotation.ts:47

A caret annotation (subtype /Caret).

Marks an insertion point in the text. Used in review workflows to indicate where new content should be added.

Extends

• PdfAnnotation

Constructors

Constructor

new PdfCaretAnnotation(dict): PdfCaretAnnotation

Defined in: src/annotation/types/caretAnnotation.ts:48

Parameters

dict

PdfDict

Returns

PdfCaretAnnotation

Overrides

PdfAnnotation.constructor

Properties

annotationType

readonly annotationType: AnnotationType

Defined in: src/annotation/pdfAnnotation.ts:227

The annotation subtype.

Inherited from

PdfAnnotation.annotationType

---

dict

protected dict: PdfDict

Defined in: src/annotation/pdfAnnotation.ts:230

The underlying annotation dictionary.

Inherited from

PdfAnnotation.dict

Methods

generateAppearance()

generateAppearance(): PdfStream | undefined

Defined in: src/annotation/pdfAnnotation.ts:440

Generate an appearance stream for this annotation.

The base implementation returns undefined. Subclasses override to produce proper visual appearance.

Returns

PdfStream | undefined

A PdfStream for the /AP /N entry, or undefined.

Inherited from

PdfAnnotation.generateAppearance

---

getAuthor()

getAuthor(): string | undefined

Defined in: src/annotation/pdfAnnotation.ts:293

Get the author (PDF /T entry).

Returns

string | undefined

Inherited from

PdfAnnotation.getAuthor

---

getCaretRect()

getCaretRect(): [number, number, number, number] | undefined

Defined in: src/annotation/types/caretAnnotation.ts:114

Get the inner rectangle differences (RD entry). Returns [left, bottom, right, top] insets from the annotation rect.

Returns

[number, number, number, number] | undefined

---

getColor()

getColor(): { b: number; g: number; r: number; } | undefined

Defined in: src/annotation/pdfAnnotation.ts:311

Get the annotation colour.

Returns

{ b: number; g: number; r: number; } | undefined

Inherited from

PdfAnnotation.getColor

---

getContents()

getContents(): string | undefined

Defined in: src/annotation/pdfAnnotation.ts:275

Get the text contents (tooltip / popup text).

Returns

string | undefined

Inherited from

PdfAnnotation.getContents

---

getOpacity()

getOpacity(): number

Defined in: src/annotation/pdfAnnotation.ts:333

Get the annotation opacity (0-1). Defaults to 1.

Returns

number

Inherited from

PdfAnnotation.getOpacity

---

getRect()

getRect(): [number, number, number, number]

Defined in: src/annotation/pdfAnnotation.ts:251

Get the annotation rectangle [x1, y1, x2, y2].

Returns

[number, number, number, number]

Inherited from

PdfAnnotation.getRect

---

getSymbol()

getSymbol(): CaretSymbol

Defined in: src/annotation/types/caretAnnotation.ts:92

Get the caret symbol. Defaults to 'None'.

Returns

CaretSymbol

---

getType()

getType(): AnnotationType

Defined in: src/annotation/pdfAnnotation.ts:242

Get the annotation subtype.

Returns

AnnotationType

Inherited from

PdfAnnotation.getType

---

isHidden()

isHidden(): boolean

Defined in: src/annotation/pdfAnnotation.ts:381

Whether the annotation is hidden.

Returns

boolean

Inherited from

PdfAnnotation.isHidden

---

isLocked()

isLocked(): boolean

Defined in: src/annotation/pdfAnnotation.ts:401

Whether the annotation is locked (cannot be moved/resized).

Returns

boolean

Inherited from

PdfAnnotation.isLocked

---

isPrintable()

isPrintable(): boolean

Defined in: src/annotation/pdfAnnotation.ts:391

Whether the annotation should be printed.

Returns

boolean

Inherited from

PdfAnnotation.isPrintable

---

setAuthor()

setAuthor(author): void

Defined in: src/annotation/pdfAnnotation.ts:302

Set the author.

Parameters

author

string

Returns

void

Inherited from

PdfAnnotation.setAuthor

---

setCaretRect()

setCaretRect(rd): void

Defined in: src/annotation/types/caretAnnotation.ts:126

Set the inner rectangle differences (RD entry).

Parameters

rd

[number, number, number, number]

Returns

void

---

setColor()

setColor(color): void

Defined in: src/annotation/pdfAnnotation.ts:324

Set the annotation colour.

Parameters

color

b

number

g

number

r

number

Returns

void

Inherited from

PdfAnnotation.setColor

---

setContents()

setContents(contents): void

Defined in: src/annotation/pdfAnnotation.ts:284

Set the text contents.

Parameters

contents

string

Returns

void

Inherited from

PdfAnnotation.setContents

---

setHidden()

setHidden(hidden): void

Defined in: src/annotation/pdfAnnotation.ts:386

Set the hidden flag.

Parameters

hidden

boolean

Returns

void

Inherited from

PdfAnnotation.setHidden

---

setLocked()

setLocked(locked): void

Defined in: src/annotation/pdfAnnotation.ts:406

Set the locked flag.

Parameters

locked

boolean

Returns

void

Inherited from

PdfAnnotation.setLocked

---

setOpacity()

setOpacity(opacity): void

Defined in: src/annotation/pdfAnnotation.ts:342

Set the annotation opacity.

Parameters

opacity

number

Returns

void

Inherited from

PdfAnnotation.setOpacity

---

setPrintable()

setPrintable(printable): void

Defined in: src/annotation/pdfAnnotation.ts:396

Set the print flag.

Parameters

printable

boolean

Returns

void

Inherited from

PdfAnnotation.setPrintable

---

setRect()

setRect(rect): void

Defined in: src/annotation/pdfAnnotation.ts:266

Set the annotation rectangle.

Parameters

rect

[number, number, number, number]

Returns

void

Inherited from

PdfAnnotation.setRect

---

setSymbol()

setSymbol(symbol): void

Defined in: src/annotation/types/caretAnnotation.ts:102

Set the caret symbol.

Parameters

symbol

CaretSymbol

Returns

void

---

toDict()

toDict(registry): PdfDict

Defined in: src/annotation/pdfAnnotation.ts:420

Convert this annotation to a PdfDict suitable for embedding in a PDF.

Parameters

registry

PdfObjectRegistry

The object registry (used to register sub-objects).

Returns

PdfDict

The annotation dictionary.

Inherited from

PdfAnnotation.toDict

---

create()

static create(options): PdfCaretAnnotation

Defined in: src/annotation/types/caretAnnotation.ts:60

Create a new caret annotation.

Parameters

options

AnnotationOptions & object

Returns

PdfCaretAnnotation

---

fromDict()

static fromDict(dict, _resolver?): PdfCaretAnnotation

Defined in: src/annotation/types/caretAnnotation.ts:80

Create a PdfCaretAnnotation from an existing dictionary.

Parameters

dict

PdfDict

_resolver?

(ref) => PdfObject | undefined

Returns

PdfCaretAnnotation