Documents

Spreadsheet

Spreadsheet

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

js

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

Métodos

cloneSheet

Método responsável por clonar uma aba de planilha.

js

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

Parâmetros obrigatórios

• filePath: String - espera o caminho do arquivo que possui as abas que serão clonadas. O caminho deve conter o nome do arquivo e a extensão. Este valor é opcional se o parâmetro spreadSheet for informado.
• from: String - espera o nome da aba que será clonada.
• to: String - espera o nome da aba que será criada.
• spreadSheet: Objeto - espera um objeto que pode ser obtido através da ação open. Este valor é opcional se o parâmetro filePath for informado.

Parâmetros opcionais

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

Retorno

Este método não possui retorno.

createSpreadsheet

Método responsável por criar uma nova planilha.

js

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

Parâmetros obrigatórios

• filePath: String - espera o caminho do arquivo que será criado. O caminho deve conter o nome do arquivo e a extensão.

Parâmetros opcionais

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

Retorno

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

• spreadsheet._XlsxPopulate: XlsxPopulate.Workbook - retorna uma estrutura do tipo XlsxPopulate.Workbook que pode ser utilizada para manipulação de planilhas.
• spreadsheet._exceljs: ExcelJS.Workbook - retorna uma estrutura do tipo ExcelJS.Workbook que pode ser utilizada para manipulação de planilhas.
• spreadsheet.tempFilePath: string - retorna o caminho do arquivo temporário criado para a manipulação da planilha.
• spreadsheet.filePath: string - retorna o caminho do arquivo que foi aberto.

deleteSheet

Método responsável por deletar uma aba de planilha.

js

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

Parâmetros obrigatórios

• filePath: String - espera o caminho do arquivo que possui as abas que serão deletadas. O caminho deve conter o nome do arquivo e a extensão. Este valor é opcional se o parâmetro spreadSheet for informado.
• name: String - espera o nome da aba que será deletada.
• spreadSheet: Objeto - espera um objeto que pode ser obtido através da ação open. Este valor é opcional se o parâmetro filePath for informado.

Parâmetros opcionais

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

Retorno

Este método não possui retorno.

getCellValue

Método responsável por obter o valor de uma célula de uma planilha.

js

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

Parâmetros obrigatórios

• cell: String - espera a coluna e linha da célula que será obtida.
• sheet: Objeto - espera um objeto que pode ser obtido através da ação getSheet.

Parâmetros opcionais

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

Retorno

A constante ou variável criada, como a value do exemplo mostrado anteriormente, receberá o valor que terá o tipo de dado da célula.

getRowValues

Método responsável por obter os valores de uma linha de uma planilha.

js

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

Parâmetros obrigatórios

• row: Number - espera o número da linha que será obtida.
• sheet: Objeto - espera um objeto que pode ser obtido através da ação getSheet.

Parâmetros opcionais

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

Retorno

A constante ou variável criada, como a row do exemplo mostrado anteriormente, receberá um objeto que possui as seguintes propriedades:

• row.values: exceljs.CellValue[] - retorna um array de valores da linha.
• row.count: Number - retorna a quantidade de células preenchidas da linha.

getSheet

Método responsável por obter uma aba de planilha.

js

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

Parâmetros obrigatórios

• spreadSheet: Objeto - espera um objeto que pode ser obtido através da ação openSpreadsheet.
• sheetName: String - espera o nome da aba que será obtida.

Parâmetros opcionais

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

Retorno

A constante ou variável criada, como a sheet mostrada no exemplo anterior, receberá um valor do tipo Objeto que dará acesso às seguintes propriedades:

• sheet._sheetExceljs: Worksheet - retorna uma estrutura do tipo ExcelJS.Worksheet que pode ser utilizada para manipulação de abas.
• sheet._sheetXlsxPopulate: Worksheet - retorna uma estrutura do tipo XlsxPopulate.Worksheet que pode ser utilizada para manipulação de abas.
• sheet._XlsxPopulate: XlsxPopulate.Workbook - retorna uma estrutura do tipo XlsxPopulate.Workbook que pode ser utilizada para manipulação de planilhas.
• sheet._exceljs: ExcelJS.Workbook - retorna uma estrutura do tipo ExcelJS.Workbook que pode ser utilizada para manipulação de planilhas.
• sheet.tempFilePath: string - retorna o caminho do arquivo temporário criado para a manipulação da planilha.
• sheet.filePath: string - retorna o caminho do arquivo em que a aba foi obtida.

getTableColumns

Método responsável por obter o nome das colunas de uma tabela existente em uma aba de planilha.

js

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

Parâmetros obrigatórios

• tableName: String - espera o nome da tabela que será obtida.
• sheet: Objeto - espera um objeto que pode ser obtido através da ação getSheet.

Parâmetros opcionais

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

Retorno

A constante ou variável criada, como a columns do exemplo mostrado anteriormente, receberá um objeto que possui as seguintes propriedades:

• columns.columns: string[] - retorna um array de nomes das colunas.
• columns.count: Number - retorna a quantidade de colunas.

getTableValues

Método responsável por obter os valores de uma tabela existente em uma aba de planilha.

js

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

Parâmetros obrigatórios

• tableName: String - espera o nome da tabela que será obtida.
• sheet: Objeto - espera um objeto que pode ser obtido através da ação getSheet.

Parâmetros opcionais

• hasHeader: Boolean - espera um valor que indica se a tabela possui cabeçalho. Por padrão, o valor é true.

Retorno

A constante ou variável criada, como a tableValues do exemplo mostrado anteriormente, receberá um valor do tipo Any[][] com todos os valores da tabela.

listSheets

Método responsável por obter todas as abas de uma planilha.

js

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

Parâmetros obrigatórios

• spreadSheet: Objeto - espera um objeto que pode ser obtido através da ação openSpreadsheet. Este parâmetro é opcional se o parâmetro filePath for informado.
• filePath: String - espera o caminho do arquivo que será obtido. Este parâmetro é opcional se o parâmetro spreadSheet for informado.

Parâmetros opcionais

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

Retorno

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

• sheets.sheets: string[] - retorna um array de nomes das abas.
• sheets.count: Number - retorna a quantidade de abas.

listTables

Método responsável por obter todas as tabelas existentes em uma aba de planilha.

js

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

Parâmetros obrigatórios

• sheet: Objeto - espera um objeto que pode ser obtido através da ação getSheet.

Parâmetros opcionais

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

Retorno

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

• tables.tables: string[] - retorna um array de nomes das tabelas.
• tables.count: Number - retorna a quantidade de tabelas.

newSheet

Método responsável por criar uma nova aba em uma planilha.

js

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

Parâmetros obrigatórios

• spreadSheet: Objeto - espera um objeto que pode ser obtido através da ação openSpreadsheet. Este parâmetro é opcional se o parâmetro filePath for informado.
• filePath: String - espera o caminho do arquivo que será obtido. Este parâmetro é opcional se o parâmetro spreadSheet for informado.
• name: String - espera o nome da aba que será criada.

Parâmetros opcionais

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

Retorno

Este método não possui retorno.

openSpreadsheet

Método responsável por abrir um arquivo de planilha.

js

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

Parâmetros obrigatórios

Este método não possuí um objeto para os parâmetros. Uma string que será o caminho do arquivo .xlsx deve ser passada como mostrado no exemplo anterior.

Parâmetros opcionais

Este método não possui parâmetro opcional.

Retorno

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

• spreadsheet._XlsxPopulate: XlsxPopulate.Workbook - retorna uma estrutura do tipo XlsxPopulate.Workbook que pode ser utilizada para manipulação de planilhas.
• spreadsheet._exceljs: ExcelJS.Workbook - retorna uma estrutura do tipo ExcelJS.Workbook que pode ser utilizada para manipulação de planilhas.
• spreadsheet.tempFilePath: string - retorna o caminho do arquivo temporário criado para a manipulação da planilha.
• spreadsheet.filePath: string - retorna o caminho do arquivo que foi aberto.

rowCount

Método responsável por contar a quantidade de linhas preenchidas de uma aba de planilha.

js

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

Parâmetros obrigatórios

• sheet: Objeto - espera um objeto que pode ser obtido através da ação getSheet.

Parâmetros opcionais

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

Retorno

A constante ou variável criada, como a rowCount do exemplo mostrado anteriormente, receberá um valor do tipo objeto que dará acesso às seguintes propriedades:

• rowCount.count: Number - retorna a quantidade de linhas preenchidas.
• rowCount.nextRow: Number - retorna o índice da próxima linha vazia (equivalente a count + 1).

setCellValue

Método responsável por definir o valor de uma célula de uma aba de planilha.

js

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

Parâmetros obrigatórios

• cell: String - espera a coluna e linha da célula que será definida.
• sheet: Objeto - espera um objeto que pode ser obtido através da ação getSheet.
• value: String - espera o valor que será definido na célula.

Parâmetros opcionais

• formatCell: Objeto - espera um objeto que deve ter as seguintes propriedades:
  • bold: Boolean - espera um valor booleano que indica se a célula será negrito.
  • italic: Boolean - espera um valor booleano que indica se a célula será itálico.
  • fontSize: Number - espera um valor numérico que indica o tamanho da fonte.

Retorno

Este método não possui retorno.

setColumnValues

Método responsável por definir o valor de uma coluna de uma aba de planilha.

js

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

Parâmetros obrigatórios

• sheet: Objeto - espera um objeto que pode ser obtido através da ação getSheet.
• startColumn: String - espera a coluna inicial da coluna que será definida.
• startRow: Number - espera a linha inicial da coluna que será definida.
• values: Array - espera um array que contém os valores que serão definidos na coluna. Também pode receber um array de arrays, onde cada array representa os valores das colunas.

Parâmetros opcionais

• formatCell: Objeto - espera um objeto que deve ter as seguintes propriedades:
  • bold: Boolean - espera um valor booleano que indica se os valores da coluna serão negritos.
  • italic: Boolean - espera um valor booleano que indica se os valores da coluna serão itálicos.
  • fontSize: Number - espera um valor numérico que indica o tamanho da fonte.

Retorno

Este método não possui retorno.

setRowValues

Método responsável por definir os valores em uma linha de uma aba de planilha.

js

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

Parâmetros obrigatórios

• sheet: Objeto - espera um objeto que pode ser obtido através da ação getSheet.
• startRow: Number - espera o número da linha que receberá os valores.
• startCell: String - espera a coluna inicial da linha que será definida.
• values: Array - espera um array que contém os valores que serão definidos na linha. Também pode receber um array de arrays, onde cada array representa linhas da planilha.

Parâmetros opcionais

• formatCell: Objeto - espera um objeto que deve ter as seguintes propriedades:
  • bold: Boolean - espera um valor booleano que indica se os valores da linha serão negrito.
  • italic: Boolean - espera um valor booleano que indica se os valores da linha serão itálico.
  • fontSize: Number - espera um valor numérico que indica o tamanho da fonte.

Retorno

Este método não possui retorno.