Skip to main content

Excel

IMPORTANTE

Para utilização dessa categoria é OBRIGATÓRIO ter instalado em seu computador o pacote Office.

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

const excel = await Office.Excel.openWorkbook["v1_0_0"]({
  filePath: "C:\\Users\\nome-de-usuario\\Desktop\\teste.xlsx",
});

Métodos​

openWorkbook​

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

await Office.Excel.openWorkbook["v1_0_0"]({
  filePath: "C:\\Users\\nome-de-usuario\\Desktop\\teste.xlsx",
});

Parâmetros obrigatórios​

  • filePath:String - espera uma string com o caminho da planilha de Excel.

Parâmetros opcionais​

  • saveOnClose:Boolean - espera um valor booleano que indica se a planilha será salva após ser fechada.
  • name:String - espera uma string com o nome da aba da planilha.
  • options:Object - espera um objeto para configuração de abertura da planilha de Excel.
    • readOnly:Boolean - espera um valor booleano.

Retorno​

Este método não possui retorno.

createWorkbook​

Método responsável por criar um arquivo de Excel.

await Office.Excel.createWorkbook["v1_0_0"]({
  name: "Planilha",
  workbook: {
    filePath: "C:\\Users\\nome-de-usuario\\Desktop\\teste2.xlsx",
  },
});

Parâmetros obrigatórios​

  • name:String - espera uma string com o nome da aba da planilha de Excel.
  • workbook:Object - espera um objeto referente a planilha de Excel.
    • filePath:String - espera uma string com o caminho da planilha de Excel.

Parâmetros opcionais​

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

Retorno​

Este método não possui retorno.

saveWorkbook​

Método responsável por salvar um arquivo de Excel.

await Office.Excel.saveWorkbook["v1_0_0"]({
  workbook: {
    filePath: "C:\\Users\\nome-de-usuario\\Desktop\\teste.xlsx",
  },
});

Parâmetros obrigatórios​

  • workbook:Object - espera um objeto referente a planilha de Excel.
    • filePath:String - espera uma string com o caminho da planilha de Excel.

Parâmetros opcionais​

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

Retorno​

Este método não possui retorno.

closeWorkbook​

Método responsável por fechar um arquivo de Excel.

await Office.Excel.closeWorkbook["v1_0_0"]({
  filePath: "C:\\Users\\nome-de-usuario\\Desktop\\teste.xlsx",
});

Parâmetros obrigatórios​

  • filePath:String - espera uma string com o caminho da planilha de Excel.

Parâmetros opcionais​

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

Retorno​

Este método não possui retorno.

createWorksheet​

Método responsável por criar uma aba em um arquivo de Excel.

await Office.Excel.createWorksheet["v1_0_0"]({
  workbook: {
    filePath: "C:\\Users\\nome-de-usuario\\Desktop\\teste.xlsx",
  },
  name: "teste",
});

Parâmetros obrigatórios​

  • name:String - espera uma string com o nome da aba da planilha de Excel.
  • workbook:Object - espera um objeto referente a planilha de Excel.
    • filePath:String - espera uma string com o caminho da planilha de Excel.

Parâmetros opcionais​

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

Retorno​

Este método não possui retorno.

renameWorksheet​

Método responsável por renomear uma aba de um arquivo de Excel.

await Office.Excel.renameWorksheet["v1_0_0"]({
  newName: "teste2",
  worksheet: {
    name: "teste",
    workbook: {
      filePath: "C:\\Users\\nome-de-usuario\\Desktop\\teste.xlsx",
    },
  },
});

Parâmetros obrigatórios​

  • newName:String - espera uma string com o novo nome da aba da planilha de Excel.
  • worksheet:Object - espera um objeto referente a planilha de Excel.
    • name:String - espera uma string com o nome da aba da planilha de Excel.
    • workbook:Object - espera um objeto referente a planilha de Excel.
      • filePath:String - espera uma string com o caminho da planilha de Excel.

Parâmetros opcionais​

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

Retorno​

Este método não possui retorno.

selectWorksheet​

Método responsável por selecionar uma aba de um arquivo de Excel.

const selectWorksheet = await Office.Excel.selectWorksheet["v1_0_0"]({
  name: `teste`,
  workbook: {
    filePath: "C:\\Users\\nome-de-usuario\\Desktop\\teste.xlsx",
  },
});

Parâmetros obrigatórios​

  • name:String - espera uma string com o nome da aba da planilha de Excel.
  • workbook:Object - espera um objeto referente a planilha de Excel.
    • filePath:String - espera uma string com o caminho da planilha de Excel.

Parâmetros opcionais​

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

Retorno​

Este método não possui retorno mas a constante criada como selectWorksheet pode ser usada nas outras ações de Excel para indicar qual a aba alvo.

getTableValues​

Método responsável por obter todos os valores de uma tabela de uma aba de Excel.

const getAllTableValues = await actions.Office.Excel.getTableValues["v1_0_1"]({
  name: `Table 1`,
  worksheet: {
    name: `teste`,
    workbook: {
      filePath: "C:\\Users\\igors\\Desktop\\teste.xlsx",
    },
  },
});

Parâmetros obrigatórios​

  • name:String - espera uma string com o nome da tabela.
  • worksheet:Object - espera um objeto referente a planilha de Excel.
    • name:String - espera uma string com o nome da aba da planilha de Excel.
    • workbook:Object - espera um objeto referente a planilha de Excel.
      • filePath:String - espera uma string com o caminho da planilha de Excel.

Parâmetros opcionais​

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

Retorno​

A constante ou variável criada para receber o retorno do método, como a constante getAllTableValues mostrada no exemplo anterior, retornará o método values que recebe uma lista com os valores da tabela.

actions.getAllTableValues.values;

getRawValuesFromWorksheet​

Método responsável por obter todos os valores brutos de uma de uma aba de Excel.

const getRawValuesFromWorksheet = await Office.Excel.getRawValuesFromWorksheet["v1_0_0"]({
  worksheet: {
    name: "Plan1",
    workbook: {
      filePath: "C:\\Users\\Roberty\\Desktop\\teste.xlsx",
    },
  },
  ignoreEmptyRows: true,
});

Parâmetros obrigatórios​

  • worksheet:Object - espera um objeto referente a planilha de Excel.
    • name:String - espera uma string com o nome da aba da planilha de Excel.
    • workbook:Object - espera um objeto referente a planilha de Excel.
      • filePath:String - espera uma string com o caminho da planilha de Excel.
  • ignoreEmptyRows:Boolean - espera um valor booleano que representa se irá ou não ignorar as linhas vazias.

Parâmetros opcionais​

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

Retorno​

A constante ou variável criada para receber o retorno do método, como a constante getRawValuesFromWorksheet mostrada no exemplo anterior, retornará o método values que recebe uma lista com os valores da tabela.

actions.getRawValuesFromWorksheet.values;

getAllValuesFromWorksheet​

Método responsável por obter todos os valores de uma aba de Excel.

const getAllCellValues = await Office.Excel.getAllValuesFromWorksheet["v1_0_0"](
  {
    name: `teste`,
    workbook: {
      filePath: "C:\\Users\\nome-de-usuario\\Desktop\\teste.xlsx",
    },
  }
);

Parâmetros obrigatórios​

  • name:String - espera uma string com o nome da aba da planilha de Excel.
  • workbook:Object - espera um objeto referente a planilha de Excel.
    • filePath:String - espera uma string com o caminho da planilha de Excel.

Parâmetros opcionais​

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

Retorno​

A constante ou variável criada para receber o retorno do método, como a constante getAllCellValues mostrada no exemplo anterior, retornará o método values que recebe uma lista com os valores da tabela.

actions.getAllCellValues.values;

getAllWorksheetName​

Método responsável por obter todos os nomes de abas de um arquivo de Excel.

const getAllWorksheets = await Office.Excel.getAllWorksheetName["v1_0_0"]({
  filePath: "C:\\Users\\nome-de-usuario\\Desktop\\teste.xlsx",
});

Parâmetros obrigatórios​

  • filePath:String - espera uma string com o caminho da planilha de Excel.

Parâmetros opcionais​

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

Retorno​

A constante ou variável criada para receber o retorno do método, como a constante getAllWorksheets mostrada no exemplo anterior, retornará o método worksheets que recebe uma lista com os valores da tabela.

actions.getAllWorksheets.values;

cloneWorksheet​

Método responsável por clonar uma aba de um arquivo de Excel.

await Office.Excel.cloneWorksheet["v1_0_0"]({
  worksheet: {
    name: `teste`,
    workbook: {
      filePath: "C:\\Users\\nome-de-usuario\\Desktop\\teste.xlsx",
    },
  },
  newName: `novaAba`,
});

Parâmetros obrigatórios​

  • newName:String - espera uma string com o novo nome da aba da planilha de Excel.
  • worksheet:Object - espera um objeto referente a planilha de Excel.
    • name:String - espera uma string com o nome da aba da planilha de Excel.
    • workbook:Object - espera um objeto referente a planilha de Excel.
      • filePath:String - espera uma string com o caminho da planilha de Excel.

Parâmetros opcionais​

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

Retorno​

Este método não possui retorno.

deleteWorksheet​

Método responsável por deletar uma aba de um arquivo de Excel.

await Office.Excel.deleteWorksheet["v1_0_0"]({
  name: `novaAba`,
  workbook: {
    filePath: "C:\\Users\\nome-de-usuario\\Desktop\\teste.xlsx",
  },
});

Parâmetros obrigatórios​

  • name:String - espera uma string com o nome da aba da planilha de Excel.
  • workbook:Object - espera um objeto referente a planilha de Excel.
    • filePath:String - espera uma string com o caminho da planilha de Excel.

Parâmetros opcionais​

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

Retorno​

Este método não possui retorno.

setCellValue​

Método responsável por definir um valor para uma célula de um arquivo de Excel.

await Office.Excel.setCellValue["v1_0_0"]({
  value: {
    value: `teste`,
  },
  cell: {
    position: {
      column: `A`,
      row: 1,
    },
    worksheet: {
      name: `teste`,
      workbook: {
        filePath: "C:\\Users\\nome-de-usuario\\Desktop\\teste.xlsx",
      },
    },
  },
});

Parâmetros obrigatórios​

  • value:Object - espera um objeto referente ao valor a ser inserido na célula.
    • value:String - espera uma string com o valor que será inserido na célula.
  • cell:Object - espera um objeto referente a planilha de Excel.
    • position:Object - espera um objeto referente a planilha de Excel.
      • column:String - espera uma string com o novo nome da aba da planilha de Excel.
      • row:Number - espera uma string com o novo nome da aba da planilha de Excel.
  • worksheet:Object - espera um objeto referente a planilha de Excel.
    • name:String - espera uma string com o nome da aba da planilha de Excel.
    • workbook:Object - espera um objeto referente a planilha de Excel.
      • filePath:String - espera uma string com o caminho da planilha de Excel.

Parâmetros opcionais​

  • value:Object - espera um objeto referente ao valor a ser inserido na célula.
    • formula:String - espera uma string com a formula que será inseridoana célula.
  • lastRowColumn: Boolean - espera um valor true ou false, caso verdadeiro sempre preencherá após a última célula preenchida da coluna passada pelo usuário no campo column.

Retorno​

Este método não possui retorno.

setRowValues​

Método responsável por definir um valor para uma célula de um arquivo de Excel.

await Office.Excel.setRowValues["v1_0_0"]({
  values: [{value: `teste-1`},{value: `teste-2`}]
  cell: {
    position: {
      column: `A`,
      row: 1,
    },
    worksheet: {
      name: `teste`,
      workbook: {
        filePath: "C:\\Users\\nome-de-usuario\\Desktop\\teste.xlsx",
      },
    },
  }
});

Parâmetros obrigatórios​

  • values:Array - espera um array de objetos referente aos valores a serem inseridos em cada célula da linha. O objeto deve conter a propriedade abaixo:
    • value:String - espera uma string com o valor que será inserido na célula. Vale ressaltar que também funciona com fórmulas.
  • cell:Object - espera um objeto referente a planilha de Excel.
    • position:Object - espera um objeto referente as informações necessárias para o preenchimento da linha.
      • column:String - espera uma string com a letra da coluna onde o preenchimento iniciará.
      • row:Number - espera um número que representará a linha em que o preenchimento iniciará.
  • worksheet:Object - espera um objeto referente a planilha de Excel.
    • name:String - espera uma string com o nome da aba da planilha de Excel.
    • workbook:Object - espera um objeto referente a planilha de Excel.
      • filePath:String - espera uma string com o caminho da planilha de Excel.

Parâmetros opcionais:​

  • lastRow: Boolean - espera um valor true ou false, caso verdadeiro sempre preencherá após a última linha preenchida da planilha.
  • lastRowColumn: Boolean - espera um valor true ou false, caso verdadeiro sempre preencherá após a última linha preenchida referente a COLUNA passada pelo usuário no campo column.

Retorno​

Este método não possui retorno.

getCellValue​

Método responsável por obter o valor de uma célula de um arquivo de Excel.

const getCellValue = await Office.Excel.getCellValue["v1_0_0"]({
  position: {
    column: `A`,
    row: 1,
  },
  worksheet: {
    name: `teste`,
    workbook: {
      filePath: "C:\\Users\\nome-de-usuario\\Desktop\\teste.xlsx",
    },
  },
});

Parâmetros obrigatórios​

  • position:Object - espera um objeto referente a posição da célula.
    • column:String - espera uma string com o nome da coluna desejada.
    • row:Number - espera um número referente ao valor da linha desejada.
  • worksheet:Object - espera um objeto referente a planilha de Excel.
    • name:String - espera uma string com o nome da aba da planilha de Excel.
    • workbook:Object - espera um objeto referente a planilha de Excel.
      • filePath:String - espera uma string com o caminho da planilha de Excel.

Parâmetros opcionais​

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

Retorno​

A constante ou variável criada para receber o retorno do método, como a constante getCellValue mostrada no exemplo anterior, retornará o método value e formula, que recebem o valor referente ao valor na célula.

actions.getCellValue.value;
actions.getCellValue.formula;

deleteColumn​

Método responsável por deletar uma coluna de uma aba de um arquivo de Excel.

await Office.Excel.deleteColumn["v1_0_0"]({
  column: `A`,
  worksheet: {
    name: `teste`,
    workbook: {
      filePath: "C:\\Users\\nome-de-usuario\\Desktop\\teste.xlsx",
    },
  },
});

Parâmetros obrigatórios​

  • column:String - espera uma string com o nome da coluna desejada.
  • worksheet:Object - espera um objeto referente a planilha de Excel.
    • name:String - espera uma string com o nome da aba da planilha de Excel.
    • workbook:Object - espera um objeto referente a planilha de Excel.
      • filePath:String - espera uma string com o caminho da planilha de Excel.

Parâmetros opcionais​

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

Retorno​

Este método não possui retorno.

deleteRow​

Método responsável por deletar uma linha de uma aba de um arquivo de Excel.

await Office.Excel.deleteRow["v1_0_0"]({
  row: 1,
  worksheet: {
    name: `teste`,
    workbook: {
      filePath: "C:\\Users\\nome-de-usuario\\Desktop\\teste.xlsx",
    },
  },
});

Parâmetros obrigatórios​

  • row:Number - espera um número referente ao valor da linha desejada.
  • worksheet:Object - espera um objeto referente a planilha de Excel.
    • name:String - espera uma string com o nome da aba da planilha de Excel.
    • workbook:Object - espera um objeto referente a planilha de Excel.
      • filePath:String - espera uma string com o caminho da planilha de Excel.

Parâmetros opcionais​

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

Retorno​

Este método não possui retorno.

setCellStyle​

Ação responsável por criar um estilo de uma célula de uma planilha Excel.

await Office.Excel.setCellComment["v1_0_0"]({
  cell: {
        position: {
          column: 'A',
          row: 1,
        },
        worksheet: {
          name: 'teste',
          workbook: {
            filePath: 'C:/Users/nome-de-usuario/Desktop/teste.xlsx',
          },
        },
      },
      color: '#0fd3b1',
      backgroundColor: '#473bfa',
});

Parâmetros obrigatórios​

  • color:String - espera uma string com o valor hexadecimal da cor do texto que será inserido na célula.
  • backgroundColor:String - espera uma string com o valor hexadecimal da cor de fundo que será inserido na célula.
  • cell:Object - espera um objeto referente a planilha de Excel.
    • position:Object - espera um objeto referente a planilha de Excel.
      • column:String - espera uma string com o novo nome da aba da planilha de Excel.
      • row:Number - espera uma string com o novo nome da aba da planilha de Excel.
  • worksheet:Object - espera um objeto referente a planilha de Excel.
    • name:String - espera uma string com o nome da aba da planilha de Excel.
    • workbook:Object - espera um objeto referente a planilha de Excel.
      • filePath:String - espera uma string com o caminho da planilha de Excel.

Retorno​

Este método não possui retorno.

setCellComment​

Ação responsável por criar um comentário em uma planilha Excel.

await Office.Excel.setCellComment["v1_0_0"]({
  cell: {
    position: {
      column: 'A',
      row: 1,
    },
    worksheet: {
      name: 'teste',
      workbook: {
        filePath: 'C:/Users/nome-de-usuario/Desktop/teste.xlsx',
      },
    },
  },
  comment: 'teste',
});

Parâmetros obrigatórios​

  • comment:String - espera uma string com o comentário que será inserido na célula.
  • cell:Object - espera um objeto referente a planilha de Excel.
    • position:Object - espera um objeto referente a planilha de Excel.
      • column:String - espera uma string com o novo nome da aba da planilha de Excel.
      • row:Number - espera uma string com o novo nome da aba da planilha de Excel.
  • worksheet:Object - espera um objeto referente a planilha de Excel.
    • name:String - espera uma string com o nome da aba da planilha de Excel.
    • workbook:Object - espera um objeto referente a planilha de Excel.
      • filePath:String - espera uma string com o caminho da planilha de Excel.

Retorno​

Este método não possui retorno.

deleteComment​

Ação responsável por remover um comentário de uma planilha de Excel.

await Office.Excel.deleteColumn["v1_0_0"]({
  cell:{
    position: {
      column: 'A',
      row: 1,
    },
    worksheet: {
      name: `teste`,
      workbook: {
        filePath: "C:\\Users\\nome-de-usuario\\Desktop\\teste.xlsx",
      },
    },
  }
});

Retorno​

Este método não possui retorno.

Parâmetros obrigatórios​

  • comment:String - espera uma string com o comentário que será inserido na célula.
  • cell:Object - espera um objeto referente a planilha de Excel.
    • position:Object - espera um objeto referente a planilha de Excel.
      • column:String - espera uma string com o novo nome da aba da planilha de Excel.
      • row:Number - espera uma string com o novo nome da aba da planilha de Excel.
  • worksheet:Object - espera um objeto referente a planilha de Excel.
    • name:String - espera uma string com o nome da aba da planilha de Excel.
    • workbook:Object - espera um objeto referente a planilha de Excel.
      • filePath:String - espera uma string com o caminho da planilha de Excel.

Retorno​

Este método não possui retorno.

addPicture​

Método responsável adicionar uma imagem a uma célula de um arquivo de Excel.

await Office.Excel.addPicture["v1_0_0"]({
  cell: {
    position: {
      column: `A`,
      row: 1,
    },
    worksheet: {
      name: `teste`,
      workbook: {
        filePath: "C:\\Users\\nome-de-usuario\\Desktop\\teste.xlsx",
      },
    },
  },
  name: `picture1`,
  path: `C:\\Users\\nome-de-usuario\\Desktop\\teste.png`,
});

Parâmetros obrigatórios​

  • cell:Object - espera um objeto referente a posição da célula.
    • position:Object - espera um objeto referente a posição da célula.
      • column:String - espera uma string com o nome da coluna desejada.
      • row:Number - espera um número referente ao valor da linha desejada.
    • worksheet:Object - espera um objeto referente a planilha de Excel.
      • name:String - espera uma string com o nome da aba da planilha de Excel.
      • workbook:Object - espera um objeto referente a planilha de Excel.
        • filePath:String - espera uma string com o caminho da planilha de Excel.
  • name:String - espera uma string com o nome desejado para a imagem.
  • path:String - espera uma string com o caminho da imagem que será inserida.

Parâmetros opcionais​

  • percentSize:Number - espera um número referente ao tamanho, em porcentagem, que a figura terá.

Retorno​

Este método não possui retorno.

removeAllPictures​

Método responsável por fechar um arquivo de Excel.

await Office.Excel.removeAllPictures["v1_0_0"]({
  name: `teste`,
  workbook: {
    filePath: "C:\\Users\\nome-de-usuario\\Desktop\\teste.xlsx",
  },
});

Parâmetros obrigatórios​

  • name:String - espera uma string com o nome da aba da planilha de Excel.
  • workbook:Object - espera um objeto referente a planilha de Excel.
    • filePath:String - espera uma string com o caminho da planilha de Excel.

Parâmetros opcionais​

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

Retorno​

Este método não possui retorno.

removePicture​

Método responsável por fechar um arquivo de Excel.

await Office.Excel.removePicture["v1_0_0"]({
  name: `picture1`,
  worksheet: {
    name: `teste`,
    workbook: {
      filePath: "C:\\Users\\nome-de-usuario\\Desktop\\teste.xlsx",
    },
  },
});

Parâmetros obrigatórios​

  • name:String - espera uma string com o nome da imagem que será removida da planilha de Excel.
  • worksheet:Object - espera um objeto referente a planilha de Excel.
    • name:String - espera uma string com o nome da aba da planilha de Excel.
    • workbook:Object - espera um objeto referente a planilha de Excel.
      • filePath:String - espera uma string com o caminho da planilha de Excel.

Parâmetros opcionais​

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

Retorno​

Este método não possui retorno.

convertExcelToCSV​

Método responsável por converter um aba de um arquivo excel (.xlsx) em um csv separado por vírgulas.

await Office.Excel.convertExcelToCSV["v1_0_0"]({
  workbook: workbook,
  saveFilePath: "C:\\Users\\nome-de-usuario\\Desktop\\arquivo.csv",
  sheetName: `Plan1`
});

Parâmetros obrigatórios​

  • workbook: Workbook object - espera um objeto de planilha que pode ser obtido através da ação openWorkbook;
  • saveFilePath: String - espera um caminho onde será criado e salvo o arquivo .csv;
  • sheetName: String - espera o nome da aba que já existe na planilha e que será transformada em .csv.

Parâmetros opcionais​

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

Retorno​

Este método não possui retorno.

convertCSVToExcel​

Método responsável por converter um arquivo .csv em um arquivo .xslx com uma aba preenchida com as informações do CSV. A aba criada será com o nome padrão Plan1 em inglês ou Planilha1em português dependendo da linguagem padrão da máquina do usuário.

await Office.Excel.convertCSVToExcel["v1_0_0"]({
 csvPath: `C:\\Users\\Roberty\\Downloads\\arquivo.csv`,
  excelPath: `C:\\Users\\Roberty\\Downloads\\excel.xlsx`
});

Parâmetros obrigatórios​

  • csvPath: String - espera um caminho onde será está o arquivo .csv que será convertido em uma aba.
  • excelPath: String - espera o caminho onde será criado o arquivo .xlsx.

Parâmetros opcionais​

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

Retorno​

Este método não possui retorno.