Ações do Excel
Ações do Excel são ações para interagir com arquivos do Excel.
Ações
excel.append
Anexe novas linhas ao final da planilha.
Parâmetros:
worksheet - planilha a ser usada para obtenção de células.
line_values (opcional) - array com cada índice sendo uma coluna diferente, exemplo:
grid_values (opcional) - uma grade onde cada linha representará uma linha e cada elemento de linha representará uma coluna, exemplo:
[
['Linha 1 - Col1', 'Linha 1 - Col2', 'Linha 1 - Col3'],
['Linha 2 - Col1', 'Linha 2 - Col2', 'Linha 2 - Col3']
]
Retorna:
Esta ação não tem retorno.
Exceções:
Esta ação não retorna nenhuma exceção
excel.convert_to_xlsx
Converta qualquer tipo de arquivo que o Excel possa abrir (por exemplo: XLS, CSV), para arquivo XLSX. O arquivo convertido será salvo no mesmo caminho e com o mesmo nome, com extensão .xlsx.
Importante: Para utilizar esta ação, o software Excel deve estar instalado na máquina e todas as janelas do Excel devem estar fechadas.
Parâmetros:
filepath - Caminho para o arquivo que será convertido.
Retorna:
Esta ação não tem retorno.
Exceções:
Esta ação não retorna nenhuma exceção
excel.create_new
Crie uma planilha completamente nova.
Importante: para salvar esta planilha em uma pasta, deve-se chamar a ação excel.save.
Parâmetros:
Esta ação não tem parâmetros.
Retorna:
workbook - Pasta de trabalho a ser usada com outras ações do Excel
worksheet - planilha ativa do arquivo
Exceções:
Esta ação não retorna nenhuma exceção
excel.create_sheet
Crie uma nova planilha no arquivo do Excel (pasta de trabalho).
Importante: para salvar esta nova pasta de planilha, a ação excel.save deve ser chamada.
Parâmetros:
workbook - Pasta de trabalho que foi atualizada.
sheet_name - nome a ser dado à nova planilha
Retorna:
workbook - Pasta de trabalho a ser usada com outras ações do Excel
worksheet - planilha ativa do arquivo
Exceções:
Esta ação não retorna nenhuma exceção
excel.delete_rows
Exclui todas as linhas entre o número da linha inicial e o número da linha final.
Parâmetros:
worksheet - Planilha a ser usada para excluir linhas.
start - número da primeira linha a ser excluída.
end (opcional) - número da última linha a ser excluída. Se apenas uma linha precisam ser deletados, este parâmetro não precisa ser informado.
Retorna:
Esta ação não tem retorno.
Exceções:
Esta ação não retorna nenhuma exceção
excel.get_cell
Retorna o valor de uma célula ou um intervalo de células.
Parâmetros:
worksheet - Planilha a ser usada para obtenção de células.
range - Intervalo das células para obter valor usando o padrão Excel, ex: A1:C3
Retorna:
first_col - Letra da primeira coluna retornada
first_row - Número da primeira linha retornada
last_col - Letra da última coluna retornada
last_row - Número da última linha retornada
values - Array de valores, onde o primeiro índice se for a linha, e o segundo se a coluna, ex: values[0][1] obterá os valores da primeira linha, segunda coluna.
Exceções:
InvalidRange: quando um intervalo incorreto ou inválido, se fornecido
excel.get_dimensions
Retorne as dimensões da planilha como intervalo do Excel.
Parâmetros:
worksheet - Planilha para retornar a última linha.
Retorna:
range - Intervalo da área da planilha utilizada, conforme padrão Excel. Ex: A1: F150.
first_cell - Referência da primeira célula do intervalo, ex: A1.
last_cell - Referência da última célula do intervalo, ex: F150.
Exceções:
Esta ação não retorna nenhuma exceção
excel.last_line
Retorna a última linha da planilha
Parâmetros:
worksheet - Planilha para retornar a última linha.
Retorna:
last_line - Número da última linha da planilha
Exceções:
Esta ação não retorna nenhuma exceção
excel.open
Abra um determinado arquivo do Excel para começar a interagir com outras ações do Excel.
Parâmetros:
filepath - caminho para o arquivo Excel.
Retorna:
workbook - Pasta de trabalho a ser usada com outras ações do Excel
worksheet - planilha ativa do arquivo
Exceções:
FileNotFoundException: se o caminho do arquivo estiver errado ou não existir.
excel.save
Salva a pasta de trabalho com todas as atualizações.
Parâmetros:
workbook - Pasta de trabalho que foi atualizada.
filepath - Nome do arquivo com o caminho completo do arquivo, para salvar o local.
Retorna:
Esta ação não tem retorno
Exceções:
FileNotFoundException: se o caminho do arquivo fornecido não puder ser usado.
excel.select_sheet
Seleciona uma nova planilha para usar com o arquivo Excel.
Parâmetros:
workbook - Pasta de trabalho retornada como excel.open.
sheet_name (opcional) - Nome da planilha a ser retornada. Se nenhum nome de planilha for fornecido, retornará a planilha ativa
Retorna:
workbook - Pasta de trabalho a ser usada com outras ações do Excel
worksheet - Planilha com o nome fornecido ou planilha ativa do arquivo se nenhum sheet_name for fornecido.
Exceções:
Esta ação não retorna nenhuma exceção
excel.update_cell
Atualiza o valor de uma determinada célula no arquivo Excel.
Parâmetros:
worksheet - Planilha a ser usada para obtenção de células.
value - Valor a ser inserido na célula fornecida.
cell - Referência da célula, utilizando padrão Excel, ex: A1
Retorna:
first_col - Letra da primeira coluna retornada
first_row - Número da primeira linha retornada
last_col - Letra da última coluna retornada
last_row - Número da última linha retornada
values - Array de valores, onde o primeiro índice se for a linha, e o segundo se a coluna, ex: values[0][1] obterá os valores da primeira linha, segunda coluna.
Exceções:
InvalidRange: quando um intervalo incorreto ou inválido, se fornecido
excel.create_style_template
Cria um modelo com estilo para o Excel.
Parâmetros:
font_name - Nome da fonte.
font_size - Tamanho da fonte.
bold - Valor booleano para negrito.
italic - Valor booleano para itálico.
underline - Valor booleano para sublinhado.
font_color - Cor da fonte.
background_color - Cor do plano de fundo.
border_style - Estilo para a borda.
border_color - Cor da borda.
Retorna:
template - retorna o modelo do Excel
Exceções:
Esta ação não retorna nenhuma exceção
excel.execute_macro
Executa macro.
Parâmetros:
file_path - O caminho para o arquivo.
macro - macro que será executada.
save_after_execution - Booleano para salvar após a execução.
Retorna:
Esta ação retorna nula.
Exceções:
Esta ação não retorna nenhuma exceção
excel.list_sheets
Retorna uma lista de todas as planilhas do arquivo e qual está ativa.
Parâmetros:
workbook - A pasta de trabalho a ser verificada.
Retorna:
sheets - nomes de planilhas da pasta de trabalho.
active_sheet - A planilha ativa da pasta de trabalho.
Exceções:
Esta ação não retorna nenhuma exceção
excel.rename_sheet
Renomeia a planilha fornecida.
Parâmetros:
worksheet - A planilha a ser renomeada.
new_name - Um novo nome a ser dado à planilha.
Retorna:
worksheet - Uma planilha atualizada com novo nome.
Exceções:
Esta ação não retorna nenhuma exceção
excel.set_style
Define um estilo para uma planilha.
Parâmetros:
worksheet - A planilha para definir o estilo.
range - O intervalo em que será definido o estilo.
font_name - O nome da fonte.
font_size - O tamanho da fonte.
bold - Valor booleano para negrito.
italic - Valor booleano para itálico.
underline - Pode ser qualquer um dos seguintes 'single', 'singleAccounting', 'doubleAccounting', 'double'.
font_color - A cor da fonte.
background_color - A cor do plano de fundo.
border_style - Pode ser qualquer um dos seguintes 'fino', 'nenhum', 'duplo', 'espesso', 'tracejado', 'médio', 'pontilhado'.
border_color - A cor da borda.
Retorna:
Esta ação retorna nula.
Exceções:
Esta ação não retorna nenhuma exceção.
excel.set_table_format
Define um formato para a tabela.
Parâmetros:
worksheet - A planilha que contém a tabela a ser formatada.
range - O intervalo em que a tabela será formatada.
header_style - O nome da fonte.
odd_line_style - O estilo da linha ímpar.
even_line_style - O estilo da linha par.
Retorna:
Esta ação retorna nula.
Exceções:
WrongVarType: se a var fornecida for inválida.
excel.set_template
Define o modelo para a planilha.
Parâmetros:
worksheet - A planilha na qual o modelo será definido.
range - O intervalo que a planilha terá o template definido.
template - O modelo a ser definido.
Retorna:
Esta ação retorna nula.
Exceções:
Esta ação não retorna nenhuma exceção.