Excel.TableRow class
Representa uma linha em uma tabela.
Tenha em atenção que, ao contrário dos intervalos ou colunas, que serão ajustados se forem adicionadas novas linhas ou colunas antes delas, um TableRow objeto representa a localização física da linha da tabela, mas não os dados. Ou seja, se os dados estiverem ordenados ou se forem adicionadas novas linhas, uma linha de tabela continuará a apontar para o índice para o qual foram criados.
- Extends
Comentários
[ Conjunto de API: ExcelApi 1.1 ]
Propriedades
| context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office. |
| index | Retorna o número de índice da linha na coleção de linhas da tabela. Indexados com zero. |
| values | Representa os valores brutos do intervalo especificado. Os dados devolvidos podem ser uma cadeia, número ou booleano. Células que contêm um erro retornarão a cadeia de caracteres de erro. Se o valor devolvido começar com uma adição ("+"), sinal de subtração ("-"), ou sinal de igual ("="), o Excel interpreta este valor como uma fórmula. |
| values |
Uma representação JSON dos valores nas células nesta linha de tabela. Ao contrário |
| values |
Uma representação JSON dos valores nas células nesta linha de tabela. Ao contrário |
Métodos
| delete() | Exclui a linha da tabela. |
| get |
Retorna o objeto de intervalo associado a toda a linha. |
| 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
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
index
Retorna o número de índice da linha na coleção de linhas da tabela. Indexados com zero.
readonly index: number;Valor da propriedade
number
Comentários
values
Representa os valores brutos do intervalo especificado. Os dados devolvidos podem ser uma cadeia, número ou booleano. Células que contêm um erro retornarão a cadeia de caracteres de erro. Se o valor devolvido começar com uma adição ("+"), sinal de subtração ("-"), ou sinal de igual ("="), o Excel interpreta este valor como uma fórmula.
values: any[][];Valor da propriedade
any[][]
Comentários
valuesAsJson
Uma representação JSON dos valores nas células nesta linha de tabela. Ao contrário TableRow.valuesde , TableRow.valuesAsJson suporta todos os tipos de dados que podem estar numa célula. Os exemplos incluem valores numéricos formatados e imagens Web, para além dos valores booleanos, numéricos e de cadeia padrão. Os dados devolvidos a partir desta API estão sempre alinhados com a região en-US. Para obter dados na região de apresentação do utilizador, utilize TableRow.valuesAsJsonLocal.
valuesAsJson: CellValue[][];Valor da propriedade
Excel.CellValue[][]
Comentários
valuesAsJsonLocal
Uma representação JSON dos valores nas células nesta linha de tabela. Ao contrário TableRow.valuesde , TableRow.valuesAsJsonLocal suporta todos os tipos de dados que podem estar numa célula. Os exemplos incluem valores numéricos formatados e imagens Web, para além dos valores booleanos, numéricos e de cadeia padrão. Os dados devolvidos a partir desta API estão sempre alinhados com a região de apresentação do utilizador. Para obter dados independentemente da região, utilize TableRow.valuesAsJson.
valuesAsJsonLocal: CellValue[][];Valor da propriedade
Excel.CellValue[][]
Comentários
Detalhes do método
delete()
Exclui a linha da tabela.
delete(): void;Retornos
void
Comentários
[ Conjunto de API: ExcelApi 1.1 ]
Exemplos
await Excel.run(async (context) => {
const tableName = 'Table1';
const row = context.workbook.tables.getItem(tableName).rows.getItemAt(2);
row.delete();
await context.sync();
});
getRange()
Retorna o objeto de intervalo associado a toda a linha.
getRange(): Excel.Range;Retornos
Comentários
[ Conjunto de API: ExcelApi 1.1 ]
Exemplos
await Excel.run(async (context) => {
const tableName = 'Table1';
const row = context.workbook.tables.getItem(tableName).rows.getItemAt(0);
const rowRange = row.getRange();
rowRange.load('address');
await context.sync();
console.log(rowRange.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.TableRowLoadOptions): Excel.TableRow;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.TableRow;Parâmetros
- propertyNames
-
string | string[]
Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.
Retornos
Exemplos
await Excel.run(async (context) => {
const tableName = 'Table1';
const row = context.workbook.tables.getItem(tableName).rows.getItemAt(0);
row.load('index');
await context.sync();
console.log(row.index);
});
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.TableRow;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.TableRowUpdateData, options?: OfficeExtension.UpdateOptions): void;Parâmetros
- properties
- Excel.Interfaces.TableRowUpdateData
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.TableRow): void;Parâmetros
- properties
- Excel.TableRow
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.TableRow é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.TableRowData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
toJSON(): Excel.Interfaces.TableRowData;