Excel. Table class

Propriedades

autoFilter	Representa o `AutoFilter` objeto da tabela.
columns	Representa uma coleção de todas as colunas na tabela.
context	O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
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 definido 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 formatação em banda na qual colunas ímpares são realçadas de forma diferente das até mesmo, para facilitar a leitura da tabela.
showBandedRows	Especifica se as linhas mostram formatação em banda na qual linhas ímpares são realçadas de forma diferente das até mesmo, para facilitar a leitura da tabela.
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 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 constante que representa o estilo de tabela. Os valores possíveis são: "TableStyleLight1" por meio de "TableStyleLight21", "TableStyleMedium1" por "TableStyleMedium28", "TableStyleDark1" até "TableStyleDark11". Também é possível usar um estilo definido pelo usuário que esteja presente na planilha.
tableStyle	O estilo aplicado à tabela.
worksheet	A planilha que contém a tabela atual.

Métodos

clearFilters()	Limpa todos os filtros aplicados à tabela no momento.
clearStyle()	Altera a tabela para usar o estilo de tabela padrão.
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(options)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar `context.sync()` antes de ler as propriedades.
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(propertyNamesAndPaths)	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.
resize(newRange)	Redimensione a tabela para o novo intervalo. O novo intervalo deve se sobrepor ao intervalo de tabela original e os cabeçalhos (ou a parte superior da tabela) devem estar na mesma linha.
set(properties, options)	Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.
set(properties)	Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.
setStyle(style)	Define o estilo aplicado à tabela.
toJSON()	Substitui o método JavaScript `toJSON()` para fornecer uma saída mais útil quando um objeto de API é passado para `JSON.stringify()`. (`JSON.stringify`por sua vez, chama o `toJSON` método do objeto que é passado para ele.) Enquanto o objeto Excel.Table original é um objeto API, o `toJSON` método retorna um objeto JavaScript simples (digitado como `Excel.Interfaces.TableData`) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

Eventos

onChanged	Ocorre quando os dados nas células são alterados em uma tabela específica.
onFiltered	Ocorre quando um filtro é aplicado em uma tabela específica.
onSelectionChanged	Ocorre quando a seleção é alterada em uma tabela específica.

Detalhes da propriedade

autoFilter

Representa o AutoFilter objeto da tabela.

readonly autoFilter: Excel.AutoFilter;

Valor da propriedade

Excel.AutoFilter

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

columns

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

readonly columns: Excel.TableColumnCollection;

Valor da propriedade

Excel.TableColumnCollection

Comentários

context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

context: RequestContext;

Valor da propriedade

Excel.RequestContext

highlightFirstColumn

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

highlightFirstColumn: boolean;

Valor da propriedade

boolean

Comentários

highlightLastColumn

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

highlightLastColumn: boolean;

Valor da propriedade

boolean

Comentários

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

Comentários

legacyId

Retorna uma ID numérica.

readonly legacyId: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

name

Nome da tabela.

O nome definido da tabela deve seguir as diretrizes especificadas no artigo Renomear uma tabela do Excel .

name: string;

Valor da propriedade

string

Comentários

rows

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

readonly rows: Excel.TableRowCollection;

Valor da propriedade

Excel.TableRowCollection

Comentários

showBandedColumns

Especifica se as colunas mostram formatação em banda na qual colunas ímpares são realçadas de forma diferente das até mesmo, para facilitar a leitura da tabela.

showBandedColumns: boolean;

Valor da propriedade

boolean

Comentários

showBandedRows

Especifica se as linhas mostram formatação em banda na qual linhas ímpares são realçadas de forma diferente das até mesmo, para facilitar a leitura da tabela.

showBandedRows: boolean;

Valor da propriedade

boolean

Comentários

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

Comentários

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

Comentários

showTotals

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

showTotals: boolean;

Valor da propriedade

boolean

Comentários

sort

Representa a classificação da tabela.

readonly sort: Excel.TableSort;

Valor da propriedade

Excel.TableSort

Comentários

style

Valor constante que representa o estilo de tabela. Os valores possíveis são: "TableStyleLight1" por meio de "TableStyleLight21", "TableStyleMedium1" por "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

Comentários

[ Conjunto de API: ExcelApi BETA (SOMENTE VERSÃO PRÉVIA) ]

Exemplos

// Set table style.
await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const table = context.workbook.tables.getItem(tableName);
    table.name = 'Table1-Renamed';
    table.showTotals = false;
    table.style = 'TableStyleMedium2';
    table.load('tableStyle');
    await context.sync();
    
    console.log(table.style);
});

tableStyle

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

O estilo aplicado à tabela.

readonly tableStyle: Excel.TableStyle;

Valor da propriedade

Excel.TableStyle

Comentários

worksheet

A planilha que contém a tabela atual.

readonly worksheet: Excel.Worksheet;

Valor da propriedade

Excel.Worksheet

Comentários

Detalhes do método

clearFilters()

Limpa todos os filtros aplicados à tabela no momento.

clearFilters(): void;

Retornos

void

Comentários

[ Conjunto de API: ExcelApi BETA (SOMENTE VERSÃO PRÉVIA) ]

clearStyle()

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Altera a tabela para usar o estilo de tabela padrão.

clearStyle(): void;

Retornos

void

Comentários

convertToRange()

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

convertToRange(): Excel.Range;

Retornos

Excel.Range

Comentários

Exemplos

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const table = context.workbook.tables.getItem(tableName);
    table.convertToRange();
    await context.sync(); 
});

delete()

Exclui a tabela.

delete(): void;

Retornos

void

Comentários

Exemplos

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const table = context.workbook.tables.getItem(tableName);
    table.delete();
    await context.sync(); 
});

getDataBodyRange()

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

getDataBodyRange(): Excel.Range;

Retornos

Excel.Range

Comentários

Exemplos

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const table = context.workbook.tables.getItem(tableName);
    const tableDataRange = table.getDataBodyRange();
    tableDataRange.load('address')
    await context.sync();
    
    console.log(tableDataRange.address);
});

getHeaderRowRange()

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

getHeaderRowRange(): Excel.Range;

Retornos

Excel.Range

Comentários

Exemplos

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const table = context.workbook.tables.getItem(tableName);
    const tableHeaderRange = table.getHeaderRowRange();
    tableHeaderRange.load('address');
    await context.sync();

    console.log(tableHeaderRange.address);
});

getRange()

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

getRange(): Excel.Range;

Retornos

Excel.Range

Comentários

Exemplos

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const table = context.workbook.tables.getItem(tableName);
    const tableRange = table.getRange();
    tableRange.load('address');    
    await context.sync();
    
    console.log(tableRange.address);
});

getTotalRowRange()

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

getTotalRowRange(): Excel.Range;

Retornos

Excel.Range

Comentários

Exemplos

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const table = context.workbook.tables.getItem(tableName);
    const tableTotalsRange = table.getTotalRowRange();
    tableTotalsRange.load('address');    
    await context.sync();
    
    console.log(tableTotalsRange.address);
});

load(options)

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

load(options?: Excel.Interfaces.TableLoadOptions): Excel.Table;

Parâmetros

options: Excel.Interfaces.TableLoadOptions

Fornece opções para quais propriedades do objeto carregar.

Retornos

Excel.Table

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[]): Excel.Table;

Parâmetros

propertyNames: string | string[]

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

Retornos

Excel.Table

Exemplos

// Get a table by name.
await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const table = context.workbook.tables.getItem(tableName);
    table.load('id')
    await context.sync();
    
    console.log(table.id);
});

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.Table;

Parâmetros

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades de navegação a serem carregadas.

Retornos

Excel.Table

reapplyFilters()

Aplica novamente todos os filtros à tabela.

reapplyFilters(): void;

Retornos

void

Comentários