Excel.PivotTableCollection class
ブックまたはワークシートの一部として含まれている、すべてのピボットテーブルのコレクションを表します。
- Extends
注釈
[API セット: ExcelApi 1.3]
プロパティ
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| items | このコレクション内に読み込まれた子アイテムを取得します。 |
メソッド
| add(name, source, destination) | 指定したソース データに基づいてピボットテーブルを追加し、インポート先範囲の左上のセルに挿入します。 |
| get |
コレクションに含まれるピボット テーブルの数を取得します。 |
| get |
名前に基づいてピボットテーブルを取得します。 |
| get |
名前に基づいてピボットテーブルを取得します。 ピボットテーブルが存在しない場合、このメソッドは |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| refresh |
コレクション内のすべてのピボットテーブルを更新します。 |
| toJSON() | API オブジェクトが |
プロパティの詳細
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
items
メソッドの詳細
add(name, source, destination)
指定したソース データに基づいてピボットテーブルを追加し、インポート先範囲の左上のセルに挿入します。
add(name: string, source: Range | string | Table, destination: Range | string): Excel.PivotTable;パラメーター
- name
-
string
新しいピボットテーブルの名前。
- source
-
Excel.Range | string | Excel.Table
新しいピボットテーブルのソース データ。範囲 (ワークシート名を含む文字列アドレス) またはテーブルのいずれかです。
- destination
-
Excel.Range | string
ピボットテーブル レポートの配置先範囲 (結果のレポートを配置するワークシートの範囲) の左上端のセルを指定します。
返品
新しく挿入されたピボットテーブルを返します。
注釈
[API セット: ExcelApi 1.8]
getCount()
コレクションに含まれるピボット テーブルの数を取得します。
getCount(): OfficeExtension.ClientResult<number>;返品
OfficeExtension.ClientResult<number>
注釈
[API セット: ExcelApi 1.4]
getItem(name)
名前に基づいてピボットテーブルを取得します。
getItem(name: string): Excel.PivotTable;パラメーター
- name
-
string
取得するピボットテーブルの名前。
返品
注釈
[API セット: ExcelApi 1.3]
getItemOrNullObject(name)
名前に基づいてピボットテーブルを取得します。 ピボットテーブルが存在しない場合、このメソッドは isNullObject プロパティが true に設定されたオブジェクトを返します。 詳細については、「 *OrNullObject のメソッドとプロパティ」を参照してください。
getItemOrNullObject(name: string): Excel.PivotTable;パラメーター
- name
-
string
取得するピボットテーブルの名前。
返品
注釈
[API セット: ExcelApi 1.4]
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Excel.Interfaces.PivotTableCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PivotTableCollection;パラメーター
読み込むオブジェクトのプロパティのオプションを指定します。
返品
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Excel.PivotTableCollection;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切りの文字列または文字列の配列。
返品
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.PivotTableCollection;パラメーター
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列であり、 propertyNamesAndPaths.expand は読み込むナビゲーションのプロパティを指定するコンマ区切りの文字列です。
返品
refreshAll()
コレクション内のすべてのピボットテーブルを更新します。
refreshAll(): void;返品
void
注釈
[API セット: ExcelApi 1.3]
toJSON()
API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Excel.PivotTableCollection オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、コレクションの項目から読み込まれたプロパティの浅いコピーを含む "items" 配列を含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.PivotTableCollectionData として型指定された) を返します。
toJSON(): Excel.Interfaces.PivotTableCollectionData;