Documents

Spreadsheet

Spreadsheet

El módulo Spreadsheet es responsable de realizar acciones de manipulación de archivos de hojas de cálculo. Sus métodos pueden accederse conforme al ejemplo a continuación:

js

const spreadsheet = await Documents.Spreadsheet.open["v1_0_0"]("C:/Users/Roberty/Documents/teste.xlsx")

Métodos

cloneSheet

Método responsable de clonar una pestaña de hoja de cálculo.

js

await Documents.Spreadsheet.cloneSheet["v1_0_0"]({
  filePath: "C:/Users/Roberty/Documents/teste.xlsx",
  from: "Sheet1",
  to: "Sheet2"
})

Parámetros obligatorios

• filePath: String - espera la ruta del archivo que tiene las pestañas que serán clonadas. La ruta debe contener el nombre del archivo y la extensión. Este valor es opcional si se indica el parámetro spreadSheet.
• from: String - espera el nombre de la pestaña que será clonada.
• to: String - espera el nombre de la pestaña que será creada.
• spreadSheet: Objeto - espera un objeto que puede obtenerse a través de la acción open. Este valor es opcional si se indica el parámetro filePath.

Parámetros opcionales

Este método no tiene parámetros opcionales.

Retorno

Este método no tiene retorno.

createSpreadsheet

Método responsable de crear una nueva hoja de cálculo.

js

const spreadsheet = await Documents.Spreadsheet.createSpreadsheet["v1_0_0"]({
  filePath: "C:/Users/Roberty/Documents/teste.xlsx"
})

Parámetros obligatorios

• filePath: String - espera la ruta del archivo que será creado. La ruta debe contener el nombre del archivo y la extensión.

Parámetros opcionales

Este método no tiene parámetros opcionales.

Retorno

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

• spreadsheet._XlsxPopulate: XlsxPopulate.Workbook - devuelve una estructura del tipo XlsxPopulate.Workbook que puede utilizarse para la manipulación de hojas de cálculo.
• spreadsheet._exceljs: ExcelJS.Workbook - devuelve una estructura del tipo ExcelJS.Workbook que puede utilizarse para la manipulación de hojas de cálculo.
• spreadsheet.tempFilePath: string - devuelve la ruta del archivo temporal creado para la manipulación de la hoja de cálculo.
• spreadsheet.filePath: string - devuelve la ruta del archivo que fue abierto.

deleteSheet

Método responsable de eliminar una pestaña de hoja de cálculo.

js

await Documents.Spreadsheet.deleteSheet["v1_0_0"]({
  filePath: "C:/Users/Roberty/Documents/teste.xlsx",
  name: "Sheet1"
})

Parámetros obligatorios

• filePath: String - espera la ruta del archivo que tiene las pestañas que serán eliminadas. La ruta debe contener el nombre del archivo y la extensión. Este valor es opcional si se indica el parámetro spreadSheet.
• name: String - espera el nombre de la pestaña que será eliminada.
• spreadSheet: Objeto - espera un objeto que puede obtenerse a través de la acción open. Este valor es opcional si se indica el parámetro filePath.

Parámetros opcionales

Este método no tiene parámetros opcionales.

Retorno

Este método no tiene retorno.

getCellValue

Método responsable de obtener el valor de una celda de una hoja de cálculo.

js

const value = await Documents.Spreadsheet.getCellValue["v1_0_0"]({
  cell: "A1",
  sheet: sheet,
})

Parámetros obligatorios

• cell: String - espera la columna y la fila de la celda que será obtenida.
• sheet: Objeto - espera un objeto que puede obtenerse a través de la acción getSheet.

Parámetros opcionales

Este método no tiene parámetros opcionales.

Retorno

La constante o variable creada, como la value del ejemplo mostrado anteriormente, recibirá el valor, que tendrá el tipo de dato de la celda.

getRowValues

Método responsable de obtener los valores de una fila de una hoja de cálculo.

js

const row = await Documents.Spreadsheet.getRowValues["v1_0_0"]({
  row: 1,
  sheet: sheet,
})

Parámetros obligatorios

• row: Number - espera el número de la fila que será obtenida.
• sheet: Objeto - espera un objeto que puede obtenerse a través de la acción getSheet.

Parámetros opcionales

Este método no tiene parámetros opcionales.

Retorno

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

• row.values: exceljs.CellValue[] - devuelve un array de valores de la fila.
• row.count: Number - devuelve la cantidad de celdas completadas de la fila.

getSheet

Método responsable de obtener una pestaña de hoja de cálculo.

js

const sheet = await Documents.Spreadsheet.getSheet["v1_0_0"]({
  spreadSheet: spreadsheet,
  sheetName: "Sheet1"
})

Parámetros obligatorios

• spreadSheet: Objeto - espera un objeto que puede obtenerse a través de la acción openSpreadsheet.
• sheetName: String - espera el nombre de la pestaña que será obtenida.

Parámetros opcionales

Este método no tiene parámetros opcionales.

Retorno

La constante o variable creada, como la sheet mostrada en el ejemplo anterior, recibirá un valor del tipo Objeto que dará acceso a las siguientes propiedades:

• sheet._sheetExceljs: Worksheet - devuelve una estructura del tipo ExcelJS.Worksheet que puede utilizarse para la manipulación de pestañas.
• sheet._sheetXlsxPopulate: Worksheet - devuelve una estructura del tipo XlsxPopulate.Worksheet que puede utilizarse para la manipulación de pestañas.
• sheet._XlsxPopulate: XlsxPopulate.Workbook - devuelve una estructura del tipo XlsxPopulate.Workbook que puede utilizarse para la manipulación de hojas de cálculo.
• sheet._exceljs: ExcelJS.Workbook - devuelve una estructura del tipo ExcelJS.Workbook que puede utilizarse para la manipulación de hojas de cálculo.
• sheet.tempFilePath: string - devuelve la ruta del archivo temporal creado para la manipulación de la hoja de cálculo.
• sheet.filePath: string - devuelve la ruta del archivo del que fue obtenida la pestaña.

getTableColumns

Método responsable de obtener el nombre de las columnas de una tabla existente en una pestaña de hoja de cálculo.

js

const columns = await Documents.Spreadsheet.getTableColumns["v1_0_0"]({
  tableName: "Table1",
  sheet: sheet,
})

Parámetros obligatorios

• tableName: String - espera el nombre de la tabla que será obtenida.
• sheet: Objeto - espera un objeto que puede obtenerse a través de la acción getSheet.

Parámetros opcionales

Este método no tiene parámetros opcionales.

Retorno

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

• columns.columns: string[] - devuelve un array de nombres de las columnas.
• columns.count: Number - devuelve la cantidad de columnas.

getTableValues

Método responsable de obtener los valores de una tabla existente en una pestaña de hoja de cálculo.

js

const tableValues = await Documents.Spreadsheet.getTableValues["v1_0_0"]({
  tableName: "Table1",
  sheet: sheet,
})

Parámetros obligatorios

• tableName: String - espera el nombre de la tabla que será obtenida.
• sheet: Objeto - espera un objeto que puede obtenerse a través de la acción getSheet.

Parámetros opcionales

• hasHeader: Boolean - espera un valor que indica si la tabla tiene encabezado. De forma predeterminada, el valor es true.

Retorno

La constante o variable creada, como la tableValues del ejemplo mostrado anteriormente, recibirá un valor del tipo Any[][] con todos los valores de la tabla.

listSheets

Método responsable de obtener todas las pestañas de una hoja de cálculo.

js

const sheets = await Documents.Spreadsheet.listSheets["v1_0_0"]({
  spreadSheet: spreadsheet,
})

Parámetros obligatorios

• spreadSheet: Objeto - espera un objeto que puede obtenerse a través de la acción openSpreadsheet. Este parámetro es opcional si se indica el parámetro filePath.
• filePath: String - espera la ruta del archivo que será obtenido. Este parámetro es opcional si se indica el parámetro spreadSheet.

Parámetros opcionales

Este método no tiene parámetros opcionales.

Retorno

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

• sheets.sheets: string[] - devuelve un array de nombres de las pestañas.
• sheets.count: Number - devuelve la cantidad de pestañas.

listTables

Método responsable de obtener todas las tablas existentes en una pestaña de hoja de cálculo.

js

const tables = await Documents.Spreadsheet.listTables["v1_0_0"]({
  sheet: sheet,
})

Parámetros obligatorios

• sheet: Objeto - espera un objeto que puede obtenerse a través de la acción getSheet.

Parámetros opcionales

Este método no tiene parámetros opcionales.

Retorno

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

• tables.tables: string[] - devuelve un array de nombres de las tablas.
• tables.count: Number - devuelve la cantidad de tablas.

newSheet

Método responsable de crear una nueva pestaña en una hoja de cálculo.

js

await Documents.Spreadsheet.newSheet["v1_0_0"]({
  spreadSheet: spreadsheet,
  name: "Sheet1",
})

Parámetros obligatorios

• spreadSheet: Objeto - espera un objeto que puede obtenerse a través de la acción openSpreadsheet. Este parámetro es opcional si se indica el parámetro filePath.
• filePath: String - espera la ruta del archivo que será obtenido. Este parámetro es opcional si se indica el parámetro spreadSheet.
• name: String - espera el nombre de la pestaña que será creada.

Parámetros opcionales

Este método no tiene parámetros opcionales.

Retorno

Este método no tiene retorno.

openSpreadsheet

Método responsable de abrir un archivo de hoja de cálculo.

js

const spreadsheet = await Documents.Spreadsheet.openSpreadsheet["v1_0_0"]("C:/Users/Roberty/Documents/teste.xlsx")

Parámetros obligatorios

Este método no tiene un objeto para los parámetros. Debe pasarse un string que será la ruta del archivo .xlsx, como se muestra en el ejemplo anterior.

Parámetros opcionales

Este método no tiene parámetro opcional.

Retorno

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

• spreadsheet._XlsxPopulate: XlsxPopulate.Workbook - devuelve una estructura del tipo XlsxPopulate.Workbook que puede utilizarse para la manipulación de hojas de cálculo.
• spreadsheet._exceljs: ExcelJS.Workbook - devuelve una estructura del tipo ExcelJS.Workbook que puede utilizarse para la manipulación de hojas de cálculo.
• spreadsheet.tempFilePath: string - devuelve la ruta del archivo temporal creado para la manipulación de la hoja de cálculo.
• spreadsheet.filePath: string - devuelve la ruta del archivo que fue abierto.

rowCount

Método responsable de contar la cantidad de filas completadas de una pestaña de hoja de cálculo.

js

const rowCount = await Documents.Spreadsheet.rowCount["v1_0_0"]({
  sheet: sheet,
})

Parámetros obligatorios

• sheet: Objeto - espera un objeto que puede obtenerse a través de la acción getSheet.

Parámetros opcionales

Este método no tiene parámetros opcionales.

Retorno

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

• rowCount.count: Number - devuelve la cantidad de filas completadas.
• rowCount.nextRow: Number - devuelve el índice de la siguiente fila vacía (equivalente a count + 1).

setCellValue

Método responsable de definir el valor de una celda de una pestaña de hoja de cálculo.

js

await Documents.Spreadsheet.setCellValue["v1_0_0"]({
  cell: 'A1',
  sheet: sheet,
  value: "Roberty",
})

Parámetros obligatorios

• cell: String - espera la columna y la fila de la celda que será definida.
• sheet: Objeto - espera un objeto que puede obtenerse a través de la acción getSheet.
• value: String - espera el valor que será definido en la celda.

Parámetros opcionales

• formatCell: Objeto - espera un objeto que debe tener las siguientes propiedades:
  • bold: Boolean - espera un valor booleano que indica si la celda será negrita.
  • italic: Boolean - espera un valor booleano que indica si la celda será cursiva.
  • fontSize: Number - espera un valor numérico que indica el tamaño de la fuente.

Retorno

Este método no tiene retorno.

setColumnValues

Método responsable de definir el valor de una columna de una pestaña de hoja de cálculo.

js

await Documents.Spreadsheet.setColumnValues["v1_0_0"]({
  sheet: sheet,
  startColumn: "A",
  startRow: 1,
  values: [["Hello", "World"]],
})

Parámetros obligatorios

• sheet: Objeto - espera un objeto que puede obtenerse a través de la acción getSheet.
• startColumn: String - espera la columna inicial de la columna que será definida.
• startRow: Number - espera la fila inicial de la columna que será definida.
• values: Array - espera un array que contiene los valores que serán definidos en la columna. También puede recibir un array de arrays, donde cada array representa los valores de las columnas.

Parámetros opcionales

• formatCell: Objeto - espera un objeto que debe tener las siguientes propiedades:
  • bold: Boolean - espera un valor booleano que indica si los valores de la columna serán negrita.
  • italic: Boolean - espera un valor booleano que indica si los valores de la columna serán cursivos.
  • fontSize: Number - espera un valor numérico que indica el tamaño de la fuente.

Retorno

Este método no tiene retorno.

setRowValues

Método responsable de definir los valores en una fila de una pestaña de hoja de cálculo.

js

await Documents.Spreadsheet.setRowValues["v1_0_0"]({
  sheet: sheet,
  startRow: 1,
  startCell: "A",
  values: [["Hello", "World"]],
})

Parámetros obligatorios

• sheet: Objeto - espera un objeto que puede obtenerse a través de la acción getSheet.
• startRow: Number - espera el número de la fila que recibirá los valores.
• startCell: String - espera la columna inicial de la fila que será definida.
• values: Array - espera un array que contiene los valores que serán definidos en la fila. También puede recibir un array de arrays, donde cada array representa filas de la hoja de cálculo.

Parámetros opcionales

• formatCell: Objeto - espera un objeto que debe tener las siguientes propiedades:
  • bold: Boolean - espera un valor booleano que indica si los valores de la fila serán negrita.
  • italic: Boolean - espera un valor booleano que indica si los valores de la fila serán cursivos.
  • fontSize: Number - espera un valor numérico que indica el tamaño de la fuente.

Retorno

Este método no tiene retorno.