Excel.Table class
Representa uma tabela do Excel. Para saber mais sobre o modelo de objeto de tabela, leia Trabalhar com tabelas com a API JavaScript do Excel.
- Extends
Comentários
[ Conjunto de API: ExcelApi 1.1 ]
Propriedades
| columns | Representa uma coleção de todas as colunas na tabela. |
| context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office. |
| 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. |
| name | Nome da tabela. O nome do conjunto da tabela tem de seguir as diretrizes especificadas no artigo Mudar o nome de uma tabela do Excel . |
| rows | Representa uma coleção de todas as linhas na tabela. |
| show |
Especifica se a linha de cabeçalho está visível. Esse valor pode ser definido para mostrar ou remover a linha do cabeçalho. |
| show |
Especifica se a linha total está visível. Esse valor pode ser definido para mostrar ou remover a linha do total. |
| style | Valor constante que representa o estilo de tabela. Os valores possíveis são: "TableStyleLight1" até "TableStyleLight21", "TableStyleMedium1" até "TableStyleMedium28", "TableStyleDark1" até "TableStyleDark11". Também é possível usar um estilo definido pelo usuário que esteja presente na planilha. |
Métodos
| delete() | Exclui a tabela. |
| get |
Obtém o objeto de intervalo associado ao corpo de dados da tabela. |
| get |
Obtém o objeto de intervalo associado à linha de cabeçalho da tabela. |
| get |
Obtém o objeto de intervalo associado a toda a tabela. |
| get |
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 |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| set(properties, options) | Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo. |
| set(properties) | Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente. |
| toJSON() | Substitui o método JavaScript |
Detalhes da propriedade
columns
Representa uma coleção de todas as colunas na tabela.
readonly columns: Excel.TableColumnCollection;Valor da propriedade
Comentários
context
O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.
context: RequestContext;Valor da propriedade
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
name
Nome da tabela.
O nome do conjunto da tabela tem de seguir as diretrizes especificadas no artigo Mudar o nome de 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
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
style
Valor constante que representa o estilo de tabela. Os valores possíveis são: "TableStyleLight1" até "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
Comentários
[ Conjunto de API: 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);
});
Detalhes do método
delete()
Exclui a tabela.
delete(): void;Retornos
void
Comentários
[ Conjunto de API: ExcelApi 1.1 ]
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
Comentários
[ Conjunto de API: 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);
});
getHeaderRowRange()
Obtém o objeto de intervalo associado à linha de cabeçalho da tabela.
getHeaderRowRange(): Excel.Range;Retornos
Comentários
[ Conjunto de API: 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);
});
getRange()
Obtém o objeto de intervalo associado a toda a tabela.
getRange(): Excel.Range;Retornos
Comentários
[ Conjunto de API: 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);
});
getTotalRowRange()
Obtém o objeto de intervalo associado à linha de totais da tabela.
getTotalRowRange(): Excel.Range;Retornos
Comentários
[ Conjunto de API: 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);
});
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
Fornece opções para as propriedades do objeto a carregar.
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[]): Excel.Table;Parâmetros
- propertyNames
-
string | string[]
Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.
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);
});
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 delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.
Retornos
set(properties, options)
Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.
set(properties: Interfaces.TableUpdateData, options?: OfficeExtension.UpdateOptions): void;Parâmetros
- properties
- Excel.Interfaces.TableUpdateData
Um objeto JavaScript com propriedades que são estruturadas isomorfoticamente para as propriedades do objeto no qual o método é chamado.
- options
- OfficeExtension.UpdateOptions
Fornece uma opção para suprimir erros se o objeto de propriedades tentar definir quaisquer propriedades só de leitura.
Retornos
void
set(properties)
Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.
set(properties: Excel.Table): void;Parâmetros
- properties
- Excel.Table
Retornos
void
toJSON()
Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Excel.Table é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.TableData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
toJSON(): Excel.Interfaces.TableData;