Excel.PivotTableCollection class

オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。

context: RequestContext;

プロパティ値

このコレクション内に読み込まれた子アイテムを取得します。

readonly items: Excel.PivotTable[];

プロパティ値

指定したソース データに基づいてピボットテーブルを追加し、変換先範囲の左上のセルに挿入します。

add(name: string, source: Range | string | Table, destination: Range | string): Excel.PivotTable;

パラメーター

戻り値

新しく挿入されたピボットテーブルを返します。

注釈

[ API セット: ExcelApi 1.8 ]

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-create-and-modify.yaml

await Excel.run(async (context) => {
    const rangeToAnalyze = context.workbook.worksheets.getItem("Data").getRange("A1:E21");
    const rangeToPlacePivot = context.workbook.worksheets.getItem("Pivot").getRange("A2");
    context.workbook.worksheets.getItem("Pivot").pivotTables.add("Farm Sales", rangeToAnalyze, rangeToPlacePivot);

    await context.sync();
});

コレクションに含まれるピボット テーブルの数を取得します。

getCount(): OfficeExtension.ClientResult<number>;

戻り値

注釈

[ API セット: ExcelApi 1.4 ]

名前に基づいてピボットテーブルを取得します。

getItem(name: string): Excel.PivotTable;

パラメーター

戻り値

注釈

[ API セット: ExcelApi 1.3 ]

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-refresh.yaml

// This function refreshes the "Farm Sales" PivotTable,
// which updates the PivotTable with changes made to the source table.
await Excel.run(async (context) => {
  const pivotTable = context.workbook.pivotTables.getItem("Farm Sales");
  pivotTable.refresh();
  await context.sync();
});

名前に基づいてピボットテーブルを取得します。 ピボットテーブルが存在しない場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

getItemOrNullObject(name: string): Excel.PivotTable;

パラメーター

戻り値

注釈

[ API セット: ExcelApi 1.4 ]

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(options?: Excel.Interfaces.PivotTableCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PivotTableCollection;

パラメーター

戻り値

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNames?: string | string[]): Excel.PivotTableCollection;

パラメーター

戻り値

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.PivotTableCollection;

パラメーター

戻り値

コレクション内のすべてのピボットテーブルを更新します。

refreshAll(): void;

戻り値

注釈

[ API セット: ExcelApi 1.3 ]

API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Excel.PivotTableCollection オブジェクトは API オブジェクトですが、 toJSON メソッドは、コレクションの項目から読み込まれたプロパティの浅いコピーを含む "items" 配列を含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.PivotTableCollectionDataとして型指定) を返します。

toJSON(): Excel.Interfaces.PivotTableCollectionData;

戻り値