Class PdfDocument

Represents a PDF document that can be created from scratch or loaded from existing data. Provides methods for creating, loading, and manipulating PDF documents.

Example

// Create a new PDF document
const { connectDsPdf, ObjectManager, PdfDocument } = require("@mescius/ds-pdf");

async function createNewPdf() {
  await connectDsPdf();
  const om = new ObjectManager();  
  const doc = new PdfDocument(om);
  
  for (let p = 0; p < 10; p++) {
    doc.pages.addNew();
  }
  
  const pdfData = doc.savePdf();
  fs.writeFileSync("new-document.pdf", pdfData);
  om.dispose();
}

Example

// Load an existing PDF document
async function loadExistingPdf() {
  await connectDsPdf();
  using om = new ObjectManager();
  const pdfBytes = fs.readFileSync("existing.pdf");
  
  const doc = PdfDocument.load(om, pdfBytes);
  // Work with the loaded document...
}

Example

// Load a password-protected PDF
async function loadProtectedPdf() {
  await connectDsPdf();
  pushObjectManager();
  const pdfBytes = fs.readFileSync("protected.pdf");
  
  const decryptionOptions = { password: "secret123" };
  const doc = PdfDocument.load(pdfBytes, decryptionOptions);
  // Work with the loaded document...
  popObjectManager();
}

Hierarchy (View Summary)

ObjectBase
- PdfDocument

Constructors

constructor

new PdfDocument(om: ObjectManager, options?: PdfDocumentOptions): PdfDocument
Creates a new PDF document instance.
Parameters
- om: ObjectManager
  ObjectManager that controls the object lifetime
- Optionaloptions: PdfDocumentOptions
  Creation options for new documents (optional)
Returns PdfDocument
Example
```
// Create empty document
const doc1 = new PdfDocument(om);
```
Example
```
// Create document with options
const options = { compressionLevel: "Optimal", conformanceLevel: "PdfA1a" };
const doc2 = new PdfDocument(om, options);
```
Overrides ObjectBase.constructor
new PdfDocument(options?: PdfDocumentOptions): PdfDocument
Creates a new PDF document instance.
Parameters
- Optionaloptions: PdfDocumentOptions
  Creation options for new documents (optional)
Returns PdfDocument
Example
```
// Create empty document
const doc1 = new PdfDocument();
```
Example
```
// Create document with options
const options = { compressionLevel: "Optimal", conformanceLevel: "PdfA1a" };
const doc2 = new PdfDocument(options);
```
Overrides ObjectBase.constructor

Accessors

acroForm

get acroForm(): AcroForm
Gets the AcroForm object defining common properties of the AcroForms in this document.

Returns AcroForm

compressionLevel

get compressionLevel(): CompressionLevel
Gets or sets the compression level. Default value is CompressionLevel#Fastest.

Returns CompressionLevel
set compressionLevel(value: CompressionLevel): void
Gets or sets the compression level. Default value is CompressionLevel#Fastest.
Parameters
- value: CompressionLevel
Returns void

didPrintAction

get didPrintAction(): ActionJavaScript | null
Gets or sets a ActionJavaScript to be performed after printing the document.

Returns ActionJavaScript | null
set didPrintAction(
value: ActionJavaScriptProperties | ActionJavaScript | null,
): void
Gets or sets a ActionJavaScript to be performed after printing the document.
Parameters
- value: ActionJavaScriptProperties | ActionJavaScript | null
Returns void

didSaveAction

get didSaveAction(): ActionJavaScript | null
Gets or sets a ActionJavaScript to be performed after saving the document.

Returns ActionJavaScript | null
set didSaveAction(
value: ActionJavaScriptProperties | ActionJavaScript | null,
): void
Gets or sets a ActionJavaScript to be performed after saving the document.
Parameters
- value: ActionJavaScriptProperties | ActionJavaScript | null
Returns void

documentInfo

get documentInfo(): DocumentInfo | null
Gets or sets the DocumentInfo object that contains information about this document (author, title, etc).

Returns DocumentInfo | null

set documentInfo(docInfo: DocumentInfo | DocumentInfoProperties | null): void

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

Parameters

docInfo: DocumentInfo | DocumentInfoProperties | null

Returns void

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();

embeddedFiles

get embeddedFiles(): FileSpecificationMap
Gets the dictionary of document level file attachments.

Returns FileSpecificationMap

fileID

get fileID(): FileID | null
Gets or sets the FileID object defining ID of this PDF document. Note that this ID is automatically updated if the clear method is called.

Returns FileID | null
set fileID(value: FileID | null): void
Gets or 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 | null
Returns void

fontCollection

get fontCollection(): FontCollection | null
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 | null
set fontCollection(coll: FontCollection | null): 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 | null
Returns void

fontEmbedMode

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 FontEmbedMode
set fontEmbedMode(value: FontEmbedMode): void
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.
Parameters
- value: FontEmbedMode
Returns void

fontHandlers

get fontHandlers(): FontHandlerCollection
Gets the collection of font handlers associated with the current document.

Returns FontHandlerCollection

id

get id(): number
Gets the reference to the object.

Returns number
Inherited from ObjectBase.id

imageHandlers

get imageHandlers(): PdfImageHandlerCollection
Gets the collection of PdfImageHandler objects associated with the current document.

Returns PdfImageHandlerCollection

imageOptions

get imageOptions(): ImageOptions
Gets or sets the ImageOptions object that contains options controlling how images are processed in the current document.

Returns ImageOptions
set imageOptions(value: ImageOptions): void
Gets or sets the ImageOptions object that contains options controlling how images are processed in the current document.
Parameters
- value: ImageOptions
Returns void

isNewPdf

get isNewPdf(): boolean
Gets a value indicating if the PDF document was created from scratch.

Returns boolean

javaScripts

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

linearized

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

Returns boolean

metadata

get metadata(): Metadata | null
Gets or sets the metadata associated with this document.

Returns Metadata | null
set metadata(meta: Metadata | MetadataProperties | null): void
Gets or sets the metadata associated with this document.
Parameters
- meta: Metadata | MetadataProperties | null
Returns void

namedDestinations

get namedDestinations(): DocumentDestinations
Gets the dictionary of named destinations defined in the current document.

Returns DocumentDestinations

om

get om(): ObjectManager
Gets the owner ObjectManager instance.

Returns ObjectManager
Inherited from ObjectBase.om

openAction

get openAction(): DocAction | null
Gets or sets a DocAction to be displayed or performed when the document is opened.

Returns DocAction | null
set openAction(value: DocAction | DocActionProperties | null): void
Gets or sets a DocAction to be displayed or performed when the document is opened.
Parameters
- value: DocAction | DocActionProperties | null
Returns void

outlines

get outlines(): OutlineNodeCollection
Gets the collection of the current document outlines.

Returns OutlineNodeCollection

pages

get pages(): PdfPageCollection

Gets a PdfPageCollection with document pages.

Returns PdfPageCollection

Example

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

Example

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');

pdfFontFormat

get pdfFontFormat(): PdfFontFormat
Gets or 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.

Returns PdfFontFormat
set pdfFontFormat(value: PdfFontFormat): void
Gets or 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 pdfVersion(): string
Gets the PDF Version of the document.

Returns string

recognitionAlgorithm

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 recognitionAlgorithm(value: RecognitionAlgorithm): 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 security(): Security

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

Returns Security

Example

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

standardFontEmbedMode

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 FontEmbedMode
set standardFontEmbedMode(value: FontEmbedMode): void
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.
Parameters
- value: FontEmbedMode
Returns void

willCloseAction

get willCloseAction(): ActionJavaScript | null
Gets or sets a ActionJavaScript to be performed before closing the document.

Returns ActionJavaScript | null
set willCloseAction(
value: ActionJavaScriptProperties | ActionJavaScript | null,
): void
Gets or sets a ActionJavaScript to be performed before closing the document.
Parameters
- value: ActionJavaScriptProperties | ActionJavaScript | null
Returns void

willPrintAction

get willPrintAction(): ActionJavaScript | null
Gets or sets a ActionJavaScript to be performed before printing the document.

Returns ActionJavaScript | null
set willPrintAction(
value: ActionJavaScriptProperties | ActionJavaScript | null,
): void
Gets or sets a ActionJavaScript to be performed before printing the document.
Parameters
- value: ActionJavaScriptProperties | ActionJavaScript | null
Returns void

willSaveAction

get willSaveAction(): ActionJavaScript | null
Gets or sets a ActionJavaScript to be performed before saving the document.

Returns ActionJavaScript | null
set willSaveAction(
value: ActionJavaScriptProperties | ActionJavaScript | null,
): void
Gets or sets a ActionJavaScript to be performed before saving the document.
Parameters
- value: ActionJavaScriptProperties | ActionJavaScript | null
Returns void

Methods

`Static`load

load(
    om: ObjectManager,
    data: Uint8Array,
    decryption?: PdfDecryptionOptions,
): PdfDocument
Loads an existing PDF document from binary data using specified decryption options.
Parameters
- om: ObjectManager
  Object manager that controls the lifetime of the PdfDocument.
- data: Uint8Array
  Binary data containing the PDF document
- Optionaldecryption: 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);
```
load(data: Uint8Array, decryption?: PdfDecryptionOptions): PdfDocument
Loads an existing PDF document from binary data using specified decryption options.
Parameters
- data: Uint8Array
  Binary data containing the PDF document
- Optionaldecryption: 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);
```
load(om: ObjectManager, data: Uint8Array, password?: string): PdfDocument
Loads an existing PDF document from binary data using specified password.
Parameters
- om: ObjectManager
  Object manager that controls the lifetime of the PdfDocument.
- data: Uint8Array
  Binary data containing the PDF document
- Optionalpassword: 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");
```
load(data: Uint8Array, password?: string): PdfDocument
Loads an existing PDF document from binary data using specified password.
Parameters
- data: Uint8Array
  Binary data containing the PDF document
- Optionalpassword: 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");
```
load(om: ObjectManager, data: Uint8Array): PdfDocument
Loads an existing PDF document from binary data.
Parameters
- om: ObjectManager
  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
Example
```
// Load a PDF from file
const pdfData = fs.readFileSync("document.pdf");
const doc = PdfDocument.load(om, pdfData);
```
Example
```
// 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);
```

load(data: Uint8Array): 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

Example

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

Example

// 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: string,
    item:
        | Uint8Array<ArrayBufferLike>
        | FileSpecificationProperties
        | FileSpecification,
): void

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

Parameters

key: string
item: Uint8Array<ArrayBufferLike> | FileSpecificationProperties | FileSpecification
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: FindTextParams,
    deleteTextMode: DeleteTextMode,
    searchRange?: OutputRange,
): 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.
- OptionalsearchRange: OutputRange
  The search scope.
Returns void

exportFormDataToFDF

exportFormDataToFDF(options?: ExportFormDataOptions): Uint8Array
Exports the document's form data to a stream in FDF format.
Parameters
- Optionaloptions: ExportFormDataOptions
  The export options.
Returns Uint8Array

findText

findText(
findTextParams: FindTextParams,
searchRange?: OutputRange,
): FoundPosition[] | null
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.
- OptionalsearchRange: OutputRange
  The search scope.
Returns FoundPosition[] | null

free

free(): void
Detaches the object from the ObjectManager and deallocates its memory, if possible.

Returns void
Inherited from ObjectBase.free

getText

getText(): string
Extracts and returns all text from the current document.

Returns string

importFormDataFromFDF

importFormDataFromFDF(fdfData: Uint8Array): 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: PdfDocument,
options?: MergeDocumentOptions | null,
): 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.
- Optionaloptions: MergeDocumentOptions | null
  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?: PdfPageContextOptions): PdfContext
Adds a new PdfPage to the document and returns its drawing context.
Parameters
- Optionaloptions: 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: ObjectManager): void
Rebinds the object from the current ObjectManager to the specified one.
Parameters
- omTo: ObjectManager
  The new ObjectManager for the object.
Returns void
Inherited from ObjectBase.rebind

redact

redact(options?: RedactOptions): void
Applies all RedactAnnotations to the current document.
Parameters
- Optionaloptions: RedactOptions
  Specifies the additional redact options.
Returns void
redact(annotations: RedactAnnotation[], options?: RedactOptions): void
Applies a list of specified RedactAnnotations to the current document.
Parameters
- annotations: RedactAnnotation[]
  The array of RedactAnnotation objects to apply.
- Optionaloptions: RedactOptions
  Specifies the additional redact options.
Returns void

replaceText

replaceText(
    findTextParams: FindTextParams,
    newText: string,
    searchRange?: OutputRange,
    font?: Font | null,
    fontSize?: number | null,
): void
Replaces a specified text on 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.
- newText: string
  The replacement text.
- OptionalsearchRange: OutputRange
  The search scope.
- Optionalfont: Font | null
  The font to use on 'newText', if null the current font will be used.
- OptionalfontSize: number | null
  The font size to use on 'newText', if null the current font size will be used.
Returns void

saveOriginalPdf

saveOriginalPdf(): Uint8Array
Saves the original (unmodified) PdfDocument to a byte array.

Returns Uint8Array
A byte array with original PDF document data.

savePdf

savePdf(options?: SavePdfOptions): Uint8Array
Saves the current PdfDocument to a byte array.
Parameters
- Optionaloptions: SavePdfOptions
  The options for saving a PDF document.
Returns Uint8Array
A byte array with PDF document data.

Class PdfDocument

Example

Example

Example

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns PdfDocument

Example

Example

Parameters

Returns PdfDocument

Example

Example

Accessors

acroForm

Returns AcroForm

compressionLevel

Returns CompressionLevel

Parameters

Returns void

didPrintAction

Returns ActionJavaScript | null

Parameters

Returns void

didSaveAction

Returns ActionJavaScript | null

Parameters

Returns void

documentInfo

Returns DocumentInfo | null

Parameters

Returns void

Example

embeddedFiles

Returns FileSpecificationMap

fileID

Returns FileID | null

Parameters

Returns void

fontCollection

Returns FontCollection | null

Parameters

Returns void

fontEmbedMode

Returns FontEmbedMode

Parameters

Returns void

fontHandlers

Returns FontHandlerCollection

id

Returns number

imageHandlers

Returns PdfImageHandlerCollection

imageOptions

Returns ImageOptions

Parameters

Returns void

isNewPdf

Returns boolean

javaScripts

Returns ActionJavaScriptMap

linearized

Returns boolean

metadata

Returns Metadata | null

Parameters

Returns void

namedDestinations

Returns DocumentDestinations

om

Returns ObjectManager

openAction

Returns DocAction | null

Parameters

`Static`load