Saltar al contenido principal
Ir al Studio
Documents

PDF

PDF

El módulo PDF es responsable de realizar acciones de manipulación de archivos en PDF. Sus métodos pueden accederse conforme al ejemplo a continuación:

js
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 responsable de obtener información en texto de regiones de un PDF seleccionadas por el usuario.

js
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 obligatorios​

  • pdfPath: String - espera la ruta donde está almacenado el archivo PDF. La ruta debe contener el nombre del archivo y la extensión .pdf.
  • regions: Array de Objetos - espera un array de objetos que deben contener las siguientes propiedades:
    • x: number - espera un número que será la posición inicial horizontal en píxeles de donde se encuentra la región deseada;
    • y: number - espera un número que será la posición inicial vertical en píxeles de donde se encuentra la región deseada;
    • height: number - espera un número que será la altura en píxeles de la región que debe seleccionarse;
    • width: number - espera un número que será el ancho en píxeles de la región que debe seleccionarse;
    • name: string - espera un nombre que identificará el área seleccionada;
    • page: number - espera un número que representará la página donde está la región deseada.

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

La constante o variable creada, como la infoRegions del ejemplo mostrado anteriormente, recibirá un objeto que contiene todos los nombres de las regiones indicadas por el usuario. Esas propiedades devolverán la información obtenida en la región en forma de texto, como muestra el ejemplo a continuación:

js
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 responsable de convertir un archivo a formato PDF.

js
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 obligatorios​

  • documentPath: String - espera la ruta del archivo que será convertido. La ruta debe contener el nombre del archivo y la extensión.
  • pdfPath: String - espera la ruta donde será guardado el archivo PDF. La ruta debe contener el nombre del archivo y la extensión .pdf.

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

La constante o variable creada, como la convertError del ejemplo mostrado anteriormente, recibirá un valor del tipo Objeto que dará acceso a las siguientes propiedades:

  • convertError.error: string - devuelve un mensaje de error si la conversión no se realiza con éxito.

readLines​

Método responsable de leer el contenido de un PDF y devolverlo línea por línea.

js
const result = await Documents.PDF.readLines["v4_0_0"]({
  pdfPath: "C:/Users/Roberty/Documents/teste.pdf",
})

Parámetros obligatorios​

  • pdfPath: String - espera la ruta donde está almacenado el archivo PDF. La ruta debe contener el nombre del archivo y la extensión .pdf.

Parámetros opcionales​

  • yThreshold: Number - espera un número que define la tolerancia vertical (en píxeles) para agrupar elementos en la misma línea. Útil para PDF con espaciado irregular entre líneas.

Retorno​

La constante o variable creada, como la result del ejemplo mostrado anteriormente, recibirá un objeto con las siguientes propiedades:

  • result.lines: String[][] - array de arrays de strings, donde cada posición representa una línea del PDF y sus segmentos de texto.
  • result.content: String - todo el contenido del PDF en formato de texto, con saltos de línea.

mergePDF​

Método responsable de combinar varios archivos PDF en un único archivo.

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

Parámetros obligatorios​

  • filesPath: String[] - espera un array de strings con las rutas de los PDF que deseas unir en uno solo. La ruta debe contener el nombre del archivo y la extensión .pdf.
  • outputPath: String - espera la ruta donde será guardado el archivo PDF. La ruta debe contener el nombre del archivo y la extensión .pdf.

Parámetros opcionales​

Este método no tiene parámetros opcionales.

Retorno​

Esta acción no tiene retorno.