NativePDFiumPage

@scaryterry/pdfium

---

Defined in: src/document/native-page.ts:66

A PDF page backed by the native PDFium addon.

Supports core operations: dimensions, text extraction, and rendering.

Extends

• Disposable

Accessors

annotationCount

Get Signature

get annotationCount(): number

Defined in: src/document/native-page.ts:535

Get the number of annotations on this page.

Returns

number

---

artBox

Get Signature

get artBox(): PageBox | undefined

Defined in: src/document/native-page.ts:521

Get the art box (content boundaries).

Returns

PageBox | undefined

---

bleedBox

Get Signature

get bleedBox(): PageBox | undefined

Defined in: src/document/native-page.ts:511

Get the bleed box (printing bleed area).

Returns

PageBox | undefined

---

charCount

Get Signature

get charCount(): number

Defined in: src/document/native-page.ts:146

Get the number of characters on the page.

Returns

number

---

cropBox

Get Signature

get cropBox(): PageBox | undefined

Defined in: src/document/native-page.ts:506

Get the crop box (visible region).

Returns

PageBox | undefined

---

disposed

Get Signature

get disposed(): boolean

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

Whether this resource has been disposed.

Returns

boolean

Inherited from

Disposable.disposed

---

height

Get Signature

get height(): number

Defined in: src/document/native-page.ts:119

Get the height of the page in points.

Returns

number

---

index

Get Signature

get index(): number

Defined in: src/document/native-page.ts:102

The zero-based index of this page.

Returns

number

---

mediaBox

Get Signature

get mediaBox(): PageBox | undefined

Defined in: src/document/native-page.ts:501

Get the media box (physical page boundaries).

Returns

PageBox | undefined

---

rotation

Get Signature

get rotation(): PageRotation

Defined in: src/document/native-page.ts:410

Get the page rotation (0=0deg, 1=90deg, 2=180deg, 3=270deg).

Returns

PageRotation

---

size

Get Signature

get size(): object

Defined in: src/document/native-page.ts:107

Get the page dimensions in points.

Returns

object

Name	Type	Defined in
height	number	src/document/native-page.ts:107
width	number	src/document/native-page.ts:107

---

trimBox

Get Signature

get trimBox(): PageBox | undefined

Defined in: src/document/native-page.ts:516

Get the trim box (final trimmed dimensions).

Returns

PageBox | undefined

---

width

Get Signature

get width(): number

Defined in: src/document/native-page.ts:113

Get the width of the page in points.

Returns

number

Methods

[dispose]()

[dispose](): void

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

Dispose of this resource, freeing WASM memory.

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

Returns

void

Inherited from

Disposable.[dispose]

---

appendAnnotationAttachmentPoints()

appendAnnotationAttachmentPoints(index, points): boolean

Defined in: src/document/native-page.ts:664

Append attachment points to an annotation.

Parameters

Parameter	Type
index	number
points	QuadPoints

Returns

boolean

true if the points were appended.

---

createAnnotation()

createAnnotation(subtype): number

Defined in: src/document/native-page.ts:546

Create a new annotation on this page.

Parameters

Parameter	Type	Description
subtype	AnnotationType	Annotation subtype (e.g. AnnotationType.Text = 1).

Returns

number

The index of the new annotation.

---

deviceToPage()

deviceToPage(context, deviceX, deviceY): PageCoordinate

Defined in: src/document/native-page.ts:440

Convert device coordinates to page coordinates.

Parameters

Parameter	Type
context	CoordinateTransformContext
deviceX	number
deviceY	number

Returns

PageCoordinate

---

dispose()

dispose(): void

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

Alias for Symbol.dispose for explicit calls.

Returns

void

Example

document.dispose();

Inherited from

Disposable.dispose

---

findText()

findText(query, flags): IterableIterator<TextSearchResult>

Defined in: src/document/native-page.ts:386

Find all occurrences of a string on the page.

Parameters

Parameter	Type	Default value
query	string	undefined
flags	TextSearchFlags	TextSearchFlags.None

Returns

IterableIterator<TextSearchResult>

---

flatten()

flatten(flags): FlattenResult

Defined in: src/document/native-page.ts:422

Flatten annotations and form fields into page content.

Parameters

Parameter	Type	Default value
flags	FlattenFlags	FlattenFlags.NormalDisplay

Returns

FlattenResult

---

generateContent()

generateContent(): boolean

Defined in: src/document/native-page.ts:432

Generate the page content stream after modifications.

Returns

boolean

---

getAnnotationFlags()

getAnnotationFlags(index): number

Defined in: src/document/native-page.ts:600

Get the flags of an annotation.

Parameters

Parameter	Type
index	number

Returns

number

---

getAnnotations()

getAnnotations(): Annotation[]

Defined in: src/document/native-page.ts:528

Get all annotations on this page.

Returns

Annotation[]

---

getBoundedText()

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

Defined in: src/document/native-page.ts:401

Get text within a bounding rectangle.

Parameters

Parameter	Type
left	number
top	number
right	number
bottom	number

Returns

string

---

getCharAngle()

getCharAngle(charIndex): number

Defined in: src/document/native-page.ts:284

Get the rotation angle (in radians) of a character.

Parameters

Parameter	Type
charIndex	number

Returns

number

---

getCharBox()

getCharBox(charIndex): CharBox | undefined

Defined in: src/document/native-page.ts:306

Get the bounding box of a character.

Parameters

Parameter	Type
charIndex	number

Returns

CharBox | undefined

---

getCharFillColour()

getCharFillColour(charIndex): Colour | undefined

Defined in: src/document/native-page.ts:340

Get the fill colour of a character.

Parameters

Parameter	Type
charIndex	number

Returns

Colour | undefined

---

getCharFontName()

getCharFontName(charIndex): string | undefined

Defined in: src/document/native-page.ts:210

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

Parameters

Parameter	Type
charIndex	number

Returns

string | undefined

---

getCharFontSize()

getCharFontSize(charIndex): number

Defined in: src/document/native-page.ts:184

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

Parameters

Parameter	Type
charIndex	number

Returns

number

---

getCharFontWeight()

getCharFontWeight(charIndex): number

Defined in: src/document/native-page.ts:197

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

Parameters

Parameter	Type
charIndex	number

Returns

number

---

getCharIndexAtPos()

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

Defined in: src/document/native-page.ts:328

Get the character index at a page position. Returns -1 if not found.

Parameters

Parameter	Type	Default value
x	number	undefined
y	number	undefined
xTolerance	number	DEFAULT_CHAR_POSITION_TOLERANCE
yTolerance	number	DEFAULT_CHAR_POSITION_TOLERANCE

Returns

number

---

getCharLooseBox()

getCharLooseBox(charIndex): Rect | undefined

Defined in: src/document/native-page.ts:317

Get the loose bounding box of a character.

Parameters

Parameter	Type
charIndex	number

Returns

Rect | undefined

---

getCharMatrix()

getCharMatrix(charIndex): TransformMatrix | undefined

Defined in: src/document/native-page.ts:362

Get the transformation matrix of a character.

Parameters

Parameter	Type
charIndex	number

Returns

TransformMatrix | undefined

---

getCharOrigin()

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

Defined in: src/document/native-page.ts:295

Get the origin point of a character.

Parameters

Parameter	Type
charIndex	number

Returns

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

---

getCharRenderMode()

getCharRenderMode(charIndex): TextRenderMode

Defined in: src/document/native-page.ts:224

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

Parameters

Parameter	Type
charIndex	number

Returns

TextRenderMode

---

getCharStrokeColour()

getCharStrokeColour(charIndex): Colour | undefined

Defined in: src/document/native-page.ts:351

Get the stroke colour of a character.

Parameters

Parameter	Type
charIndex	number

Returns

Colour | undefined

---

getCharUnicode()

getCharUnicode(charIndex): number

Defined in: src/document/native-page.ts:240

Get the Unicode codepoint of a character.

Parameters

Parameter	Type
charIndex	number

Returns

number

---

getLinks()

getLinks(): PDFLink[]

Defined in: src/document/native-page.ts:693

Get all links on this page.

Returns

PDFLink[]

---

getPageBox()

getPageBox(boxType): PageBox | undefined

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

Get a specific page box by type.

Parameters

Parameter	Type
boxType	PageBoxType

Returns

PageBox | undefined

---

getText()

getText(): string

Defined in: src/document/native-page.ts:125

Get all text content from the page.

Returns

string

---

hasCharUnicodeMapError()

hasCharUnicodeMapError(charIndex): boolean

Defined in: src/document/native-page.ts:273

Check if a character has a Unicode mapping error.

Parameters

Parameter	Type
charIndex	number

Returns

boolean

---

hasTransparency()

hasTransparency(): boolean

Defined in: src/document/native-page.ts:416

Check if this page contains transparency.

Returns

boolean

---

isCharGenerated()

isCharGenerated(charIndex): boolean

Defined in: src/document/native-page.ts:251

Check if a character is generated (not from the original PDF content).

Parameters

Parameter	Type
charIndex	number

Returns

boolean

---

isCharHyphen()

isCharHyphen(charIndex): boolean

Defined in: src/document/native-page.ts:262

Check if a character is a hyphen.

Parameters

Parameter	Type
charIndex	number

Returns

boolean

---

pageToDevice()

pageToDevice(context, pageX, pageY): DeviceCoordinate

Defined in: src/document/native-page.ts:458

Convert page coordinates to device coordinates.

Parameters

Parameter	Type
context	CoordinateTransformContext
pageX	number
pageY	number

Returns

DeviceCoordinate

---

removeAnnotation()

removeAnnotation(index): boolean

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

Remove an annotation by index.

Parameters

Parameter	Type
index	number

Returns

boolean

true if the annotation was removed.

---

render()

render(options): RenderResult

Defined in: src/document/native-page.ts:153

Render the page to a bitmap.

Parameters

Parameter	Type
options	RenderOptions

Returns

RenderResult

---

setAnnotationAttachmentPoints()

setAnnotationAttachmentPoints(index, quadIndex, points): boolean

Defined in: src/document/native-page.ts:642

Set attachment points at a specific quad index.

Parameters

Parameter	Type
index	number
quadIndex	number
points	QuadPoints

Returns

boolean

true if the points were set.

---

setAnnotationBorder()

setAnnotationBorder(index, horizontalRadius, verticalRadius, borderWidth): boolean

Defined in: src/document/native-page.ts:632

Set the border of an annotation.

Parameters

Parameter	Type
index	number
horizontalRadius	number
verticalRadius	number
borderWidth	number

Returns

boolean

true if the border was set.

---

setAnnotationColour()

setAnnotationColour(index, colour, colourType): boolean

Defined in: src/document/native-page.ts:584

Set the colour of an annotation.

Parameters

Parameter	Type	Default value	Description
index	number	undefined	-
colour	Colour	undefined	-
colourType	number	0	0 for colour, 1 for interior colour.

Returns

boolean

true if the colour was set.

---

setAnnotationFlags()

setAnnotationFlags(index, flags): boolean

Defined in: src/document/native-page.ts:610

Set the flags of an annotation.

Parameters

Parameter	Type
index	number
flags	number

Returns

boolean

true if the flags were set.

---

setAnnotationRect()

setAnnotationRect(index, bounds): boolean

Defined in: src/document/native-page.ts:566

Set the bounding rectangle of an annotation.

Parameters

Parameter	Type
index	number
bounds	PageBox

Returns

boolean

true if the rect was set.

---

setAnnotationStringValue()

setAnnotationStringValue(index, key, value): boolean

Defined in: src/document/native-page.ts:622

Set a string value on an annotation.

Parameters

Parameter	Type	Description
index	number	-
key	string	The dictionary key (e.g. “Contents”).
value	string	The string value.

Returns

boolean

true if the value was set.

---

setAnnotationUri()

setAnnotationUri(index, uri): boolean

Defined in: src/document/native-page.ts:685

Set the URI on a link annotation.

Parameters

Parameter	Type
index	number
uri	string

Returns

boolean

true if the URI was set.

---

setPageBox()

setPageBox(boxType, box): void

Defined in: src/document/native-page.ts:488

Set a specific page box by type.

Parameters

Parameter	Type
boxType	PageBoxType
box	PageBox

Returns

void