Skip to main content

PDF

O módulo PDF é responsável por realizar ações de manipulação de arquivos em PDF. Seus métodos podem ser acessados conforme o exemplo abaixo:

const pdf = await Documents.PDF.toPDF["v1_0_0"]({
  documentPath: "C:/Users/Roberty/Documents/teste.docx",
  pdfPath: "C:/Users/Roberty/Documents/teste.pdf"
})

Métodos​

readByRegions​

Método responsável por obter informações em texto de regiões de um PDF selecionadas pelo usuário.

const infoRegions = await Documents.PDF.readByRegions["v1_0_0"]({
  pdfPath: "C:/Users/Roberty/Documents/teste.pdf",
  regions: [{
        x: 20,
        y: 20,
        height: 20,
        width: 20,
        name: `endereco`,
        page: 1
      }]
})

Parâmetros obrigatórios​

  • pdfPath: String - espera o caminho onde o arquivo PDF está armazenado. O caminho deve conter o nome do arquivo e a extensão .pdf.
  • regions: Array de Objetos - espera um array de objetos que devem conter as seguintes propriedades:
    • x: number - espera um número que será a posição inicial horizontal em pixel da onde se encontra a região desejada;
    • y: number - espera um número que será a posição inicial vertical em pixel da onde se encontra a região desejada;
    • height: number - espera um número que será a altura em pixel da região que deve ser selecionada;
    • width: number - espera um número que será a largura em pixel da região que deve ser selecionada;
    • name: string - espera um nome que identificará a área selecionada;
    • page: number - espera um número que representará a página onde está a região desejada.

Parâmetros opcionais​

Este método não possui parâmetros opcionais.

Retorno​

A constante ou variável criada, como a infoRegions do exemplo mostrado anteriormente, receberá um objeto contendo todos os nomes das regiões passadas pelo usuário. Essas propriedades retornarão a informação obtida na região em forma de texto, como mostra o exemplo abaixo:

const endereço = infoRegions.endereco
console.log(endereço) //mostrará o conteúdo obtido na região de endereço do PDF

toPdf​

Método responsável por converter um arquivo para formato PDF.

const convertError = await Documents.PDF.toPDF["v1_0_0"]({
  documentPath: "C:/Users/Roberty/Documents/teste.docx",
  pdfPath: "C:/Users/Roberty/Documents/teste.pdf"
})

Parâmetros obrigatórios​

  • documentPath: String - espera o caminho do arquivo que será convertido. O caminho deve conter o nome do arquivo e a extensão.
  • pdfPath: String - espera o caminho onde o arquivo PDF será salvo.O caminho deve conter o nome do arquivo e a extensão .pdf.

Parâmetros opcionais​

Este método não possui parâmetros opcionais.

Retorno​

A constante ou variável criada, como a convertError do exemplo mostrado anteriormente, receberá um valor do tipo Objeto que dará acesso as seguintes propriedades:

  • convertError.error: string - retorna uma mensagem de erro caso a conversão não seja realizada com sucesso.

mergePDF​

Método responsável por converter um arquivo para formato PDF.

  const mergePDF = await Documents.PDF.mergePDF.v1_0_0({
    filesPath: [ '', '' ],
    outputPath: ''
  })

Parâmetros obrigatórios​

  • filesPath: String[] - espera um array de strings com os caminhos dos PDFs que deseja que sejam unidos em um único. O caminho deve conter o nome do arquivo e a extensão .pdf.
  • outputPath: String - espera o caminho onde o arquivo PDF será salvo.O caminho deve conter o nome do arquivo e a extensão .pdf.

Parâmetros opcionais​

Este método não possui parâmetros opcionais.

Retorno​

Esta ação não possui retorno.