Office.TableData class

パッケージ:

office

テーブルまたは Office.TableBinding 内のデータを表します。

コンストラクター

(constructor)(rows, headers)	TableData クラスの新しいインスタンスを構築します
(constructor)()	TableData クラスの新しいインスタンスを構築します

プロパティ

headers	テーブル内のヘッダーを取得または設定します。
rows	テーブル内の行を取得または設定します。 テーブル内のデータを含む配列の配列を返します。 行がない場合は、空の配列を返します。

コンストラクターの詳細

(constructor)(rows, headers)

TableData クラスの新しいインスタンスを構築します

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

パラメーター

rows

any[][]

headers

any[]

(constructor)()

TableData クラスの新しいインスタンスを構築します

constructor();

プロパティの詳細

headers

テーブル内のヘッダーを取得または設定します。

headers: any[];

プロパティ値

any[]

注釈

ヘッダーを指定するには、テーブルの構造に対応した配列の配列を指定する必要があります。 たとえば、2 列テーブルのヘッダーを指定するには、ヘッダー プロパティを [['header1', 'header2']] に設定します。

headers プロパティに null を指定した場合 (または TableData オブジェクトを作成するときにプロパティを空のままにした場合)、コードの実行時に次の結果が発生します。

• 新しいテーブルを挿入した場合は、そのテーブルの既定の列ヘッダーが作成されます。

• 既存のテーブルを上書きまたは更新した場合は、既存のヘッダーは変更されません。

例

// 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

テーブル内の行を取得または設定します。 テーブル内のデータを含む配列の配列を返します。 行がない場合は、空の配列を返します。

rows: any[][];

プロパティ値

any[][]

注釈

行を指定するには、テーブルの構造に対応した配列の配列を指定する必要があります。 たとえば、2 列のテーブルで 2 行の文字列値を指定するには、rows プロパティを [[['a', 'b'], ['c', 'd']] に設定します。

rows プロパティに null を指定する (または TableData オブジェクトを作成するときに プロパティを空のままにする) 場合、コードの実行時に次の結果が発生します。

• 新しいテーブルを挿入した場合は、空行が挿入されます。

• 既存のテーブルを上書きまたは更新した場合は、既存の行は変更されません。

例

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