PdfDocument

ObjectManager that controls the object lifetime

options?

PdfDocumentOptions

Creation options for new documents (optional)

Returns

PdfDocument

Examples

// Create empty document
const doc1 = new PdfDocument(om);

// Create document with options
const options = { compressionLevel: "Optimal", conformanceLevel: "PdfA1a" };
const doc2 = new PdfDocument(om, options);

Overrides

ObjectBase.constructor

Constructor

new PdfDocument(options?): PdfDocument;

Creates a new PDF document instance.

Parameters

options?

PdfDocumentOptions

Creation options for new documents (optional)

Returns

PdfDocument

Examples

// Create empty document
const doc1 = new PdfDocument();

// Create document with options
const options = { compressionLevel: "Optimal", conformanceLevel: "PdfA1a" };
const doc2 = new PdfDocument(options);

Overrides

ObjectBase.constructor

Accessors

acroForm

Get Signature

get acroForm(): AcroForm;

Gets the AcroForm object defining common properties of the AcroForms in this document.

Returns

AcroForm

associatedFiles

Get Signature

get associatedFiles(): AssociatedFiles;

Gets the list of embedded files associated with the document.

Returns

AssociatedFiles

compressionLevel

Get Signature

get compressionLevel(): CompressionLevel;

Gets the compression level. Default value is CompressionLevel#Fastest.

Returns

CompressionLevel

Set Signature

set compressionLevel(value): void;

Sets the compression level. Default value is CompressionLevel#Fastest.

Parameters

value

CompressionLevel

Returns

void

conformanceLevel

Get Signature

get conformanceLevel(): PdfAConformanceLevel;

Gets the PDF/A conformance level. The default is none (the document does not conform to PDF/A).

Returns

PdfAConformanceLevel

Set Signature

set conformanceLevel(value): void;

Sets the PDF/A conformance level. The default is none (the document does not conform to PDF/A).

Parameters

value

PdfAConformanceLevel

Returns

void

didPrintAction

Get Signature

get didPrintAction(): ActionJavaScript;

Gets or sets a ActionJavaScript to be performed after printing the document.

Returns

| ActionJavaScriptProperties | ActionJavaScript

Set Signature

set didPrintAction(value): void;

Gets or sets a ActionJavaScript to be performed after printing the document.

Parameters

value

Returns

void

didSaveAction

Get Signature

get didSaveAction(): ActionJavaScript;

Gets or sets a ActionJavaScript to be performed after saving the document.

Returns

| ActionJavaScriptProperties | ActionJavaScript

Set Signature

set didSaveAction(value): void;

Gets or sets a ActionJavaScript to be performed after saving the document.

Parameters

value

Returns

void

documentInfo

Get Signature

get documentInfo(): DocumentInfo;

Gets the DocumentInfo object that contains information about this document (author, title, etc).

Returns

DocumentInfo

Set Signature

set documentInfo(docInfo): void;

Sets the DocumentInfo object that contains information about this document (author, title, etc).

Example

const doc = new PdfDocument();
doc.documentInfo = {
    title: "Document Info Sample",
    author: "John Doe",
    subject: "DsPdfJS PdfDocumentInfo",
    creationDate: new Date()
};
const res: Uint8Array = doc.savePdf();

Parameters

docInfo

| DocumentInfoProperties | DocumentInfo

Returns

void

embeddedFiles

Get Signature

get embeddedFiles(): FileSpecificationMap;

Gets the dictionary of document level file attachments.

Returns

FileSpecificationMap

fileID

Get Signature

get fileID(): FileID;

Gets the FileID object defining ID of this PDF document. Note that this ID is automatically updated if the clear method is called.

Returns

FileID

Set Signature

set fileID(value): void;

Sets the FileID object defining ID of this PDF document. Note that this ID is automatically updated if the clear method is called.

Parameters

value

FileID

Returns

void

fontCollection

Get Signature

get fontCollection(): FontCollection;

Gets or sets the FontCollection object used when the PdfDocument needs to find a Font (e.g. if it is not embedded in the PDF).

Returns

FontCollection

Set Signature

set fontCollection(coll): void;

Gets or sets the FontCollection object used when the PdfDocument needs to find a Font (e.g. if it is not embedded in the PDF).

Parameters

coll

FontCollection

Returns

void

fontEmbedMode

Get Signature

get fontEmbedMode(): FontEmbedMode;

Gets or sets the font embedding mode. The default is FontEmbedMode.EmbedSubset. Note that this property does not affect the 14 standard PDF fonts, their embedding is determined by the PdfDocument#standardFontEmbedMode property. Also note that if the PdfDocument is saved as PDF/A, and the value of this property is FontEmbedMode.NotEmbed, the fonts are embedded anyway using the FontEmbedMode.EmbedSubset mode.

Returns

Set Signature

set fontEmbedMode(value): void;

Parameters

value

PdfImageHandlerCollection

Returns

void

fontHandlers

Get Signature

get fontHandlers(): FontHandlerCollection;

Gets the collection of font handlers associated with the current document.

Returns

FontHandlerCollection

id

Get Signature

get id(): number;

Gets the reference to the object.

Returns

number

Inherited from

ObjectBase.id

imageHandlers

Get Signature

get imageHandlers(): PdfImageHandlerCollection;

Gets the collection of PdfImageHandler objects associated with the current document.

Returns

imageOptions

Get Signature

get imageOptions(): ImageOptions;

Gets the ImageOptions object that contains options controlling how images are processed in the current document.

Returns

ImageOptions

Set Signature

set imageOptions(value): void;

Sets the ImageOptions object that contains options controlling how images are processed in the current document.

Parameters

value

ImageOptions

Returns

void

isNewPdf

Get Signature

get isNewPdf(): boolean;

Gets a value indicating if the PDF document was created from scratch.

Returns

boolean

javaScripts

Get Signature

get javaScripts(): ActionJavaScriptMap;

Gets the document-level java scripts as a dictionary where key is a custom user defined name and value is a ActionJavaScript object containing a JavaScript associated with a name.

Returns

ActionJavaScriptMap

lang

Get Signature

get lang(): string;

Gets the language identifier (e.g. "en-US") specifying the natural language for all text in the document except where overridden by language specifications for structure elements or marked content. Null indicates that the language is unknown.

Returns

string

Set Signature

set lang(value): void;

Sets the language identifier (e.g. "en-US") specifying the natural language for all text in the document except where overridden by language specifications for structure elements or marked content. Null indicates that the language is unknown.

Parameters

value

string

Returns

void

linearized

Get Signature

get linearized(): boolean;

Gets a value indicating whether the PDF was linearized ("fast web view").

Returns

boolean

markInfo

Get Signature

get markInfo(): MarkInfo;

Gets the MarkInfo object that provides additional information relevant to specialized uses of structured documents, in particular indicating whether the document conforms to Tagged PDF conventions.

Returns

MarkInfo

metadata

Get Signature

get metadata(): Metadata;

Gets the metadata associated with this document.

Returns

Metadata

Set Signature

set metadata(meta): void;

Sets the metadata associated with this document.

Parameters

Returns

void

namedDestinations

Get Signature

get namedDestinations(): DocumentDestinations;

Gets the dictionary of named destinations defined in the current document.

Returns

DocumentDestinations

om

Get Signature

get om(): ObjectManager;

Gets the owner ObjectManager instance.

Returns

Inherited from

ObjectBase.om

openAction

Get Signature

get openAction(): DocAction;

Gets or sets a DocAction to be displayed or performed when the document is opened.

Returns

DocAction

Set Signature

set openAction(value): void;

Gets or sets a DocAction to be displayed or performed when the document is opened.

Parameters

value

| DocAction | DocActionProperties

Returns

void

outlines

Get Signature

get outlines(): OutlineNodeCollection;

Gets the collection of the current document outlines.

Returns

OutlineNodeCollection

outputIntents

Get Signature

get outputIntents(): OutputIntentCollection;

Gets the output intents collection for the current document. Output intents provide information about the intended output device or production condition.

Returns

OutputIntentCollection

pageLabelingRanges

Get Signature

get pageLabelingRanges(): PageLabelingRangeMap;

Gets the page labeling ranges collection for the current document. Page labeling ranges define the numbering style and prefix for consecutive page ranges.

Returns

PageLabelingRangeMap

pageLayout

Get Signature

get pageLayout(): PageLayout;

Gets or sets how the document should be displayed when opened.

Returns

PageLayout

Set Signature

set pageLayout(pageLayout): void;

Gets or sets how the document should be displayed when opened.

Parameters

pageLayout

PageLayout

Returns

void

pageMode

Get Signature

get pageMode(): PageMode;

Gets or sets how the document should be displayed when opened.

Returns

PageMode

Set Signature

set pageMode(pageMode): void;

Gets or sets how the document should be displayed when opened.

Parameters

pageMode

PageMode

Returns

void

pages

Get Signature

get pages(): PdfPageCollection;

Gets a PdfPageCollection with document pages.

Examples

for (const page of doc.pages)
{
    const ctx = page.context;
    ctx.drawText(...);
}

import JSZip from 'jszip';

const doc = PdfDocument.load(await Util.loadPdfAsArray("document.pdf"));
const coll = doc.pages;
const pageCount = coll.count;
const zip = new JSZip();

for (let num = 1; num <= pageCount; num++) {
    const page = coll.getAt(num - 1);
    const svgBytes: Uint8Array = page.saveAsSvg({ zoom: 2 });
    zip.file(`page${num}.svg`, svgBytes, { binary: true });
}

const zipBytes = await zip.generateAsync({ type: "uint8array" });
Util.saveFile("sample.zip", zipBytes, 'application/zip');

Returns

PdfPageCollection

pdfFontFormat

Get Signature

get pdfFontFormat(): PdfFontFormat;

Gets the format used to represent fonts in the current document. The default is PdfFontFormat.Type0AutoOneByteEncoding. Note that this property does not affect the 14 standard PDF fonts, those are always encoded as Type1.

Returns

PdfFontFormat

Set Signature

set pdfFontFormat(value): void;

Sets the format used to represent fonts in the current document. The default is PdfFontFormat.Type0AutoOneByteEncoding. Note that this property does not affect the 14 standard PDF fonts, those are always encoded as Type1.

Parameters

value

PdfFontFormat

Returns

void

pdfVersion

Get Signature

get pdfVersion(): string;

Gets the PDF Version of the document.

Returns

string

Set Signature

set pdfVersion(value): void;

Sets the PDF Version of the document.

Parameters

value

string

Returns

void

recognitionAlgorithm

Get Signature

get recognitionAlgorithm(): RecognitionAlgorithm;

Gets or sets the type of algorithm that is used for PDF content recognition when building page text maps.

This property affects the behavior of methods such as getText, findText and other APIs that rely on text maps.

Returns

RecognitionAlgorithm

Set Signature

set recognitionAlgorithm(value): void;

Gets or sets the type of algorithm that is used for PDF content recognition when building page text maps.

This property affects the behavior of methods such as getText, findText and other APIs that rely on text maps.

Parameters

value

RecognitionAlgorithm

Returns

void

security

Get Signature

get security(): Security;

Gets the Security object that manages security for the current document (passwords, etc).

Example

// load
const doc = PdfDocument.load(data);
...
// encrypt & save
doc.security.setEncryptOptions({
    ownerPassword: "abc",
    userPassword: "qwe",
    encryptionLevel: EncryptionLevel.AES256
});
const res: Uint8Array = doc.savePdf();

Returns

Security

securityStore

Get Signature

get securityStore(): DocumentSecurityStore;

Gets the DocumentSecurityStore object associated with this document.

Returns

DocumentSecurityStore

standardFontEmbedMode

Get Signature

get standardFontEmbedMode(): FontEmbedMode;

Gets or sets the font embedding mode for the 14 standard PDF fonts. The default is FontEmbedMode.NotEmbed. Note that if the PdfDocument is saved as PDF/A, and the value of this property is FontEmbedMode.NotEmbed, the standard fonts are embedded anyway using the FontEmbedMode.EmbedSubset mode.

Returns

Set Signature

set standardFontEmbedMode(value): void;

Parameters

value

Returns

void

structTreeRoot

Get Signature

get structTreeRoot(): StructTreeRoot;

Gets the StructTreeRoot object that represents the logical structure (the structure tree) of the document.

Returns

StructTreeRoot

viewerPreferences

Get Signature

get viewerPreferences(): ViewerPreferences;

Gets the collection of the current document outlines.

Returns

ViewerPreferences

willCloseAction

Get Signature

get willCloseAction(): ActionJavaScript;

Gets or sets a ActionJavaScript to be performed before closing the document.

Returns

| ActionJavaScriptProperties | ActionJavaScript

Set Signature

set willCloseAction(value): void;

Gets or sets a ActionJavaScript to be performed before closing the document.

Parameters

value

Returns

void

willPrintAction

Get Signature

get willPrintAction(): ActionJavaScript;

Gets or sets a ActionJavaScript to be performed before printing the document.

Returns

| ActionJavaScriptProperties | ActionJavaScript

Set Signature

set willPrintAction(value): void;

Gets or sets a ActionJavaScript to be performed before printing the document.

Parameters

value

Returns

void

willSaveAction

Get Signature

get willSaveAction(): ActionJavaScript;

Gets or sets a ActionJavaScript to be performed before saving the document.

Returns

| ActionJavaScriptProperties | ActionJavaScript

Set Signature

set willSaveAction(value): void;

Gets or sets a ActionJavaScript to be performed before saving the document.

Parameters

value

Returns

void

Methods

load()

Call Signature

static load(
   om, 
   data, 
   decryption?): PdfDocument;

Loads an existing PDF document from binary data using specified decryption options.

Parameters

om

Object manager that controls the lifetime of the PdfDocument.

data

Uint8Array

Binary data containing the PDF document

decryption?

PdfDecryptionOptions

Optional decryption options for password-protected documents

Returns

PdfDocument

A new instance of PdfDocument representing the loaded document

Throws

If the provided byte array contains invalid PDF data or the password is incorrect

Example

// Load a password-protected PDF
const pdfData = fs.readFileSync("protected.pdf");
const decryption = { password: "mysecret" };
const doc = PdfDocument.load(om, pdfData, decryption);

Call Signature

static load(data, decryption?): PdfDocument;

Loads an existing PDF document from binary data using specified decryption options.

Parameters

data

Uint8Array

Binary data containing the PDF document

decryption?

PdfDecryptionOptions

Optional decryption options for password-protected documents

Returns

PdfDocument

A new instance of PdfDocument representing the loaded document

Throws

If the provided byte array contains invalid PDF data or the password is incorrect

Example

// Load a password-protected PDF
const pdfData = fs.readFileSync("protected.pdf");
const decryption = { password: "mysecret" };
const doc = PdfDocument.load(pdfData, decryption);

Call Signature

static load(
   om, 
   data, 
   password?): PdfDocument;

Loads an existing PDF document from binary data using specified password.

Parameters

om

Object manager that controls the lifetime of the PdfDocument.

data

Uint8Array

Binary data containing the PDF document

password?

string

The optional password used to decrypt a document

Returns

PdfDocument

A new instance of PdfDocument representing the loaded document

Throws

If the provided byte array contains invalid PDF data or the password is incorrect

Example

// Load a password-protected PDF
const pdfData = fs.readFileSync("protected.pdf");
const doc = PdfDocument.load(om, pdfData, "mysecret");

Call Signature

static load(data, password?): PdfDocument;

Loads an existing PDF document from binary data using specified password.

Parameters

data

Uint8Array

Binary data containing the PDF document

password?

string

The optional password used to decrypt a document

Returns

PdfDocument

A new instance of PdfDocument representing the loaded document

Throws

If the provided byte array contains invalid PDF data or the password is incorrect

Example

// Load a password-protected PDF
const pdfData = fs.readFileSync("protected.pdf");
const doc = PdfDocument.load(pdfData, "mysecret");

Call Signature

static load(om, data): PdfDocument;

Loads an existing PDF document from binary data.

Parameters

om

Object manager that controls the lifetime of the PdfDocument.

data

Uint8Array

Binary data containing the PDF document

Returns

PdfDocument

A new instance of PdfDocument representing the loaded document

Throws

If the provided byte array contains invalid PDF data

Examples

// Load a PDF from file
const pdfData = fs.readFileSync("document.pdf");
const doc = PdfDocument.load(om, pdfData);

// Load from HTTP response
const response = await fetch("https://example.com/document.pdf");
const pdfData = new Uint8Array(await response.arrayBuffer());
const doc = PdfDocument.load(om, pdfData);

Call Signature

static load(data): PdfDocument;

Loads an existing PDF document from binary data.

Parameters

data

Uint8Array

Binary data containing the PDF document

Returns

PdfDocument

A new instance of PdfDocument representing the loaded document

Throws

If the provided byte array contains invalid PDF data

Examples

// Load a PDF from file
const pdfData = fs.readFileSync("document.pdf");
const doc = PdfDocument.load(pdfData);

// Load from HTTP response
const response = await fetch("https://example.com/document.pdf");
const pdfData = new Uint8Array(await response.arrayBuffer());
const doc = PdfDocument.load(pdfData);

addEmbeddedFile()

addEmbeddedFile(key, item): void;

Adds the binary data as an embedded file to the PDF document.

Parameters

key

string

item

| Uint8Array<ArrayBufferLike> | FileSpecification | FileSpecificationProperties

The FileSpecProperties object defining properties of embedded file.

Returns

void

Example

const doc = new PdfDocument();

const pngFile = await Util.loadImageAsArray("cars.png");
doc.addEmbeddedFile("cars.png", {
    fileName: "cars.png",
    desc: "My car from the dream.",
    stream: {
        data: pngFile,
        mimeType: "image/png",
        creationDate: new Date('2019/12/01'),
        modificationDate: new Date('2020/04/19')
    }
});

const jpgFile = await Util.loadImageAsArray("tudor.jpg");
doc.addEmbeddedFile("tudor.jpg", {
    fileName: "tudor.jpg",
    desc: "The house to buy.",
    stream: {
        data: jpgFile,
        mimeType: "image/jpeg",
        creationDate: new Date('2022/12/01'),
        modificationDate: new Date('2023/04/19')
    }
});

Util.saveFile("embeddedFiles.pdf", doc.savePdf(), 'application/pdf');

clear()

clear(): void;

Clears the document, removing all content and resetting all properties and settings to their initial default values.

Returns

void

deleteText()

deleteText(
   findTextParams, 
   deleteTextMode, 
   searchRange?): void;

Deletes a specified text from all pages of the current document.

Note that the results may be affected by the current value of the RecognitionAlgorithm property.

Parameters

findTextParams

FindTextParams

The text to search for.

deleteTextMode

DeleteTextMode

The text delete mode.

searchRange?

OutputRange

The search scope.

Returns

void

exportFormDataToFDF()

exportFormDataToFDF(options?): Uint8Array;

Exports the document's form data to a stream in FDF format.

Parameters

options?

ExportFormDataOptions

The export options.

Returns

Uint8Array

findText()

findText(findTextParams, searchRange?): FoundPosition[];

Searches for all occurrences of a text in a range of the document's pages.

Note that the results may be affected by the current value of the RecognitionAlgorithm property.

Parameters

findTextParams

FindTextParams

The text searching parameters.

searchRange?

OutputRange

The search scope.

Returns

FoundPosition[]

free()

free(): void;

Detaches the object from the ObjectManager and deallocates its memory, if possible.

Returns

void

Inherited from

ObjectBase.free

getFonts()

getFonts(): PdfFont[];

Gets the list of fonts in this PdfDocument.

Returns

PdfFont[]

The list of fonts present in this document.

Examples

// List the fonts used in a PDF document together with their properties
const fs = require("fs");
const { connectDsPdf, ObjectManager, PdfDocument, PdfFontType0 } = require("@mescius/ds-pdf");

async function listFonts() {
  await connectDsPdf();
  using om = new ObjectManager();
  const doc = PdfDocument.load(om, fs.readFileSync("existing.pdf"));

  for (const font of doc.getFonts()) {
    const { fontFamily, fontWeight, fontItalic } = font.getFontAttributes();
    console.log(`/${font.baseFont}: family=${fontFamily}, weight=${fontWeight}, ` +
      `italic=${fontItalic}, embedded=${font.isEmbedded}`);

    // For composite (Type0) fonts the actual font data lives in the descendant CIDFont:
    if (font instanceof PdfFontType0)
      console.log(`  descendant CIDFont: /${font.descendantFont?.baseFont}`);
  }
}

// Reduce the file size by removing the embedded font data
// (viewers will render text using matching system fonts instead)
async function removeEmbeddedFonts() {
  await connectDsPdf();
  using om = new ObjectManager();
  const doc = PdfDocument.load(om, fs.readFileSync("existing.pdf"));

  for (const font of doc.getFonts()) {
    if (font.isEmbedded)
      font.removeEmbeddedData(doc);
  }

  fs.writeFileSync("fonts-not-embedded.pdf", doc.savePdf());
}

getText()

getText(): string;

Extracts and returns all text from the current document.

Returns

string

importFormDataFromFDF()

importFormDataFromFDF(fdfData): void;

Imports the document's form data from a stream in FDF format.

Parameters

fdfData

Uint8Array

The data in FDF format.

Returns

void

mergeWithDocument()

mergeWithDocument(sourceDoc, options?): void;

Merges all or some pages from a specified PdfDocument into the current document.

Parameters

sourceDoc

PdfDocument

The source document which is to be merged into the current document.

options?

MergeDocumentOptions

The options controlling what and how to merge.

Returns

void

Example

const doc = PdfDocument.load(data);
const doc2 = PdfDocument.load(data2);
doc.mergeWithDocument(doc2, { index: 1, range: { fromPage: 2, toPage: 5 } });
const res: Uint8Array = doc.savePdf();

newPage()

newPage(): PdfPage;

Adds a blank PdfPage to the document.

Returns

PdfPage

newPageContext()

newPageContext(options?): PdfContext;

Adds a new PdfPage to the document and returns its drawing context.

Parameters

options?

PdfPageContextOptions

The options for adding a new page and creating a PdfContext object.

Returns

PdfContext

A PdfContext object for the new page.

Example

const doc = new PdfDocument();
const ctx = doc.newPageContext({ width: 500, height: 700 });
ctx.drawRect(50, 50, 200, 500, {
    radius: 10,
    lineColor: "Red",
    lineWidth: 10
});
const res: Uint8Array = doc.savePdf();

rebind()

rebind(omTo): void;

Rebinds the object from the current ObjectManager to the specified one.

Parameters

omTo