Excel.Table interface

Representa uma tabela do Excel. Para saber mais sobre o modelo de objeto de tabela, leia trabalhar com tabelas usando a API JavaScript do Excel.

Propriedades

autoFilter

Representa o objeto AutoFilter da tabela.

columns

Representa uma coleção de todas as colunas na tabela.

highlightFirstColumn

Especifica se a primeira coluna contém formatação especial.

highlightLastColumn

Especifica se a última coluna contém formatação especial.

id

Retorna um valor que identifica de forma exclusiva a tabela em uma determinada pasta de trabalho. O valor do identificador permanece o mesmo, ainda que a tabela seja renomeada.

legacyId

Retorna uma ID numérica.

name

Nome da tabela.

O nome do conjunto da tabela deve seguir as diretrizes especificadas no artigo renomear uma tabela do Excel .

rows

Representa uma coleção de todas as linhas na tabela.

showBandedColumns

Especifica se as colunas mostram a formatação em tiras nas quais as colunas ímpares são realçadas de forma diferente de mesmo para tornar a leitura da tabela mais fácil.

showBandedRows

Especifica se as linhas mostram a formatação em tiras nas quais as linhas ímpares são realçadas de forma diferente de mesmo para tornar a leitura da tabela mais fácil.

showFilterButton

Especifica se os botões de filtro estão visíveis na parte superior de cada cabeçalho de coluna. Essa configuração só será permitida se a tabela tiver uma linha de cabeçalho.

showHeaders

Especifica se a linha de cabeçalho está visível. Esse valor pode ser definido para mostrar ou remover a linha do cabeçalho.

showTotals

Especifica se a linha de total está visível. Esse valor pode ser definido para mostrar ou remover a linha do total.

sort

Representa a classificação da tabela.

style

Valor da constante que representa o estilo de Tabela. Os valores possíveis são: "TableStyleLight1" por meio de "TableStyleLight21", "TableStyleMedium1" até "TableStyleMedium28", "TableStyleDark1" até "TableStyleDark11". Também é possível usar um estilo definido pelo usuário que esteja presente na planilha.

worksheet

A planilha que contém a tabela atual.

Métodos

clearFilters()

Limpa todos os filtros aplicados à tabela no momento.

convertToRange()

Converte a tabela em um intervalo de células normal. Todos os dados são preservados.

delete()

Exclui a tabela.

getDataBodyRange()

Obtém o objeto de intervalo associado ao corpo de dados da tabela.

getHeaderRowRange()

Obtém o objeto de intervalo associado à linha de cabeçalho da tabela.

getRange()

Obtém o objeto de intervalo associado a toda a tabela.

getTotalRowRange()

Obtém o objeto de intervalo associado à linha de totais da tabela.

load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

reapplyFilters()

Aplica novamente todos os filtros à tabela.

Detalhes da propriedade

autoFilter

Representa o objeto AutoFilter da tabela.

readonly autoFilter: AutoFilter;

Valor da propriedade

columns

Representa uma coleção de todas as colunas na tabela.

readonly columns: TableColumnCollection;

Valor da propriedade

highlightFirstColumn

Especifica se a primeira coluna contém formatação especial.

highlightFirstColumn: boolean;

Valor da propriedade

boolean

highlightLastColumn

Especifica se a última coluna contém formatação especial.

highlightLastColumn: boolean;

Valor da propriedade

boolean

id

Retorna um valor que identifica de forma exclusiva a tabela em uma determinada pasta de trabalho. O valor do identificador permanece o mesmo, ainda que a tabela seja renomeada.

readonly id: string;

Valor da propriedade

string

legacyId

Retorna uma ID numérica.

readonly legacyId: string;

Valor da propriedade

string

name

Nome da tabela.

O nome do conjunto da tabela deve seguir as diretrizes especificadas no artigo renomear uma tabela do Excel .

name: string;

Valor da propriedade

string

rows

Representa uma coleção de todas as linhas na tabela.

readonly rows: TableRowCollection;

Valor da propriedade

showBandedColumns

Especifica se as colunas mostram a formatação em tiras nas quais as colunas ímpares são realçadas de forma diferente de mesmo para tornar a leitura da tabela mais fácil.

showBandedColumns: boolean;

Valor da propriedade

boolean

showBandedRows

Especifica se as linhas mostram a formatação em tiras nas quais as linhas ímpares são realçadas de forma diferente de mesmo para tornar a leitura da tabela mais fácil.

showBandedRows: boolean;

Valor da propriedade

boolean

showFilterButton

Especifica se os botões de filtro estão visíveis na parte superior de cada cabeçalho de coluna. Essa configuração só será permitida se a tabela tiver uma linha de cabeçalho.

showFilterButton: boolean;

Valor da propriedade

boolean

showHeaders

Especifica se a linha de cabeçalho está visível. Esse valor pode ser definido para mostrar ou remover a linha do cabeçalho.

showHeaders: boolean;

Valor da propriedade

boolean

showTotals

Especifica se a linha de total está visível. Esse valor pode ser definido para mostrar ou remover a linha do total.

showTotals: boolean;

Valor da propriedade

boolean

sort

Representa a classificação da tabela.

readonly sort: TableSort;

Valor da propriedade

Exemplos

// Get the current worksheet.
let workbook = context.workbook;
let worksheets = workbook.worksheets;
let selectedSheet = worksheets.getActiveWorksheet();

// Create a table with the used cells.
let usedRange = selectedSheet.getUsedRange();
let newTable = selectedSheet.tables.add(usedRange, true);

// Sort the table using the first column.
newTable.sort.apply([{ key: 0, ascending: true }]);

style

Valor da constante que representa o estilo de Tabela. Os valores possíveis são: "TableStyleLight1" por meio de "TableStyleLight21", "TableStyleMedium1" até "TableStyleMedium28", "TableStyleDark1" até "TableStyleDark11". Também é possível usar um estilo definido pelo usuário que esteja presente na planilha.

style: string;

Valor da propriedade

string

worksheet

A planilha que contém a tabela atual.

readonly worksheet: Worksheet;

Valor da propriedade

Detalhes do método

clearFilters()

Limpa todos os filtros aplicados à tabela no momento.

clearFilters(): void;

Retornos

void

convertToRange()

Converte a tabela em um intervalo de células normal. Todos os dados são preservados.

convertToRange(): Range;

Retornos

delete()

Exclui a tabela.

delete(): void;

Retornos

void

getDataBodyRange()

Obtém o objeto de intervalo associado ao corpo de dados da tabela.

getDataBodyRange(): Range;

Retornos

getHeaderRowRange()

Obtém o objeto de intervalo associado à linha de cabeçalho da tabela.

getHeaderRowRange(): Range;

Retornos

getRange()

Obtém o objeto de intervalo associado a toda a tabela.

getRange(): Range;

Retornos

getTotalRowRange()

Obtém o objeto de intervalo associado à linha de totais da tabela.

getTotalRowRange(): Range;

Retornos

load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNames?: string | string[]): void;

Parâmetros

propertyNames
string | string[]

Uma cadeia de caracteres delimitada por vírgula ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.

Retornos

void

reapplyFilters()

Aplica novamente todos os filtros à tabela.

reapplyFilters(): void;

Retornos

void