Excel.TableRowCollection class

Pacote:
excel

Representa uma coleção de todas as linhas que fazem parte da tabela.

Observe que, ao contrário de intervalos ou colunas, que se ajustarão se novas linhas ou colunas forem adicionadas antes deles, um TableRow objeto representa o local físico da linha da tabela, mas não os dados. Ou seja, se os dados forem classificados ou se novas linhas forem adicionadas, uma linha da tabela continuará apontando para o índice para o qual foi criada.

Extends
OfficeExtension.ClientObject

Comentários

Conjunto de APIs: ExcelApi 1.1

Usada por

Exemplos

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

// Get the number of data rows in the table.
await Excel.run(async (context) => {
    const salesTable: Excel.Table = context.workbook.worksheets
        .getItem("Sample")
        .tables.getItem("SalesTable");
    const tableRows: Excel.TableRowCollection = salesTable.rows;
    const rowCount: OfficeExtension.ClientResult<number> = tableRows.getCount();

    await context.sync();
    console.log(`SalesTable contains ${rowCount.value} data rows.`);
});

Propriedades

context

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

Retorna o número de linhas na tabela.
items

Obtém os itens filhos carregados nesta coleção.

Métodos

add(index, values, alwaysInsert)

Adiciona uma ou mais linhas à tabela. O objeto de retorno será a parte superior das linhas adicionadas recentemente.

Observe que, ao contrário de intervalos ou colunas, que se ajustarão se novas linhas ou colunas forem adicionadas antes deles, um TableRow objeto representa o local físico da linha da tabela, mas não os dados. Ou seja, se os dados forem classificados ou se novas linhas forem adicionadas, uma linha da tabela continuará apontando para o índice para o qual foi criada.
getItemAt(index)

Obtém uma linha com base em sua posição na coleção.

Observe que, ao contrário de intervalos ou colunas, que se ajustarão se novas linhas ou colunas forem adicionadas antes deles, um TableRow objeto representa o local físico da linha da tabela, mas não os dados. Ou seja, se os dados forem classificados ou se novas linhas forem adicionadas, uma linha da tabela continuará apontando para o índice para o qual foi criada.
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.
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 original Excel.TableRowCollection é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.TableRowCollectionData) que contém uma matriz "items" com cópias superficiais de todas as propriedades carregadas dos itens da coleção.

Detalhes da propriedade

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

count

Retorna o número de linhas na tabela.

readonly count: number;

Valor da propriedade

number

Comentários

Conjunto de APIs: ExcelApi 1.1

items

Obtém os itens filhos carregados nesta coleção.

readonly items: Excel.TableRow[];

Valor da propriedade

Excel.TableRow[]

Detalhes do método

add(index, values, alwaysInsert)

Adiciona uma ou mais linhas à tabela. O objeto de retorno será a parte superior das linhas adicionadas recentemente.

Observe que, ao contrário de intervalos ou colunas, que se ajustarão se novas linhas ou colunas forem adicionadas antes deles, um TableRow objeto representa o local físico da linha da tabela, mas não os dados. Ou seja, se os dados forem classificados ou se novas linhas forem adicionadas, uma linha da tabela continuará apontando para o índice para o qual foi criada.

add(index?: number, values?: Array<Array<boolean | string | number>> | boolean | string | number, alwaysInsert?: boolean): Excel.TableRow;

Parâmetros

index

number

Opcional. Especifica a posição relativa da nova linha. Se for null ou -1, a adição ocorre no final. Todas as linhas abaixo da linha inserida serão deslocadas para baixo. Indexado com zero.

values

Array<Array<boolean | string | number>> | boolean | string | number

Opcional. Uma matriz 2D de valores não formatados da linha da tabela.

alwaysInsert

boolean

Opcional. Especifica se as novas linhas serão inseridas na tabela quando novas linhas forem adicionadas. Se true, as novas linhas serão inseridas na tabela. Se false, as novas linhas serão adicionadas abaixo da tabela. O padrão é true.

Retornos

Excel.TableRow

Comentários

Conjunto de APIs: ExcelApi 1.1 para adicionar uma única linha; 1.4 permite a adição de várias linhas; 1.15 para adicionar alwaysInsert parâmetro.

Exemplos

await Excel.run(async (context) => { 
    const tables = context.workbook.tables;
    const values = [["Sample", "Values", "For", "New", "Row"]];
    const row = tables.getItem("Table1").rows.add(null, values);
    row.load('index');
    await context.sync();
    
    console.log(row.index);
});

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

// Add two rows to the end of the table.
await Excel.run(async (context) => {
    const salesTable: Excel.Table = context.workbook.worksheets
        .getItem("Sample")
        .tables.getItem("SalesTable");
    const tableRows: Excel.TableRowCollection = salesTable.rows;

    tableRows.add(null, [
        ["Zoran Dimovski", "North", 1200],
        ["Immanuel Vogel", "South", 950]
    ]);

    await context.sync();
    console.log("Added two rows to SalesTable.");
});

getItemAt(index)

Obtém uma linha com base em sua posição na coleção.

Observe que, ao contrário de intervalos ou colunas, que se ajustarão se novas linhas ou colunas forem adicionadas antes deles, um TableRow objeto representa o local físico da linha da tabela, mas não os dados. Ou seja, se os dados forem classificados ou se novas linhas forem adicionadas, uma linha da tabela continuará apontando para o índice para o qual foi criada.

getItemAt(index: number): Excel.TableRow;

Parâmetros

index

number

Valor de índice do objeto a ser recuperado. Indexados com zero.

Retornos

Excel.TableRow

Comentários

Conjunto de APIs: ExcelApi 1.1

Exemplos

await Excel.run(async (context) => {
    const tablerow = context.workbook.tables.getItem('Table1').rows.getItemAt(0);
    tablerow.load('values');
    await context.sync();
    console.log(tablerow.values);
});

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

// Get the first row in the collection and read its values.
await Excel.run(async (context) => {
    const salesTable: Excel.Table = context.workbook.worksheets
        .getItem("Sample")
        .tables.getItem("SalesTable");
    const tableRows: Excel.TableRowCollection = salesTable.rows;
    const firstRow: Excel.TableRow = tableRows.getItemAt(0);
    firstRow.load("index, values");

    await context.sync();
    console.log(`Row ${firstRow.index} values: ${JSON.stringify(firstRow.values)}`);
});

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.TableRowCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableRowCollection;

Parâmetros

options

Excel.Interfaces.TableRowCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

Fornece opções para quais propriedades do objeto devem ser carregadas.

Retornos

Excel.TableRowCollection

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.TableRowCollection;

Parâmetros

propertyNames

string | string[]

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

Retornos

Excel.TableRowCollection

Exemplos

await Excel.run(async (context) => { 
    const tablerows = context.workbook.tables.getItem('Table1').rows;
    tablerows.load('items');
    await context.sync();
    
    console.log("tablerows Count: " + tablerows.count);
    for (let i = 0; i < tablerows.items.length; i++) {
        console.log(tablerows.items[i].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?: OfficeExtension.LoadOption): Excel.TableRowCollection;

Parâmetros

propertyNamesAndPaths
OfficeExtension.LoadOption

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

Retornos

Excel.TableRowCollection

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 original Excel.TableRowCollection é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.TableRowCollectionData) que contém uma matriz "items" com cópias superficiais de todas as propriedades carregadas dos itens da coleção.

toJSON(): Excel.Interfaces.TableRowCollectionData;

Retornos

Excel.Interfaces.TableRowCollectionData