exframe-pdf v3.0.2

exframe-pdf

Merge

Merge multiple pdfs into a single pdf

const data = pdf.merge({ /* harmony context object */ },['/files/pdfs/file1.pdf', '/files/pdfs/file2.pdf'], '/files/pdfs/merged.pdf', { mergeLib: 'gs' });

Input

• context - Harmony context object
• inputPdfFilePaths - an array of local file paths for the pdfs to get merged
• outputFilePath - local file path of the merged pdf output
• options - list of options for the operation
  • mergeLib - the library to use for the merge operation (pdftk (default), gs)
  • priority - the priority of the action being added to the queue (high priority goes to top queue)

Info

Retrieve metadata information from a pdf file

const data = pdf.info({ /* harmony context object */ }, '/files/pdfs/info.pdf');

Input

• context - Harmony context object
• inputPdfFilePath - local file path of the pdf to get information on
• options - list of options for the operation
  • priority - the priority of the action being added to the queue (high priority goes to top queue)

Output

  {
    pageCount: 0,
    pageRotation: 0,
    pageDimension: {
      x: 0,
      y: 0,
      width: 0,
      height: 0
    }
  }

Fill

Fill pdf form with data and generate the pdf

const data = pdf.fill({ /* harmony context object */ }, '/files/pdfs/info.pdf', {/* form data to fill pdf */}, '/files/pdfs/output.pdf');

Input

• context - Harmony context object
• inputPdfFilePath - local file path of the pdf to get information on
• fillDataJson - Data to fill the pdf form with
• outputPdfFilePath - local file path of the merged pdf output
• options - list of options for the operation
  • priority - the priority of the action being added to the queue (high priority goes to top queue)