PDFiumDocument

Defined in: src/document/document.ts:122

Represents a loaded PDF document.

Documents must be disposed when no longer needed to free WASM memory. Use the using keyword for automatic disposal.

Example

using document = await pdfium.openDocument(pdfBytes);
console.log(`Document has ${document.pageCount} pages`);

for (const page of document.pages()) {
  using p = page;
  const text = p.getText();
}

Extends

Disposable

Implements

IDocumentReader

Properties

events

readonly events: EventEmitter<DocumentEvents>

Defined in: src/document/document.ts:129

Event emitter for document events.

Accessors

attachmentCount

Get Signature

get attachmentCount(): number

Defined in: src/document/document.ts:371

Get the number of file attachments in this document.

Returns

number

Get the number of attachments.

Implementation of

IDocumentReader.attachmentCount

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

duplexMode

Get Signature

get duplexMode(): DuplexMode

Defined in: src/document/document.ts:820

Get the duplex printing mode preference.

Returns

DuplexMode

The duplex mode setting

fileVersion

Get Signature

get fileVersion(): number | undefined

Defined in: src/document/document.ts:591

Get the PDF file version.

Returns the PDF version as an integer (e.g., 14 for PDF 1.4, 17 for PDF 1.7). Returns undefined if the version cannot be determined.

Returns

number | undefined

Get the PDF file version.

Implementation of

IDocumentReader.fileVersion

formType

Get Signature

get formType(): FormType

Defined in: src/document/document.ts:1187

Get the form type of this document.

Returns what type of interactive form (if any) the document contains.

Returns

FormType

javaScriptActionCount

Get Signature

get javaScriptActionCount(): number

Defined in: src/document/document.ts:980

Get the count of JavaScript actions in this document.

JavaScript actions can be triggered by document events, page events, or user interactions like button clicks.

Returns

number

The number of JavaScript actions

namedDestinationCount

Get Signature

get namedDestinationCount(): number

Defined in: src/document/document.ts:883

Get the count of named destinations in this document.

Returns

number

The number of named destinations

numCopies

Get Signature

get numCopies(): number

Defined in: src/document/document.ts:809

Get the number of copies to print by default.

Returns

number

The default number of copies

pageCount

Get Signature

get pageCount(): number

Defined in: src/document/document.ts:209

Get the number of pages in the document.

Returns

number

Get the number of pages in the document.

Implementation of

IDocumentReader.pageCount

pageMode

Get Signature

get pageMode(): PageMode

Defined in: src/document/document.ts:672

Get the document’s initial page mode.

Determines what panel should be displayed when the document is opened.

Returns

PageMode

Get the document’s initial page mode.

Implementation of

IDocumentReader.pageMode

printScaling

Get Signature

get printScaling(): boolean

Defined in: src/document/document.ts:799

Check if print scaling should be applied.

Returns

boolean

True if print scaling is enabled, false otherwise

rawPermissions

Get Signature

get rawPermissions(): number

Defined in: src/document/document.ts:617

Get the raw document permissions bitmask.

Returns the raw permissions value from the document’s encryption dictionary. Use bitwise operations with DocumentPermission enum to check specific permissions, or use getPermissions for a structured object.

Example

const perms = document.rawPermissions;
const canPrint = (perms & DocumentPermission.Print) !== 0;

Returns

number

Get the raw document permissions bitmask.

Implementation of

IDocumentReader.rawPermissions

securityHandlerRevision

Get Signature

get securityHandlerRevision(): number

Defined in: src/document/document.ts:685

Get the security handler revision.

Returns the revision number of the document’s security handler, or -1 if the document is not encrypted.

Returns

number

Get the security handler revision.

Implementation of

IDocumentReader.securityHandlerRevision

signatureCount

Get Signature

get signatureCount(): number

Defined in: src/document/document.ts:1058

Get the number of digital signatures in this document.

Returns

number

userPermissions

Get Signature

get userPermissions(): number

Defined in: src/document/document.ts:662

Get the document user permissions bitmask.

Similar to permissions, but returns the user-level permissions (which may differ from owner permissions for encrypted documents).

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

Implementation of

IDocumentReader.[dispose]

Inherited from

Disposable.[dispose]

addAttachment()

addAttachment(name): PDFiumAttachmentWriter | null

Defined in: src/document/document.ts:494

Add a new attachment to the document.

Parameters

Parameter	Type	Description
`name`	`string`	The name of the attachment

Returns

PDFiumAttachmentWriter | null

An attachment writer for setting file contents and metadata, or null if failed

attachments()

attachments(): IterableIterator<PDFAttachment>

Defined in: src/document/document.ts:424

Iterate over file attachments lazily.

Use this for memory-efficient iteration over attachments.

Returns

IterableIterator<PDFAttachment>

Example

for (const attachment of document.attachments()) {
  console.log(attachment.name);
}

Implementation of

IDocumentReader.attachments

bookmarks()

bookmarks(): IterableIterator<Bookmark>

Defined in: src/document/document.ts:326

Iterate over top-level bookmarks lazily.

Each yielded bookmark includes its full subtree of children (eagerly loaded). Use this to avoid building the entire bookmark array up-front.

Returns

IterableIterator<Bookmark>

A generator yielding top-level bookmarks with their children

Throws

If the bookmark tree depth exceeds the maximum

Example

for (const bookmark of document.bookmarks()) {
  console.log(bookmark.title);
}

Implementation of

IDocumentReader.bookmarks

copyViewerPreferences()

copyViewerPreferences(source): boolean

Defined in: src/document/document.ts:1394

Copy viewer preferences from another document.

Copies settings like print scaling, duplex mode, and display preferences.

Parameters

Parameter	Type	Description
`source`	`PDFiumDocument`	The source document to copy preferences from

Returns

boolean

True if preferences were successfully copied

createNUpDocument()

createNUpDocument(options): PDFiumDocument | undefined

Defined in: src/document/document.ts:1424

Create a new document with N-up layout (multiple source pages per output page).

This is useful for creating print layouts where multiple pages appear on each sheet (e.g., 2-up, 4-up, 9-up layouts).

Note: The caller is responsible for disposing the returned document.

Parameters

Parameter	Type	Description
`options`	`NUpLayoutOptions`	N-up layout configuration

Returns

PDFiumDocument | undefined

A new document with the N-up layout, or undefined if failed

Example

// Create 2-up layout (2 pages side by side)
using nupDoc = document.createNUpDocument({
  outputWidth: 842,  // A4 landscape width
  outputHeight: 595, // A4 landscape height
  pagesPerRow: 2,
  pagesPerColumn: 1,
});

deleteAttachment()

deleteAttachment(index): boolean

Defined in: src/document/document.ts:517

Delete an attachment from the document.

Parameters

Parameter	Type	Description
`index`	`number`	Zero-based index of the attachment to delete

Returns

boolean

True if successful

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

executeDocumentAction()

executeDocumentAction(actionType): void

Defined in: src/document/document.ts:1461

Execute a document-level action.

This triggers JavaScript or other actions associated with document lifecycle events.

Parameters

Parameter	Type	Description
`actionType`	`DocumentActionType`	The document action type to execute

Returns

void

Example

// Execute before-save actions
document.executeDocumentAction(DocumentActionType.WillSave);

executeDocumentJSAction()

executeDocumentJSAction(): void

Defined in: src/document/document.ts:1475

Execute document-level JavaScript actions.

This triggers any JavaScript actions that are set to run at document level.

Returns

void

executeDocumentOpenAction()

executeDocumentOpenAction(): void

Defined in: src/document/document.ts:1490

Execute the document open action.

This triggers any action set to run when the document is opened. Should be called after the document is fully loaded.

Returns

void

getAttachment()

getAttachment(index): PDFAttachment

Defined in: src/document/document.ts:383

Get a file attachment by index.

Parameters

Parameter	Type	Description
`index`	`number`	Zero-based attachment index

Returns

PDFAttachment

The attachment metadata and data

Throws

If the attachment cannot be loaded

Implementation of

IDocumentReader.getAttachment

getAttachments()

getAttachments(): PDFAttachment[]

Defined in: src/document/document.ts:444

Get all file attachments in this document.

For documents with many attachments, prefer using the attachments() generator.

Returns

PDFAttachment[]

Implementation of

IDocumentReader.getAttachments

getBookmarks()

getBookmarks(): Bookmark[]

Defined in: src/document/document.ts:306

Get the bookmark (outline) tree for this document.

Returns an array of top-level bookmarks, each with nested children. Returns an empty array if the document has no bookmarks.

For large bookmark trees, prefer the lazy bookmarks generator.

Returns

Bookmark[]

Implementation of

IDocumentReader.getBookmarks

getJavaScriptAction()

getJavaScriptAction(index): JavaScriptAction | undefined

Defined in: src/document/document.ts:1000

Get a JavaScript action by index.

Parameters

Parameter	Type	Description
`index`	`number`	Zero-based index of the JavaScript action

Returns

JavaScriptAction | undefined

The JavaScript action with name and script, or undefined

getJavaScriptActions()

getJavaScriptActions(): JavaScriptAction[]

Defined in: src/document/document.ts:1032

Get all JavaScript actions in this document.

Returns

JavaScriptAction[]

Array of JavaScript actions with names and scripts

getMetadata()

getMetadata(): DocumentMetadata

Defined in: src/document/document.ts:535

Get all standard metadata fields from the document.

Returns an object containing all available metadata fields. Fields that are not present in the document will not be included.

Returns

DocumentMetadata

Example

const metadata = document.getMetadata();
console.log(`Title: ${metadata.title}`);
console.log(`Author: ${metadata.author}`);

Implementation of

IDocumentReader.getMetadata

getMetaText()

getMetaText(tag): string | undefined

Defined in: src/document/document.ts:576

Get a specific metadata field by tag name.

Standard tags include: Title, Author, Subject, Keywords, Creator, Producer, CreationDate, ModDate.

Parameters

Parameter	Type	Description
`tag`	`string`	The metadata tag name (case-sensitive)

Returns

string | undefined

The metadata value, or undefined if not present

Implementation of

IDocumentReader.getMetaText

getNamedDestinationByName()

getNamedDestinationByName(name): NamedDestination | undefined

Defined in: src/document/document.ts:894

Get a named destination by its name.

Parameters

Parameter	Type	Description
`name`	`string`	The destination name

Returns

NamedDestination | undefined

The destination with page index, or undefined if not found

Implementation of

IDocumentReader.getNamedDestinationByName

getNamedDestinations()

getNamedDestinations(): NamedDestination[]

Defined in: src/document/document.ts:919

Get all named destinations in this document.

Returns

NamedDestination[]

Array of named destinations

Implementation of

IDocumentReader.getNamedDestinations

getPage()

getPage(pageIndex): PDFiumPage

Defined in: src/document/document.ts:224

Load a specific page from the document.

Parameters

Parameter	Type	Description
`pageIndex`	`number`	Zero-based page index

Returns

PDFiumPage

The loaded page

Throws

If the page cannot be loaded

Implementation of

IDocumentReader.getPage

getPageLabel()

getPageLabel(pageIndex): string | undefined

Defined in: src/document/document.ts:741

Get the label for a specific page.

PDF documents can have custom page labels (e.g., “i”, “ii”, “1”, “2”). Returns undefined if no label is defined for the page.

Parameters

Parameter	Type	Description
`pageIndex`	`number`	Zero-based page index

Returns

string | undefined

getPermissions()

getPermissions(): DocumentPermissions

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

Get structured document permissions with named boolean fields.

This decodes the raw permissions bitmask into a typed object with a named boolean field for each permission.

Returns

DocumentPermissions

Structured permissions object

Example

const perms = document.getPermissions();
if (perms.canPrint) {
  console.log('Printing is allowed');
}

Implementation of

IDocumentReader.getPermissions

getPrintPageRanges()

getPrintPageRanges(): number[] | undefined

Defined in: src/document/document.ts:831

Get the print page ranges for this document.

Returns

number[] | undefined

Array of page indices to print, or undefined if all pages

getSignature()

getSignature(index): PDFSignature | undefined

Defined in: src/document/document.ts:1076

Get a digital signature by index.

Parameters

Parameter	Type	Description
`index`	`number`	Zero-based signature index

Returns

PDFSignature | undefined

Signature information, or undefined if not found

getSignatures()

getSignatures(): PDFSignature[]

Defined in: src/document/document.ts:1128

Get all digital signatures in this document.

Returns metadata only (reason, time, sub-filter, contents). Signature verification is not supported by PDFium.

For documents with many signatures, prefer using the signatures() generator.

Returns

PDFSignature[]

getTrailerEnds()

getTrailerEnds(): number[]

Defined in: src/document/document.ts:712

Get trailer end offsets for incremental saves.

Returns an array of byte offsets where trailer sections end. Useful for determining save points in incrementally saved documents. Returns an empty array if no trailer ends are found.

Returns

number[]

getViewerPreference()

getViewerPreference(key): string | undefined

Defined in: src/document/document.ts:861

Get a viewer preference value by name.

Parameters

Parameter	Type	Description
`key`	`string`	The preference key name

Returns

string | undefined

The preference value as a string, or undefined if not found

getViewerPreferences()

getViewerPreferences(): ViewerPreferences

Defined in: src/document/document.ts:779

Get the viewer preferences for this document.

Returns settings that control how a PDF viewer should display and print the document.

Returns

ViewerPreferences

The viewer preferences

hasAcroForm()

hasAcroForm(): boolean

Defined in: src/document/document.ts:1203

Check if this document uses AcroForm (standard PDF forms).

Returns

boolean

hasForm()

hasForm(): boolean

Defined in: src/document/document.ts:1196

Check if this document has an interactive form.

Returns

boolean

hasJavaScript()

hasJavaScript(): boolean

Defined in: src/document/document.ts:990

Check if this document contains any JavaScript.

Returns

boolean

True if the document contains JavaScript actions

hasSignatures()

hasSignatures(): boolean

Defined in: src/document/document.ts:1066

Check if this document has digital signatures.

Returns

boolean

hasValidCrossReferenceTable()

hasValidCrossReferenceTable(): boolean

Defined in: src/document/document.ts:700

Check if the document has a valid cross-reference table.

A valid cross-reference table is required for proper PDF parsing. Documents with damaged cross-reference tables may still open but could have rendering issues.

Returns

boolean

hasXFAForm()

hasXFAForm(): boolean

Defined in: src/document/document.ts:1212

Check if this document uses XFA forms.

Note: XFA forms have limited support in PDFium.

Returns

boolean

importPages()

importPages(source, options): void

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

Import pages from another document.

Parameters

Parameter	Type	Description
`source`	`PDFiumDocument`	The source document to import pages from
`options`	`ImportPagesOptions`	Import options (page range, insert position)

Returns

void

Throws

If page import fails or the function is unavailable

Example

// Import all pages from source
document.importPages(sourceDoc);

// Import specific pages
document.importPages(sourceDoc, { pageRange: '1-3,5' });

// Insert pages at beginning
document.importPages(sourceDoc, { pageRange: '1', insertIndex: 0 });

importPagesByIndex()

importPagesByIndex(source, pageIndices, insertIndex?): void

Defined in: src/document/document.ts:1351

Import pages by their indices.

Parameters

Parameter	Type	Description
`source`	`PDFiumDocument`	The source document to import pages from
`pageIndices`	readonly `number`[]	Zero-based page indices to import
`insertIndex?`	`number`	Zero-based index where pages should be inserted (default: end)

Returns

void

Throws

If page import fails or the function is unavailable

Example

// Import pages 0, 2, and 4 from source
document.importPagesByIndex(sourceDoc, [0, 2, 4]);

// Insert at beginning
document.importPagesByIndex(sourceDoc, [0, 1], 0);

isTagged()

isTagged(): boolean

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

Check if the document is tagged (accessible).

Tagged PDFs contain structure information for accessibility tools. Returns true if the document’s catalog indicates it is tagged.

Returns

boolean

killFormFocus()

killFormFocus(): boolean

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

Force release of keyboard focus from any form field.

Returns

boolean

True if focus was successfully released

pages()

pages(): IterableIterator<PDFiumPage>

Defined in: src/document/document.ts:290

Iterate over all pages in the document.

Each page is yielded directly. Throws on failure.

Returns

IterableIterator<PDFiumPage>

Example

for (const page of document.pages()) {
  using p = page;
  // Use the page
}

Implementation of

IDocumentReader.pages

save()

save(options): Uint8Array

Defined in: src/document/document.ts:1268

Save the document to a new byte array.

Parameters

Parameter	Type	Description
`options`	`SaveOptions`	Save options (flags, version)

Returns

Uint8Array

The serialised PDF bytes

Throws

If the save operation fails

Implementation of

IDocumentReader.save

setFormFieldHighlightAlpha()

setFormFieldHighlightAlpha(alpha): void

Defined in: src/document/document.ts:1253

Set the highlight alpha for form fields.

Parameters

Parameter	Type	Description
`alpha`	`number`	Alpha value (0-255)

Returns

void

setFormFieldHighlightColour()

setFormFieldHighlightColour(fieldType, colour): void

Defined in: src/document/document.ts:1236

Set the highlight colour for form fields.

Parameters

Parameter	Type	Description
`fieldType`	`FormFieldType`	Form field type to highlight
`colour`	`Colour`	Colour value for the highlight

Returns

void

signatures()

signatures(): IterableIterator<PDFSignature>

Defined in: src/document/document.ts:1109

Iterate over digital signatures lazily.

Use this for memory-efficient iteration over signatures.

Returns

IterableIterator<PDFSignature>

Example

for (const signature of document.signatures()) {
  console.log(signature.subFilter);
}