Compartilhar via


Office.TableData class

Representa os dados numa tabela ou num Office.TableBinding.

Construtores

(constructor)(rows, headers)

Constrói uma nova instância da TableData classe

(constructor)()

Constrói uma nova instância da TableData classe

Propriedades

headers

Obtém ou define os cabeçalhos da tabela.

rows

Obtém ou define as linhas na tabela. Retorna uma matriz de matrizes que contém os dados na tabela. Devolve uma matriz vazia se não existirem linhas.

Detalhes do construtor

(constructor)(rows, headers)

Constrói uma nova instância da TableData classe

constructor(rows: any[][], headers: any[]);

Parâmetros

rows

any[][]

headers

any[]

(constructor)()

Constrói uma nova instância da TableData classe

constructor();

Detalhes da propriedade

headers

Obtém ou define os cabeçalhos da tabela.

headers: any[];

Valor da propriedade

any[]

Comentários

Para especificar cabeçalhos, você deve especificar uma matriz de matrizes que corresponde à estrutura da tabela. Por exemplo, para especificar cabeçalhos para uma tabela de duas colunas, definiria a propriedade de cabeçalho para [['header1', 'header2']].

Se especificar nulo para a propriedade headers (ou deixar a propriedade vazia quando constrói um objeto TableData), os seguintes resultados ocorrem quando o código é executado.

  • Se você inserir uma nova tabela, serão criados os cabeçalhos de coluna padrão para a tabela.

  • Se você substituir ou atualizar uma tabela existente, os cabeçalhos existentes não serão alterados.

Exemplos

// The following example creates a single-column table with a header and three rows.
function createTableData() {
    const tableData = new Office.TableData();
    tableData.headers = [['header1']];
    tableData.rows = [['row1'], ['row2'], ['row3']];
    return tableData;
}

rows

Obtém ou define as linhas na tabela. Retorna uma matriz de matrizes que contém os dados na tabela. Devolve uma matriz vazia se não existirem linhas.

rows: any[][];

Valor da propriedade

any[][]

Comentários

Para especificar linhas, você deve especificar uma matriz de matrizes que corresponde à estrutura da tabela. Por exemplo, para especificar duas linhas de valores de cadeia numa tabela de duas colunas, definiria a propriedade rows como [['a', 'b'], ['c', 'd']]].

Se especificar nulo para a propriedade rows (ou deixar a propriedade vazia quando constrói um objeto TableData), os seguintes resultados ocorrem quando o código é executado.

  • Se você inserir uma nova tabela, uma linha em branco será inserida.

  • Se você substituir ou atualizar uma tabela existente, as linhas existentes não serão alteradas.

Exemplos

// The following example creates a single-column table with a header and three rows.
function createTableData() {
    const tableData = new Office.TableData();
    tableData.headers = [['header1']];
    tableData.rows = [['row1'], ['row2'], ['row3']];
    return tableData;
}