Class PdfDocument

Represents a PDF document. Allows: loading, editing, manipulating, merging, signing printing and saving PDFs.

Remark

Make sure that you call close or cleanUp to free the memory, when you stop using the PdfDocument object.

Hierarchy

PdfDocument

Constructors

constructor

new PdfDocument(pdfInput?, password?): PdfDocument
Create a PdfDocument object from a PdfInput For more specific way to create/open PdfDocment see fromUrl fromZip fromHtml fromImage open
Parameters
- Optional pdfInput: PdfInput
  
  see PdfInput (required)
- Optional password: PdfPassword
  
  a password to open the PDF required if PDF file was protected (pdfInput is PdfFilePath or Buffer)
Returns PdfDocument
- Defined in public/pdfDocument.ts:126

Properties

`Private` `Optional` pdfDocumentId

pdfDocumentId?: string

Internal PDF document ID

`Private` `Optional` pdfPassword

pdfPassword?: PdfPassword

`Private` `Optional` `Readonly` promiseDocumentId

promiseDocumentId?: Promise<string>

Methods

addBackgroundFromAnotherPdf

addBackgroundFromAnotherPdf(fromPdf, sourcePageIndex?, applyToPages?): Promise<void>
Adds a background to each page of this PDF. The background is copied from a first page in the backgroundPdf document.
Parameters
- fromPdf: PdfDocument
  
  background PDF document
- sourcePageIndex: number = 0
  
  Index (zero-based page number) of the page to copy from the Background/Foreground PDF. Default is 0.
- Optional applyToPages: PdfPageSelection
  
  PageSelection to which the background/foreground will be added. Default is "all"
Returns Promise<void>
- Defined in public/pdfDocument.ts:987

addForegroundFromAnotherPdf

addForegroundFromAnotherPdf(fromPdf, sourcePageIndex?, applyToPages?): Promise<void>
Adds a foreground to each page of this PDF. The background is copied from a first page in the backgroundPdf document.
Parameters
- fromPdf: PdfDocument
  
  foreground PDF document
- sourcePageIndex: number = 0
  
  Index (zero-based page number) of the page to copy from the Background/Foreground PDF. Default is 0.
- Optional applyToPages: PdfPageSelection
  
  PageSelection to which the background/foreground will be added. Default is "all"
Returns Promise<void>
- Defined in public/pdfDocument.ts:1009

addHtmlFooter

addHtmlFooter(footer, toPages?): Promise<void>
Apply HTML footer on top of an existing Pdf.
Parameters
- footer: HtmlAffix
  
  HtmlAffix
- Optional toPages: PdfPageSelection
  
  PdfPageSelection
Returns Promise<void>
- Defined in public/pdfDocument.ts:876

addHtmlHeader

addHtmlHeader(header, toPages?): Promise<void>
Apply HTML header on top of an existing Pdf.
Parameters
- header: HtmlAffix
  
  HtmlAffix
- Optional toPages: PdfPageSelection
  
  PdfPageSelection
Returns Promise<void>
- Defined in public/pdfDocument.ts:864

addOrUpdateMetadata

addOrUpdateMetadata(key, value): Promise<void>
Add or Update a single metadata property
Parameters
- key: string
- value: string
Returns Promise<void>
- Defined in public/pdfDocument.ts:777

addTextFooter

addTextFooter(footer, toPages?): Promise<void>
Apply page footer on top of an existing Pdf.
Parameters
- footer: TextAffix
  
  TextAffix
- Optional toPages: PdfPageSelection
  
  PdfPageSelection
Returns Promise<void>
- Defined in public/pdfDocument.ts:852

addTextHeader

addTextHeader(header, toPages?): Promise<void>
Apply page header on top of an existing Pdf.
Parameters
- header: TextAffix
  
  TextAffix
- Optional toPages: PdfPageSelection
  
  PdfPageSelection
Returns Promise<void>
- Defined in public/pdfDocument.ts:840

appendAnotherPdf

appendAnotherPdf(fromPdfDocument): Promise<void>
Appends another PDF to the end of the current If AnotherPdfFile contains form fields, those fields will be appended with '' in the resulting PDF. e.g. 'Name' will be 'Name'
Parameters
- fromPdfDocument: PdfDocument
  
  PdfDocument to Append
Returns Promise<void>
- Defined in public/pdfDocument.ts:570

close

close(): Promise<void>
Dispose this PdfDocument object (clean up the resource) This is necessary to free the memory used by PdfDocument. See cleanUp Once this method was called this PdfDocument object no longer usable.

Returns Promise<void>
- Defined in public/pdfDocument.ts:180

compressSize

compressSize(imageQuality, scaleToVisibleSize?): Promise<void>
Compress existing PDF images using JPG encoding and the specified settings
Parameters
- imageQuality: number
  
  Quality (1 - 100) to use during compression
- scaleToVisibleSize: boolean = false
  
  Scale down the image resolution according to its visible size in the PDF document
Returns Promise<void>
- Defined in public/pdfDocument.ts:488

convertToPdfA

convertToPdfA(customICC?): Promise<void>
Convert the current document into the specified PDF-A standard format
Parameters
- Optional customICC: string
  
  (Optional) Custom color profile file path
Returns Promise<void>
- Defined in public/pdfDocument.ts:751

convertToPdfUA

convertToPdfUA(): Promise<void>
Convert the current document into the specified PDF/UA standard format

Returns Promise<void>
- Defined in public/pdfDocument.ts:758

duplicate

duplicate(pages?): Promise<PdfDocument>
Creates a new PDF by copying a range of pages from this PdfDocument.
Parameters
- pages: PdfPageSelection = "all"
  
  pages to copy (default "all")
Returns Promise<PdfDocument>
- Defined in public/pdfDocument.ts:606

extractRawImages

extractRawImages(options?): Promise<Buffer[]>
Finds all embedded Images from within a specified pages in the PDF and returns them as Buffer
Parameters
- Optional options: {
  fromPages: PdfPageSelection;
  }
  
  including PdfPageSelection
  - fromPages: PdfPageSelection
    Default
    "all"
Returns Promise<Buffer[]>
- Defined in public/pdfDocument.ts:623

extractText

extractText(onPages?): Promise<string>
Parameters
- Optional onPages: PdfPageSelection
Returns Promise<string>
- Defined in public/pdfDocument.ts:738

`Private` getId

getId(): Promise<string>
Private
Returns Promise<string>
- Defined in public/pdfDocument.ts:187

getMetadata

getMetadata(): Promise<Map<string, string>>
Gets a Map<string, string> of metadata properties

Returns Promise<Map<string, string>>
- Defined in public/pdfDocument.ts:768

getPageCount

getPageCount(): Promise<number>
Gets the number of pages in the PdfDocument.

Returns Promise<number>
- Defined in public/pdfDocument.ts:516

getPagesInfo

getPagesInfo(): Promise<PageInfo[]>
Gets information of all pages in the PdfDocument

Returns Promise<PageInfo[]>
- Defined in public/pdfDocument.ts:509

getPermission

getPermission(): Promise<PdfPermission>
Gets the current permissions of this PdfDocument

Returns Promise<PdfPermission>
PdfPermission
- Defined in public/pdfDocument.ts:1077

insertPagesFromAnotherPdf

insertPagesFromAnotherPdf(fromPdfDocument, insertAtPageIndex): Promise<void>
Inserts another PDF into the current PdfDocument, starting at a given Page Index. If AnotherPdfFile contains form fields, those fields will be appended with '' in the resulting PDF. e.g. 'Name' will be 'Name'
Parameters
- fromPdfDocument: PdfDocument
  
  Another PdfDocument
- insertAtPageIndex: number
  
  Index at which to insert the new content. Note: Page 1 has index 0...
Returns Promise<void>
- Defined in public/pdfDocument.ts:583

isSigned

isSigned(): Promise<boolean>
Check if PdfDocument was signed or not

Returns Promise<boolean>
- Defined in public/pdfDocument.ts:820

makePdfDocumentReadOnly

makePdfDocumentReadOnly(ownerPassword): Promise<void>
Makes this PDF document read only such that: Content is encrypted at 128 bit. Copy and paste of content is disallowed. Annotations and form editing are disabled.
Parameters
- ownerPassword: string
  
  The owner password for the PDF. A string for owner password is required to enable PDF encryption and all document security options.
Returns Promise<void>
- Defined in public/pdfDocument.ts:1087

overrideMetadata

overrideMetadata(newMetadataDictionary): Promise<void>
Sets a whole metadata properties Map<string, string> (override all the metadata property)
Parameters
- newMetadataDictionary: Map<string, string>
  
  new metadata properties Map<string, string>
Returns Promise<void>
- Defined in public/pdfDocument.ts:796

prependAnotherPdf

prependAnotherPdf(fromPdfDocument): Promise<void>
Adds another PDF to the beginning of the current PdfDocument If AnotherPdfFile contains form fields, those fields will be appended with '' in the resulting PDF. e.g. 'Name' will be 'Name'
Parameters
- fromPdfDocument: PdfDocument
  
  PdfDocument to prepend
Returns Promise<void>
- Defined in public/pdfDocument.ts:559

rasterizeToImageBuffers

rasterizeToImageBuffers(options?): Promise<Buffer[]>
Renders the PDF and exports image Files in convenient formats. 1 image file is created for each page.
Parameters
- Optional options: {
  fromPages: PdfPageSelection;
  imageType?: ImageType;
  }
  
  including PdfPageSelection ImageType
  - fromPages: PdfPageSelection
    Default
    "all"
  - Optional imageType?: ImageType
    Default
    {@link ImageType.PNG}
Returns Promise<Buffer[]>
array of images as Buffer[]
- Defined in public/pdfDocument.ts:643

rasterizeToImageFiles

rasterizeToImageFiles(filePath, options?): Promise<string[]>
Renders the PDF and exports image Files in convenient formats. 1 image file is created for each page. Running number will append output file path.
Parameters
- filePath: string
  
  output file path.
- Optional options: {
  fromPages?: PdfPageSelection;
  type?: ImageType;
  }
  
  including PdfPageSelection ImageType
  - Optional fromPages?: PdfPageSelection
    Default
    "all"
  - Optional type?: ImageType
    Default
    {@link ImageType.PNG}
Returns Promise<string[]>
array of images file name as string[]
- Defined in public/pdfDocument.ts:687

removeMetadata

removeMetadata(key): Promise<void>
Remove a single metadata property
Parameters
- key: string
Returns Promise<void>
- Defined in public/pdfDocument.ts:788

removePage

removePage(pages): Promise<void>
Removes a range of pages from the PDF
Parameters
- pages: PdfPageSelection
  
  pages to remove
Returns Promise<void>
- Defined in public/pdfDocument.ts:598

removePasswordsAndEncryption

removePasswordsAndEncryption(): Promise<void>
Removes all user and owner password security for a PDF document. Also disables content encryption. If content is encrypted at 128 bit, copy and paste of content, annotations and form editing may be disabled.

Returns Promise<void>
- Defined in public/pdfDocument.ts:1031

replaceText

replaceText(oldText, newText, onPages?): Promise<void>
Replace the specified old text with new text on a given page
Parameters
- oldText: string
  
  Old text to remove
- newText: string
  
  New text to add
- Optional onPages: PdfPageSelection
  
  Page index to search for old text to replace (default "all")
Returns Promise<void>
- Defined in public/pdfDocument.ts:730

resize

resize(newSize, options?): Promise<void>
Resize a page to the specified dimensions
Parameters
- newSize: PdfPaperSize
  
  PdfPaperSize
- Optional options: {
  PdfPageSelection?: PdfPageSelection;
  }
  
  including PdfPageSelection
  - Optional PdfPageSelection?: PdfPageSelection
    Default
    "all"
Returns Promise<void>
- Defined in public/pdfDocument.ts:542

saveAs

saveAs(filePath, saveOptions?): Promise<void>
Saves the PdfDocument to a file.
Parameters
- filePath: string
  
  Target file path
- Optional saveOptions: SaveOptions
  
  see SaveOptions
Returns Promise<void>
- Defined in public/pdfDocument.ts:464

saveAsBuffer

saveAsBuffer(saveOptions?): Promise<Buffer>
Saves the PdfDocument to a binary (Buffer)
Parameters
- Optional saveOptions: SaveOptions
  
  see SaveOptions
Returns Promise<Buffer>
- Defined in public/pdfDocument.ts:476

setOwnerPassword

setOwnerPassword(ownerPassword): Promise<void>
Sets the owner password and enables 128Bit encryption of PDF content. An owner password is one used to enable and disable all other security settings. OwnerPassword must be set to a non-empty string value for AllowAccessibilityExtractContent , AllowAnnotations , AllowFillForms, AllowPrint, AllowModify to be restricted.
Parameters
- ownerPassword: string
Returns Promise<void>
- Defined in public/pdfDocument.ts:1056

setPermission

setPermission(permissions): Promise<void>
Sets the permissions of this PdfDocument
Parameters
- permissions: PdfPermission
  
  see PdfPermission
Returns Promise<void>
- Defined in public/pdfDocument.ts:1070

setRotation

setRotation(pageRotation, options?): Promise<void>
Set the page orientation.
Parameters
- pageRotation: PageRotation
  
  see PageRotation
- Optional options: {
  pdfPageSelection?: PdfPageSelection;
  }
  
  including PdfPageSelection
  - Optional pdfPageSelection?: PdfPageSelection
    Default
    "all"
Returns Promise<void>
- Defined in public/pdfDocument.ts:525

setUserPassword

setUserPassword(userPassword): Promise<void>
Sets the user password and enables 128Bit encryption of PDF content. A user password is a password that each user must enter to open or print the PDF document.
Parameters
- userPassword: string
Returns Promise<void>
- Defined in public/pdfDocument.ts:1039

signDigitalSignature

signDigitalSignature(signature): Promise<void>
Sign PDF with digital signature certificate. Note that the PDF will not be fully signed until Saved using saveAs or saveAsBuffer

Multiple certificates may be used.
Parameters
- signature: DigitalSignature
  
  see DigitalSignature
Returns Promise<void>
- Defined in public/pdfDocument.ts:813

signatureCount

signatureCount(): Promise<number>
Count the number signature that signed to this PdfDocument

Returns Promise<number>
- Defined in public/pdfDocument.ts:828

stampBarcode

stampBarcode(barcodeValue, options?): Promise<void>
Edits the PDF by applying the barcode to only selected page(s).
Parameters
- barcodeValue: string
  
  barcode
- Optional options: {
      barcodeEncoding: BarcodeType;
      options?: BarcodeStampOptions;
      toPages?: PdfPageSelection;
  }
  
  including BarcodeType HtmlStampOptions PdfPageSelection
  - barcodeEncoding: BarcodeType
  - Optional options?: BarcodeStampOptions
  - Optional toPages?: PdfPageSelection
Returns Promise<void>
- Defined in public/pdfDocument.ts:957

stampHtml

stampHtml(htmlStringOrHtmlFilePath, options?): Promise<void>
Edits the PDF by applying the HTML's rendered to only selected page(s).
Parameters
- htmlStringOrHtmlFilePath: string
- Optional options: {
  htmlStampOptions?: HtmlStampOptions;
  toPages?: PdfPageSelection;
  }
  
  including HtmlStampOptions PdfPageSelection
  - Optional htmlStampOptions?: HtmlStampOptions
  - Optional toPages?: PdfPageSelection
Returns Promise<void>
- Defined in public/pdfDocument.ts:891

stampImage

stampImage(image, options?): Promise<void>
Edits the PDF by applying the image to only selected page(s).
Parameters
- image: string | Buffer
  
  image file path or image buffer
- Optional options: {
  imageStampOptions?: BaseStampOptions;
  toPages?: PdfPageSelection;
  }
  
  including HtmlStampOptions PdfPageSelection
  - Optional imageStampOptions?: BaseStampOptions
  - Optional toPages?: PdfPageSelection
Returns Promise<void>
- Defined in public/pdfDocument.ts:916

stampText

stampText(text, options?): Promise<void>
Edits the PDF by applying the text to only selected page(s).
Parameters
- text: string
  
  text to stamp
- Optional options: {
  imageStampOptions?: TextStampOptions;
  toPages?: PdfPageSelection;
  }
  
  including HtmlStampOptions PdfPageSelection
  - Optional imageStampOptions?: TextStampOptions
  - Optional toPages?: PdfPageSelection
Returns Promise<void>
- Defined in public/pdfDocument.ts:938

`Static` fromFile

fromFile(pdfFilePath): Promise<PdfDocument>
Open a PdfDocument from .pdf file
Parameters
- pdfFilePath: string
  
  A path to .pdf file
Returns Promise<PdfDocument>
- Defined in public/pdfDocument.ts:303

`Static` fromHtml

fromHtml(htmlStringOrHtmlFilePath, options?): Promise<PdfDocument>
Creates a PDF file from a Html string, and returns it as an PdfDocument object which can be edited and saved to disk or served on a website.
Parameters
- htmlStringOrHtmlFilePath: string
  
  The Html to be rendered as a PDF.
- Optional options: {
  renderOptions?: ChromePdfRenderOptions;
  }
  
  including ChromePdfRenderOptions
  - Optional renderOptions?: ChromePdfRenderOptions
    
    Apply renderOptions if PdfInput is a HtmlString or HtmlFilePath or ZipFilePath or Url}
    
    Default
    undefined
Returns Promise<PdfDocument>
- Defined in public/pdfDocument.ts:363

`Static` fromImage

fromImage(images, options?): Promise<PdfDocument>
Converts multiple image files to a PDF document. Each image creates 1 page which matches the image dimensions. The default PaperSize is A4. You can set it via ImageToPdfConverter.PaperSize. Note: Imaging.ImageBehavior.CropPage will set PaperSize equal to ImageSize.
Parameters
- images: string | Buffer | string[] | Buffer[]
  
  The image file path name(s) or ImageBuffer object(s)
- Optional options: {
  imageToPdfOptions?: ImageToPdfOptions;
  }
  
  including ImageToPdfOptions
  - Optional imageToPdfOptions?: ImageToPdfOptions
    
    Apply renderOptions if PdfInput is a HtmlString or HtmlFilePath or ZipFilePath or Url}
    
    Default
    undefined
Returns Promise<PdfDocument>
- Defined in public/pdfDocument.ts:383

`Static` fromUrl

fromUrl(url, options?): Promise<PdfDocument>
Create a PdfDocument from an Url
Parameters
- url: string | URL
  
  A website Url
- Optional options: {
  renderOptions?: ChromePdfRenderOptions;
  }
  
  including ChromePdfRenderOptions
  - Optional renderOptions?: ChromePdfRenderOptions
    
    Apply renderOptions if PdfInput is a HtmlString or HtmlFilePath or ZipFilePath or Url}
    
    Default
    undefined
Returns Promise<PdfDocument>
- Defined in public/pdfDocument.ts:314

`Static` fromZip

fromZip(zipFilePath, options?): Promise<PdfDocument>
Creates a PDF file from a local Zip file, and returns it as a PdfDocument. IronPDF is a W3C standards compliant HTML rendering based on Google's Chromium browser. If your output PDF does not look as expected:
- Validate your HTML file using https://validator.w3.org/ & CSS https://jigsaw.w3.org/css-validator/
- To debug HTML, view the file in Chrome web browser's print preview which will work almost exactly as IronPDF.
- Read our detailed documentation on pixel perfect HTML to PDF: https://ironpdf.com/tutorials/pixel-perfect-html-to-pdf/
Parameters
- zipFilePath: string
  
  Path to a Zip to be rendered as a PDF.
- Optional options: {
  mainHtmlFile?: string;
  renderOptions?: ChromePdfRenderOptions;
  }
  
  including ChromePdfRenderOptions and mainHtmlFile a main .html file default: index.html
  - Optional mainHtmlFile?: string
    
    a main .html file default: index.html
  - Optional renderOptions?: ChromePdfRenderOptions
    
    Apply renderOptions if PdfInput is a HtmlString or HtmlFilePath or ZipFilePath or Url}
    
    Default
    undefined
Returns Promise<PdfDocument>
- Defined in public/pdfDocument.ts:341

`Static` mergePdf

mergePdf(pdfs): Promise<PdfDocument>
Static method that joins (concatenates) multiple PDF documents together into one compiled PDF document. If the PDF contains form fields the form field in the resulting PDF's name will be appended with '_{index}' e.g. 'Name' will be 'Name_0'
Parameters
- pdfs: PdfInput[]
  
  array of PDF
Returns Promise<PdfDocument>
- Defined in public/pdfDocument.ts:449

`Static` open

open(pdfInput, options?): Promise<PdfDocument>
Open or Create a PdfDocument from a PdfInput
Parameters
- pdfInput: PdfInput
  
  PdfInput
- Optional options: {
      httpLoginCredentials?: HttpLoginCredentials;
      mainHtmlFile?: string;
      password?: PdfPassword;
      renderOptions?: ChromePdfRenderOptions;
  }
  
  including PdfPassword ChromePdfRenderOptions HttpLoginCredentials mainHtmlFile
  - Optional httpLoginCredentials?: HttpLoginCredentials
    
    Apply httpLoginCredentials if PdfInput is a HtmlString or HtmlFilePath or ZipFilePath or Url}
    
    Default
    undefined
  - Optional mainHtmlFile?: string
    
    Apply mainHtmlFile if PdfInput is ZipFilePath
    
    Default
    index.html
  - Optional password?: PdfPassword
    
    required for open a protected PDF file
    
    Default
    undefined
  - Optional renderOptions?: ChromePdfRenderOptions
    
    Apply renderOptions if PdfInput is a HtmlString or HtmlFilePath or ZipFilePath or Url}
    
    Default
    undefined
Returns Promise<PdfDocument>
- Defined in public/pdfDocument.ts:205

Class PdfDocument

Remark

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional pdfInput: PdfInput

Optional password: PdfPassword

Returns PdfDocument

Properties

Private Optional pdfDocumentId

Private Optional pdfPassword

Private Optional Readonly promiseDocumentId

Methods

addBackgroundFromAnotherPdf

Parameters

fromPdf: PdfDocument

sourcePageIndex: number = 0

Optional applyToPages: PdfPageSelection

Returns Promise<void>

addForegroundFromAnotherPdf

Parameters

fromPdf: PdfDocument

sourcePageIndex: number = 0

Optional applyToPages: PdfPageSelection

Returns Promise<void>

addHtmlFooter

Parameters

footer: HtmlAffix

Optional toPages: PdfPageSelection

Returns Promise<void>

addHtmlHeader

Parameters

header: HtmlAffix

Optional toPages: PdfPageSelection

Returns Promise<void>

addOrUpdateMetadata

Parameters

key: string

value: string

Returns Promise<void>

addTextFooter

Parameters

footer: TextAffix

Optional toPages: PdfPageSelection

Returns Promise<void>

addTextHeader

Parameters

header: TextAffix

Optional toPages: PdfPageSelection

Returns Promise<void>

appendAnotherPdf

Parameters

fromPdfDocument: PdfDocument

Returns Promise<void>

close

Returns Promise<void>

compressSize

Parameters

imageQuality: number

scaleToVisibleSize: boolean = false

Returns Promise<void>

convertToPdfA

Parameters

Optional customICC: string

Returns Promise<void>

convertToPdfUA

Returns Promise<void>

duplicate

Parameters

pages: PdfPageSelection = "all"

Returns Promise<PdfDocument>

extractRawImages

Parameters

Optional options: { fromPages: PdfPageSelection; }

fromPages: PdfPageSelection

`Optional` pdfInput: PdfInput

`Optional` password: PdfPassword

`Private` `Optional` pdfDocumentId

`Private` `Optional` pdfPassword

`Private` `Optional` `Readonly` promiseDocumentId

`Optional` applyToPages: PdfPageSelection

`Optional` applyToPages: PdfPageSelection

`Optional` toPages: PdfPageSelection

`Optional` toPages: PdfPageSelection

`Optional` toPages: PdfPageSelection

`Optional` toPages: PdfPageSelection

`Optional` customICC: string

`Optional` options: {
fromPages: PdfPageSelection;
}

`Optional` onPages: PdfPageSelection

`Private` getId

`Optional` options: {
fromPages: PdfPageSelection;
imageType?: ImageType;
}

`Optional` imageType?: ImageType

`Optional` options: {
fromPages?: PdfPageSelection;
type?: ImageType;
}

`Optional` fromPages?: PdfPageSelection

`Optional` type?: ImageType

`Optional` onPages: PdfPageSelection