PDFiumPage

@scaryterry/pdfium

---

Defined in: src/document/page.ts:205

Represents a single page in a PDF document.

Pages are loaded lazily and must be disposed when no longer needed. Use the using keyword for automatic disposal.

Example

using page = document.getPage(0);
const size = page.size;
console.log(`Page size: ${size.width}x${size.height}`);

Extends

• Disposable

Implements

• IPageReader

Accessors

annotationCount

Get Signature

get annotationCount(): number

Defined in: src/document/page.ts:1110

Get the number of annotations on this page.

Returns

number

---

artBox

Get Signature

get artBox(): PageBox | undefined

Defined in: src/document/page.ts:478

Get the art box (content boundaries).

This is a convenience method equivalent to getPageBox(PageBoxType.ArtBox).

Returns

PageBox | undefined

The art box or undefined if not explicitly set

---

bleedBox

Get Signature

get bleedBox(): PageBox | undefined

Defined in: src/document/page.ts:456

Get the bleed box (printing bleed area).

This is a convenience method equivalent to getPageBox(PageBoxType.BleedBox).

Returns

PageBox | undefined

The bleed box or undefined if not explicitly set

---

boundingBox

Get Signature

get boundingBox(): PageBox

Defined in: src/document/page.ts:490

Get the effective bounding box of the page.

This returns the bounding box that encompasses all page content, considering all page transformations.

Returns

PageBox

The page bounding box

---

charCount

Get Signature

get charCount(): number

Defined in: src/document/page.ts:2223

Get the total number of characters on this page.

This includes all text characters that can be extracted.

Returns

number

---

cropBox

Get Signature

get cropBox(): PageBox | undefined

Defined in: src/document/page.ts:445

Get the crop box (visible region).

This is a convenience method equivalent to getPageBox(PageBoxType.CropBox).

Returns

PageBox | undefined

The crop box or undefined if not explicitly set

---

disposed

Get Signature

get disposed(): boolean

Defined in: src/core/disposable.ts:74

Whether this resource has been disposed.

Returns

boolean

Inherited from

Disposable.disposed

---

height

Get Signature

get height(): number

Defined in: src/document/page.ts:319

Get the height of the page in points.

Returns

number

Implementation of

IPageReader.height

---

index

Get Signature

get index(): number

Defined in: src/document/page.ts:296

The zero-based index of this page.

Returns

number

The zero-based index of this page.

Implementation of

IPageReader.index

---

mediaBox

Get Signature

get mediaBox(): PageBox | undefined

Defined in: src/document/page.ts:434

Get the media box (physical page boundaries).

This is a convenience method equivalent to getPageBox(PageBoxType.MediaBox).

Returns

PageBox | undefined

The media box or undefined if not set

---

objectCount

Get Signature

get objectCount(): number

Defined in: src/document/page.ts:1062

Get the number of objects on this page.

Returns

number

---

rotation

Get Signature

get rotation(): PageRotation

Defined in: src/document/page.ts:327

Get the page rotation as stored in the PDF.

Returns

PageRotation

Set Signature

set rotation(rotation): void

Defined in: src/document/page.ts:338

Set the page rotation.

Parameters

Parameter	Type	Description
rotation	PageRotation	The rotation value to set

Returns

void

Page rotation.

Implementation of

IPageReader.rotation

---

size

Get Signature

get size(): PageSize

Defined in: src/document/page.ts:303

Get the page dimensions in points (1/72 inch).

Returns

PageSize

Page dimensions.

Implementation of

IPageReader.size

---

trimBox

Get Signature

get trimBox(): PageBox | undefined

Defined in: src/document/page.ts:467

Get the trim box (final trimmed dimensions).

This is a convenience method equivalent to getPageBox(PageBoxType.TrimBox).

Returns

PageBox | undefined

The trim box or undefined if not explicitly set

---

webLinkCount

Get Signature

get webLinkCount(): number

Defined in: src/document/page.ts:2900

Count the number of web links detected in the page text.

Web links are URLs automatically detected in the page text content, not interactive link annotations.

Returns

number

---

width

Get Signature

get width(): number

Defined in: src/document/page.ts:311

Get the width of the page in points.

Returns

number

Implementation of

IPageReader.width

Methods

[dispose]()

[dispose](): void

Defined in: src/core/disposable.ts:163

Dispose of this resource, freeing WASM memory.

This method is idempotent - calling it multiple times has no effect after the first call.

Returns

void

Implementation of

IPageReader.[dispose]

Inherited from

Disposable.[dispose]

---

annotations()

annotations(): IterableIterator<PDFiumAnnotation>

Defined in: src/document/page.ts:1201

Iterate annotations on this page lazily.

Each yielded annotation holds an open native handle — use using or call dispose() when done. Annotations are opened one at a time, making this more memory-efficient than getAnnotations() for large annotation sets.

Returns

IterableIterator<PDFiumAnnotation>

---

applyRedactions()

applyRedactions(options): ApplyRedactionsResult

Defined in: src/document/page.ts:1805

Apply all pending redactions by removing overlapping page content.

This performs destructive content redaction:

• removes page objects overlapping redaction regions
• optionally removes intersecting annotations
• inserts opaque fill rectangles into page content for visual redaction marks

After applying, the page content stream is regenerated.

Parameters

Parameter	Type
options	ApplyRedactionsOptions

Returns

ApplyRedactionsResult

---

canFormRedo()

canFormRedo(): boolean

Defined in: src/document/page.ts:1307

Check if redo is available for form field editing on this page.

Returns

boolean

---

canFormUndo()

canFormUndo(): boolean

Defined in: src/document/page.ts:1296

Check if undo is available for form field editing on this page.

Returns

boolean

---

createAnnotation()

createAnnotation(type): PDFiumAnnotation | null

Defined in: src/document/page.ts:1760

Create a new annotation on this page.

Parameters

Parameter	Type	Description
type	AnnotationType	The annotation type to create

Returns

PDFiumAnnotation | null

The new annotation, or null if creation failed

---

createImageObject()

createImageObject(): PDFiumImageObject | null

Defined in: src/document/page.ts:1699

Create a new image page object.

The returned object must be inserted into a page or annotation, or destroyed via obj.destroy().

Returns

PDFiumImageObject | null

A new image page object, or null if failed

---

deviceToPage()

deviceToPage(context, deviceX, deviceY): PageCoordinate

Defined in: src/document/page.ts:3189

Convert device coordinates (pixels) to page coordinates (points).

This is useful for translating mouse click positions into page space for operations like text selection or hit testing.

Parameters

Parameter	Type	Description
context	CoordinateTransformContext	The coordinate transform context defining the viewport
deviceX	number	X coordinate in device space (pixels)
deviceY	number	Y coordinate in device space (pixels)

Returns

PageCoordinate

The corresponding point in page coordinate space

Example

const context = {
  startX: 0,
  startY: 0,
  sizeX: 800,
  sizeY: 600,
  rotate: PageRotation.None,
};
const pageCoord = page.deviceToPage(context, mouseX, mouseY);

Throws

If the device coordinates are not finite numbers

---

dispose()

dispose(): void

Defined in: src/core/disposable.ts:179

Alias for Symbol.dispose for explicit calls.

Returns

void

Example

document.dispose();

Inherited from

Disposable.dispose

---

executePageAction()

executePageAction(actionType): void

Defined in: src/document/page.ts:3291

Executes a page action for forms.

Triggers JavaScript actions associated with page events (open/close). This is used to run any scripts that are attached to page lifecycle events in interactive PDF forms.

Parameters

Parameter	Type	Description
actionType	PageActionType	The type of page action to execute

Returns

void

Example

// Trigger page open action
page.executePageAction(PageActionType.Open);

// Before closing, trigger close action
page.executePageAction(PageActionType.Close);

---

findText()

findText(query, flags): IterableIterator<TextSearchResult>

Defined in: src/document/page.ts:2009

Search for text on this page.

Returns a generator yielding search results with position information. The search handle is cleaned up when the generator finishes or is closed.

Parameters

Parameter	Type	Default value	Description
query	string	undefined	The text to search for
flags	TextSearchFlags	TextSearchFlags.None	Search flags (case sensitivity, whole word, etc.)

Returns

IterableIterator<TextSearchResult>

Throws

If the text page fails to load

Implementation of

IPageReader.findText

---

flatten()

flatten(flags): FlattenResult

Defined in: src/document/page.ts:1599

Flatten annotations and form fields into page content.

After flattening, annotations and form fields become part of the page content and can no longer be edited separately.

Parameters

Parameter	Type	Default value	Description
flags	FlattenFlags	FlattenFlags.NormalDisplay	Flatten flags (0 for normal display, 1 for print)

Returns

FlattenResult

The flatten result

---

formChar()

formChar(charCode, modifier): boolean

Defined in: src/document/page.ts:1492

Notify form fill environment of a character input event.

Parameters

Parameter	Type	Description
charCode	number	Character code
modifier	FormModifierFlags	Keyboard modifier flags

Returns

boolean

True if the event was handled

---

formDoubleClick()

formDoubleClick(modifier, x, y): boolean

Defined in: src/document/page.ts:1447

Notify form fill environment of a double-click event.

Parameters

Parameter	Type	Description
modifier	FormModifierFlags	Keyboard modifier flags
x	number	X coordinate in page space
y	number	Y coordinate in page space

Returns

boolean

True if the event was handled

---

formFocus()

formFocus(modifier, x, y): boolean

Defined in: src/document/page.ts:1395

Notify form fill environment of focus at a point.

Parameters

Parameter	Type	Description
modifier	FormModifierFlags	Keyboard modifier flags
x	number	X coordinate in page space
y	number	Y coordinate in page space

Returns

boolean

True if the event was handled

---

formKeyDown()

formKeyDown(keyCode, modifier): boolean

Defined in: src/document/page.ts:1462

Notify form fill environment of a key down event.

Parameters

Parameter	Type	Description
keyCode	number	Virtual key code
modifier	FormModifierFlags	Keyboard modifier flags

Returns

boolean

True if the event was handled

---

formKeyUp()

formKeyUp(keyCode, modifier): boolean

Defined in: src/document/page.ts:1477

Notify form fill environment of a key up event.

Parameters

Parameter	Type	Description
keyCode	number	Virtual key code
modifier	FormModifierFlags	Keyboard modifier flags

Returns

boolean

True if the event was handled

---

formMouseDown()

formMouseDown(button, modifier, x, y): boolean

Defined in: src/document/page.ts:1412

Notify form fill environment of a mouse button down event.

Parameters

Parameter	Type	Description
button	FormMouseButton	Which mouse button (‘left’ or ‘right’)
modifier	FormModifierFlags	Keyboard modifier flags
x	number	X coordinate in page space
y	number	Y coordinate in page space

Returns

boolean

True if the event was handled

---

formMouseMove()

formMouseMove(modifier, x, y): boolean

Defined in: src/document/page.ts:1353

Notify form fill environment of mouse movement.

Parameters

Parameter	Type	Description
modifier	FormModifierFlags	Keyboard modifier flags (shift, ctrl, alt)
x	number	X coordinate in page space
y	number	Y coordinate in page space

Returns

boolean

True if the event was handled

---

formMouseUp()

formMouseUp(button, modifier, x, y): boolean

Defined in: src/document/page.ts:1430

Notify form fill environment of a mouse button up event.

Parameters

Parameter	Type	Description
button	FormMouseButton	Which mouse button (‘left’ or ‘right’)
modifier	FormModifierFlags	Keyboard modifier flags
x	number	X coordinate in page space
y	number	Y coordinate in page space

Returns

boolean

True if the event was handled

---

formMouseWheel()

formMouseWheel(modifier, x, y, deltaX, deltaY): boolean

Defined in: src/document/page.ts:1371

Notify form fill environment of mouse wheel scroll.

Parameters

Parameter	Type	Description
modifier	FormModifierFlags	Keyboard modifier flags
x	number	X coordinate in page space
y	number	Y coordinate in page space
deltaX	number	Horizontal scroll delta
deltaY	number	Vertical scroll delta

Returns

boolean

True if the event was handled

---

formRedo()

formRedo(): boolean

Defined in: src/document/page.ts:1333

Redo the last undone form field editing operation on this page.

Returns

boolean

True if redo was successful

---

formSelectAllText()

formSelectAllText(): boolean

Defined in: src/document/page.ts:1549

Select all text in the currently focused form field.

Returns

boolean

True if successful

---

formUndo()

formUndo(): boolean

Defined in: src/document/page.ts:1320

Undo the last form field editing operation on this page.

Returns

boolean

True if undo was successful

---

generateContent()

generateContent(): boolean

Defined in: src/document/page.ts:1638

Generate the page content stream.

Call this after modifying page objects to persist changes.

Returns

boolean

True if successful

---

getAnnotation()

getAnnotation(index): PDFiumAnnotation

Defined in: src/document/page.ts:1125

Get an annotation by index.

The returned annotation holds an open native handle and a borrow on this page’s resources. Dispose the annotation when done.

Parameters

Parameter	Type	Description
index	number	Zero-based annotation index

Returns

PDFiumAnnotation

The annotation wrapper

Throws

If the index is out of range or the annotation cannot be loaded

---

getAnnotations()

getAnnotations(): PDFiumAnnotation[]

Defined in: src/document/page.ts:1177

Get all annotations on this page.

Important: Each annotation holds an open native handle that retains the page’s native resources. You must dispose every annotation when done, otherwise native memory will not be freed.

For memory-efficient iteration, prefer the annotations() generator which yields one annotation at a time with using support.

Returns

PDFiumAnnotation[]

Example

// Array pattern — caller must dispose each annotation
const annots = page.getAnnotations();
try {
  for (const annot of annots) { console.log(annot.type); }
} finally {
  for (const annot of annots) { annot.dispose(); }
}

// Generator pattern (preferred) — automatic disposal
for (using annot of page.annotations()) {
  console.log(annot.type);
}

Implementation of

IPageReader.getAnnotations

---

getCharacterInfo()

getCharacterInfo(charIndex): CharacterInfo | undefined

Defined in: src/document/page.ts:2462

Get extended information about a character at the specified index.

This combines multiple character properties into a single object for convenience when you need comprehensive character information.

Parameters

Parameter	Type	Description
charIndex	number	Zero-based character index

Returns

CharacterInfo | undefined

Character info or undefined if invalid index

---

getCharAngle()

getCharAngle(charIndex): number

Defined in: src/document/page.ts:2325

Get the rotation angle of a character at the specified index.

Parameters

Parameter	Type	Description
charIndex	number	Zero-based character index

Returns

number

Rotation angle in radians

---

getCharBox()

getCharBox(charIndex): CharBox | undefined

Defined in: src/document/page.ts:2031

Get the bounding box of a character by its index.

Parameters

Parameter	Type	Description
charIndex	number	Zero-based character index

Returns

CharBox | undefined

The character bounding box, or undefined if the index is invalid

Throws

If the text page fails to load

---

getCharFillColour()

getCharFillColour(charIndex): Colour | undefined

Defined in: src/document/page.ts:2423

Get the fill colour of a character at the specified index.

Parameters

Parameter	Type	Description
charIndex	number	Zero-based character index

Returns

Colour | undefined

Fill colour or undefined if unavailable

---

getCharFontName()

getCharFontName(charIndex): string | undefined

Defined in: src/document/page.ts:2289

Get the font name of a character at the specified index.

Parameters

Parameter	Type	Description
charIndex	number	Zero-based character index

Returns

string | undefined

Font name, or undefined if unavailable

---

getCharFontSize()

getCharFontSize(charIndex): number

Defined in: src/document/page.ts:2253

Get the font size of a character at the specified index.

Parameters

Parameter	Type	Description
charIndex	number	Zero-based character index

Returns

number

Font size in points, or 0 if invalid

---

getCharFontWeight()

getCharFontWeight(charIndex): number

Defined in: src/document/page.ts:2271

Get the font weight of a character at the specified index.

Parameters

Parameter	Type	Description
charIndex	number	Zero-based character index

Returns

number

Font weight (100-900), or -1 if invalid/unavailable

---

getCharIndexAtPos()

getCharIndexAtPos(x, y, xTolerance, yTolerance): number

Defined in: src/document/page.ts:2077

Get the character index at a given position in page coordinates.

Parameters

Parameter	Type	Default value	Description
x	number	undefined	X position in page coordinates
y	number	undefined	Y position in page coordinates
xTolerance	number	DEFAULT_CHAR_POSITION_TOLERANCE	Horizontal tolerance in points (default: 10)
yTolerance	number	DEFAULT_CHAR_POSITION_TOLERANCE	Vertical tolerance in points (default: 10)

Returns

number

The zero-based character index, or -1 if no character is at the position, or -3 if the position is outside the page

---

getCharLooseBox()

getCharLooseBox(charIndex): CharBox | undefined

Defined in: src/document/page.ts:2049

Get the loose bounding box of a character by its index.

Parameters

Parameter	Type	Description
charIndex	number	Zero-based character index

Returns

CharBox | undefined

The character loose bounding box, or undefined if the index is invalid

---

getCharOrigin()

getCharOrigin(charIndex): { x: number; y: number; } | undefined

Defined in: src/document/page.ts:2345

Get the origin point of a character at the specified index.

The origin is typically at the baseline of the character.

Parameters

Parameter	Type	Description
charIndex	number	Zero-based character index

Returns

{ x: number; y: number; } | undefined

Origin point {x, y} or undefined if invalid

---

getCharRenderMode()

getCharRenderMode(charIndex): TextRenderMode

Defined in: src/document/page.ts:2307

Get the text render mode of a character at the specified index.

Parameters

Parameter	Type	Description
charIndex	number	Zero-based character index

Returns

TextRenderMode

Text render mode

---

getCharStrokeColour()

getCharStrokeColour(charIndex): Colour | undefined

Defined in: src/document/page.ts:2441

Get the stroke colour of a character at the specified index.

Parameters

Parameter	Type	Description
charIndex	number	Zero-based character index

Returns

Colour | undefined

Stroke colour or undefined if unavailable

---

getCharUnicode()

getCharUnicode(charIndex): number

Defined in: src/document/page.ts:2235

Get the Unicode code point of a character at the specified index.

Parameters

Parameter	Type	Description
charIndex	number	Zero-based character index

Returns

number

Unicode code point, or 0 if invalid

---

getDecodedThumbnailData()

getDecodedThumbnailData(): Uint8Array<ArrayBufferLike> | undefined

Defined in: src/document/page.ts:612

Get the decoded thumbnail image data.

This returns the raw pixel data of the embedded thumbnail image, decoded from whatever format it was stored in (typically JPEG).

Returns

Uint8Array<ArrayBufferLike> | undefined

The decoded thumbnail pixel data, or undefined if not available

---

getFocusableSubtypes()

getFocusableSubtypes(): AnnotationType[]

Defined in: src/document/page.ts:1941

Get the focusable annotation subtypes.

Returns

AnnotationType[]

Array of focusable annotation types

---

getFocusableSubtypesCount()

getFocusableSubtypesCount(): number

Defined in: src/document/page.ts:1926

Get the count of focusable annotation subtypes.

Returns

number

The number of focusable subtypes

---

getFormFieldTypeAtPoint()

getFormFieldTypeAtPoint(x, y): FormFieldType | null

Defined in: src/document/page.ts:1222

Get the form field type at the specified point.

Parameters

Parameter	Type	Description
x	number	X coordinate in page coordinates
y	number	Y coordinate in page coordinates

Returns

FormFieldType | null

The form field type at the point, or null if none

---

getFormFieldZOrderAtPoint()

getFormFieldZOrderAtPoint(x, y): number

Defined in: src/document/page.ts:1241

Get the Z-order of a form field at the specified point.

Parameters

Parameter	Type	Description
x	number	X coordinate in page coordinates
y	number	Y coordinate in page coordinates

Returns

number

The Z-order of the form field at the point, or -1 if none

---

getFormFocusedText()

getFormFocusedText(): string | undefined

Defined in: src/document/page.ts:1505

Get the text in the currently focused form field.

Returns

string | undefined

The focused text, or undefined if no focused field

---

getFormSelectedText()

getFormSelectedText(): string | undefined

Defined in: src/document/page.ts:1254

Get the currently selected text in a form field on this page.

Returns

string | undefined

The selected text, or undefined if no selection

---

getLinkAtPoint()

getLinkAtPoint(x, y): PDFLink | null

Defined in: src/document/page.ts:2819

Get the link at a specific point on the page.

Parameters

Parameter	Type	Description
x	number	X coordinate in page units
y	number	Y coordinate in page units

Returns

PDFLink | null

The link at the point, or null if none

---

getLinks()

getLinks(): PDFLink[]

Defined in: src/document/page.ts:2890

Enumerate all links on the page.

For pages with many links, prefer using the links() generator.

Returns

PDFLink[]

Array of links found on the page

---

getLinkZOrderAtPoint()

getLinkZOrderAtPoint(x, y): number

Defined in: src/document/page.ts:2839

Get the z-order of the link at a specific point.

Returns the z-order index (0-based, where 0 is bottom) of the link at the specified point, or -1 if no link is found.

Parameters

Parameter	Type	Description
x	number	X coordinate in page units
y	number	Y coordinate in page units

Returns

number

---

getObjects()

getObjects(): PDFiumPageObject[]

Defined in: src/document/page.ts:1103

Get all page objects (text, images, paths, etc.).

For large pages, prefer using the objects() generator.

Returns

PDFiumPageObject[]

An array of page objects with type and bounding box information

Implementation of

IPageReader.getObjects

---

getPageBox()

getPageBox(boxType): PageBox | undefined

Defined in: src/document/page.ts:356

Get a specific page box.

PDF pages can have multiple box definitions:

• MediaBox: Physical page boundaries (required)
• CropBox: Visible region (defaults to MediaBox)
• BleedBox: Bleed area for printing (defaults to CropBox)
• TrimBox: Final trimmed page dimensions (defaults to CropBox)
• ArtBox: Meaningful content boundaries (defaults to CropBox)

Parameters

Parameter	Type	Description
boxType	PageBoxType	The type of box to retrieve

Returns

PageBox | undefined

The page box or undefined if not explicitly set

Implementation of

IPageReader.getPageBox

---

getRawThumbnailData()

getRawThumbnailData(): Uint8Array<ArrayBufferLike> | undefined

Defined in: src/document/page.ts:627

Get the raw thumbnail image data.

This returns the thumbnail data in its original encoded format (e.g., JPEG, PNG). The format can be determined from the data header.

Returns

Uint8Array<ArrayBufferLike> | undefined

The raw thumbnail data, or undefined if not available

---

getStructureTree()

getStructureTree(): StructureElement[] | undefined

Defined in: src/document/page.ts:2526

Get the structure tree for this page (tagged PDF accessibility info).

Returns an array of root structure elements, or undefined if the page has no structure tree (i.e. the PDF is not tagged).

For large structure trees, prefer the lazy structureElements generator.

Returns

StructureElement[] | undefined

---

getText()

getText(): string

Defined in: src/document/page.ts:1039

Extract text content from the page.

Returns the full text of the page as a single string. The text preserves the logical reading order determined by PDFium, including whitespace and line breaks embedded in the PDF content stream. No trimming is applied.

Returns

string

The extracted text

Throws

If text extraction fails

See

getTextInRect for extracting text within a bounding rectangle

Implementation of

IPageReader.getText

---

getTextInRect()

getTextInRect(left, top, right, bottom): string

Defined in: src/document/page.ts:2100

Get the text within a rectangular region of the page.

Parameters

Parameter	Type	Description
left	number	Left edge of the rectangle in page coordinates
top	number	Top edge of the rectangle in page coordinates
right	number	Right edge of the rectangle in page coordinates
bottom	number	Bottom edge of the rectangle in page coordinates

Returns

string

The text within the rectangle (no trimming is applied)

See

getText for extracting all text on the page

---

getTextLayout()

getTextLayout(): object

Defined in: src/document/page.ts:2150

Get efficient text layout data (characters and bounding boxes).

Optimised for bulk extraction. Returns a single string of text and a flat Float32Array of bounding boxes — 4 values per character in the order [left, right, bottom, top], so rects.length === text.length * 4. Access character i bounds via rects[i*4] (left), rects[i*4+1] (right), rects[i*4+2] (bottom), rects[i*4+3] (top).

Returns

object

Object containing { text, rects }

Name	Type	Defined in
rects	Float32Array	src/document/page.ts:2150
text	string	src/document/page.ts:2150

---

getThumbnailAsBitmap()

getThumbnailAsBitmap(): RenderResult | undefined

Defined in: src/document/page.ts:556

Get the embedded thumbnail image as a rendered result.

Returns the thumbnail as RGBA pixel data in a RenderResult, matching the format returned by render.

Returns

RenderResult | undefined

The thumbnail as a render result, or undefined if not available

---

getWebLinks()

getWebLinks(): WebLink[]

Defined in: src/document/page.ts:2921

Get automatically detected web links from the page text.

These are URLs found in the text content, not interactive link annotations.

Returns

WebLink[]

Array of detected web links with their URLs and positions

---

hasCharUnicodeMapError()

hasCharUnicodeMapError(charIndex): boolean

Defined in: src/document/page.ts:2405

Check if a character at the specified index has a Unicode mapping error.

This indicates the character could not be properly mapped to Unicode during text extraction.

Parameters

Parameter	Type	Description
charIndex	number	Zero-based character index

Returns

boolean

---

hasThumbnail()

hasThumbnail(): boolean

Defined in: src/document/page.ts:540

Check if the page has an embedded thumbnail image.

Returns

boolean

True if a thumbnail exists, false otherwise

---

hasTransparency()

hasTransparency(): boolean

Defined in: src/document/page.ts:1613

Check if this page contains transparency.

Returns

boolean

True if the page contains transparency

---

isAnnotationObjectSubtypeSupported()

isAnnotationObjectSubtypeSupported(subtype): boolean

Defined in: src/document/page.ts:1916

Check if an annotation subtype supports adding/updating/removing objects.

Currently supported subtypes are ink and stamp.

Parameters

Parameter	Type	Description
subtype	AnnotationType	The annotation subtype to check

Returns

boolean

True if the subtype supports object operations

---

isAnnotationSubtypeSupported()

isAnnotationSubtypeSupported(subtype): boolean

Defined in: src/document/page.ts:1903

Check if an annotation subtype is supported for object extraction.

Parameters

Parameter	Type	Description
subtype	AnnotationType	The annotation subtype to check

Returns

boolean

True if the subtype supports object operations

---

isCharGenerated()

isCharGenerated(charIndex): boolean

Defined in: src/document/page.ts:2365

Check if a character at the specified index was generated.

Generated characters are not from the original PDF content stream, but were synthesised during text extraction.

Parameters

Parameter	Type	Description
charIndex	number	Zero-based character index

Returns

boolean

---

isCharHyphen()

isCharHyphen(charIndex): boolean

Defined in: src/document/page.ts:2385

Check if a character at the specified index is a hyphen.

This can be used to detect soft hyphens that may indicate word breaks across lines.

Parameters

Parameter	Type	Description
charIndex	number	Zero-based character index

Returns

boolean

---

isFormIndexSelected()

isFormIndexSelected(index): boolean

Defined in: src/document/page.ts:1578

Check if an index is selected in a listbox or combobox.

Parameters

Parameter	Type	Description
index	number	The option index to check

Returns

boolean

True if the index is selected

---

links()

links(): IterableIterator<PDFLink>

Defined in: src/document/page.ts:2856

Iterate over links lazily.

Use this for memory-efficient iteration over many links.

Returns

IterableIterator<PDFLink>

Example

for (const link of page.links()) {
  console.log(link.actionType);
}

---

objects()

objects(): IterableIterator<PDFiumPageObject>

Defined in: src/document/page.ts:1079

Iterate over page objects lazily.

Use this for memory-efficient iteration over many page objects.

Returns

IterableIterator<PDFiumPageObject>

Example

for (const obj of page.objects()) {
  console.log(obj.type);
}

Implementation of

IPageReader.objects

---

pageToDevice()

pageToDevice(context, pageX, pageY): DeviceCoordinate

Defined in: src/document/page.ts:3242

Convert page coordinates (points) to device coordinates (pixels).

This is useful for positioning UI elements over specific page content or for drawing annotations at precise locations.

Parameters

Parameter	Type	Description
context	CoordinateTransformContext	The coordinate transform context defining the viewport
pageX	number	X coordinate in page space (points)
pageY	number	Y coordinate in page space (points)

Returns

DeviceCoordinate

The corresponding point in device coordinate space

Example

const context = {
  startX: 0,
  startY: 0,
  sizeX: 800,
  sizeY: 600,
  rotate: PageRotation.None,
};
const deviceCoord = page.pageToDevice(context, textBounds.left, textBounds.top);

Throws

If the page coordinates are not finite numbers

---

removeAnnotation()

removeAnnotation(index): boolean

Defined in: src/document/page.ts:1749

Remove an annotation from this page.

Parameters

Parameter	Type	Description
index	number	Zero-based annotation index

Returns

boolean

True if successful

---

removeObject()

removeObject(obj): boolean

Defined in: src/document/page.ts:1626

Remove a page object from this page.

After removal, call generateContent() to update the page content stream.

Parameters

Parameter	Type	Description
obj	PDFiumPageObject	The page object to remove

Returns

boolean

True if successful

---

render()

render(options): RenderResult

Defined in: src/document/page.ts:641

Render the page to a bitmap.

Parameters

Parameter	Type	Description
options	RenderOptions	Rendering options

Returns

RenderResult

The rendered bitmap data

Throws

If rendering fails

Implementation of

IPageReader.render

---

replaceFormSelection()

replaceFormSelection(text): void

Defined in: src/document/page.ts:1282

Replace the currently selected text in a form field.

Parameters

Parameter	Type	Description
text	string	The text to replace the selection with

Returns

void

---

replaceFormSelectionAndKeep()

replaceFormSelectionAndKeep(text): void

Defined in: src/document/page.ts:1533

Replace the selected text in a form field and keep the selection.

Parameters

Parameter	Type	Description
text	string	The text to replace the selection with

Returns

void

---

setClipPath()

setClipPath(box): boolean

Defined in: src/document/page.ts:1680

Create, insert, and destroy a clip path in a single operation.

Parameters

Parameter	Type	Description
box	PageBox	The clip path rectangle in page coordinates

Returns

boolean

True if the clip path was created and inserted successfully

---

setFocusableSubtypes()

setFocusableSubtypes(subtypes): boolean

Defined in: src/document/page.ts:1978

Set the focusable annotation subtypes.

Parameters

Parameter	Type	Description
subtypes	AnnotationType[]	Array of annotation types that should be focusable

Returns

boolean

True if successful

---

setFormIndexSelected()

setFormIndexSelected(index, selected): boolean

Defined in: src/document/page.ts:1564

Set the selection state of an index in a listbox or combobox.

Parameters

Parameter	Type	Description
index	number	The option index to select/deselect
selected	boolean	True to select, false to deselect

Returns

boolean

True if successful

---

setPageBox()

setPageBox(boxType, box): void

Defined in: src/document/page.ts:405

Set a specific page box.

Parameters

Parameter	Type	Description
boxType	PageBoxType	The type of box to set
box	PageBox	The box coordinates in points

Returns

void

---

startProgressiveRender()

startProgressiveRender(options): ProgressiveRenderContext

Defined in: src/document/page.ts:762

Start progressive rendering of the page.

Returns a ProgressiveRenderContext that owns the render resources. Use continue() to advance the render, and dispose when done.

Parameters

Parameter	Type	Description
options	RenderOptions	Render options (same as render())

Returns

ProgressiveRenderContext

A disposable render context

Throws

If progressive rendering is unavailable or setup fails

Example

using render = page.startProgressiveRender({ scale: 2 });

while (render.status === ProgressiveRenderStatus.ToBeContinued) {
  render.continue();
}

if (render.status === ProgressiveRenderStatus.Done) {
  const result = render.getResult();
}

Implementation of

IPageReader.startProgressiveRender

---

structureElements()

structureElements(): IterableIterator<StructureElement, any, any> | undefined

Defined in: src/document/page.ts:2573

Iterate over root structure elements lazily.

Each yielded element includes its full subtree of children (eagerly loaded). Returns undefined if the page has no structure tree.

The structure tree handle is kept open for the lifetime of the generator. Dispose or exhaust the generator to release it.

Returns

IterableIterator<StructureElement, any, any> | undefined

A generator yielding root-level structure elements, or undefined if the page is not tagged

Throws

If the structure tree depth exceeds the maximum

Example

const elements = page.structureElements();
if (elements) {
  for (const element of elements) {
    console.log(element.type);
  }
}

---

transformAnnotations()

transformAnnotations(matrix): void

Defined in: src/document/page.ts:522

Transform all annotations on the page.

Applies an affine transformation matrix to all annotations.

Parameters

Parameter	Type	Description
matrix	TransformMatrix	The transformation matrix to apply

Returns

void

---

transformWithClip()

transformWithClip(matrix, clipRect?): boolean

Defined in: src/document/page.ts:1650

Transform this page with a matrix and optional clip rectangle.

Parameters

Parameter	Type	Description
matrix	TransformMatrix	The transformation matrix to apply
clipRect?	PageBox	Optional clip rectangle in page coordinates

Returns

boolean

True if successful