Excel.Table class

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

readonly columns: Excel.TableColumnCollection;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.1

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

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

Comentários

Conjunto de APIs: ExcelApi 1.1

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

Comentários

Conjunto de APIs: ExcelApi 1.1

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/46-table/convert-range-to-table.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const expensesTable: Excel.Table = sheet.tables.add('A1:E7', true);
    expensesTable.name = "ExpensesTable";

    await context.sync();
});

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

readonly rows: Excel.TableRowCollection;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.1

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/46-table/add-rows-and-columns-to-a-table.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const expensesTable: Excel.Table = sheet.tables.getItem("ExpensesTable");

    expensesTable.rows.add(null, [
    ["1/16/2017", "THE PHONE COMPANY", "Communications", "$120"],
    ["1/20/2017", "NORTHWIND ELECTRIC CARS", "Transportation", "$142"],
    ["1/20/2017", "BEST FOR YOU ORGANICS COMPANY", "Groceries", "$27"]
    ]);

    sheet.getUsedRange().format.autofitColumns();
    sheet.getUsedRange().format.autofitRows();

    await context.sync();
});

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

showHeaders: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.1

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

showTotals: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.1

Representa a classificação da tabela.

readonly sort: Excel.TableSort;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.2

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/46-table/sort-data.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const expensesTable: Excel.Table = sheet.tables.getItem("ExpensesTable");

    // Sort the table by the "Amount" column.
    const sortFields = [
        {
        key: 3,
        ascending: false
        }
    ];
    expensesTable.sort.apply(sortFields);

    await context.sync();
});

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

style: string;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.1

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);
});

A planilha que contém a tabela atual.

readonly worksheet: Excel.Worksheet;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.2

Limpa todos os filtros aplicados à tabela no momento.

clearFilters(): void;

Retornos

Comentários

Conjunto de APIs: ExcelApi 1.2

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/46-table/filter-data.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const expensesTable = sheet.tables.getItem("ExpensesTable");
    expensesTable.clearFilters();
    await context.sync();
   });

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

convertToRange(): Excel.Range;

Retornos

Comentários

Conjunto de APIs: ExcelApi 1.2

Exemplos

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

Exclui a tabela.

delete(): void;

Retornos

Comentários

Conjunto de APIs: ExcelApi 1.1

Exemplos

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

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

getDataBodyRange(): Excel.Range;

Retornos

Comentários

Conjunto de APIs: ExcelApi 1.1

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);
});

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

getHeaderRowRange(): Excel.Range;

Retornos

Comentários

Conjunto de APIs: ExcelApi 1.1

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);
});

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

getRange(): Excel.Range;

Retornos

Comentários

Conjunto de APIs: ExcelApi 1.1

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);
});

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

getTotalRowRange(): Excel.Range;

Retornos

Comentários

Conjunto de APIs: ExcelApi 1.1

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);
});

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

Retornos

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

Retornos

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);
});

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

Retornos

Aplica novamente todos os filtros à tabela.

reapplyFilters(): void;

Retornos

Comentários

Conjunto de APIs: ExcelApi 1.2

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: Interfaces.TableUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

Retornos

Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.

set(properties: Excel.Table): void;

Parâmetros

Retornos

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 original Excel.Table é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.TableData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.

toJSON(): Excel.Interfaces.TableData;

Retornos