Excel.PivotTableScopedCollection class
範囲が絞られたピボットテーブルのコレクションを表します。 ピボットテーブルは、ピボットテーブルの左上隅の位置に基づいて並べ替えられます。 これらは上から下、次に左から右に並べられます。
- Extends
プロパティ
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| items | このコレクション内に読み込まれた子アイテムを取得します。 |
メソッド
| get |
コレクション内のピボットテーブルの数を取得します。 |
| get |
コレクション内の最初のピボットテーブルを取得します。 コレクション内のピボットテーブルは、上から下および左から右に並べ替えられ、左上のテーブルがコレクション内の最初のピボットテーブルになります。 |
| get |
コレクション内の最初のピボットテーブルを取得します。 コレクション内のピボットテーブルは、上から下、左から右に並べ替えられ、左上のテーブルがコレクション内の最初のピボットテーブルになります。 コレクションが空の場合、このメソッドは |
| get |
名前に基づいてピボットテーブルを取得します。 |
| get |
名前に基づいてピボットテーブルを取得します。 ピボットテーブルが存在しない場合、このメソッドは |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| toJSON() | API オブジェクトが |
プロパティの詳細
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
items
メソッドの詳細
getCount()
コレクション内のピボットテーブルの数を取得します。
getCount(): OfficeExtension.ClientResult<number>;返品
OfficeExtension.ClientResult<number>
注釈
getFirst()
コレクション内の最初のピボットテーブルを取得します。 コレクション内のピボットテーブルは、上から下および左から右に並べ替えられ、左上のテーブルがコレクション内の最初のピボットテーブルになります。
getFirst(): Excel.PivotTable;返品
注釈
getFirstOrNullObject()
コレクション内の最初のピボットテーブルを取得します。 コレクション内のピボットテーブルは、上から下、左から右に並べ替えられ、左上のテーブルがコレクション内の最初のピボットテーブルになります。 コレクションが空の場合、このメソッドは isNullObject プロパティが true に設定されたオブジェクトを返します。 詳細については、「 *OrNullObject のメソッドとプロパティ」を参照してください。
getFirstOrNullObject(): Excel.PivotTable;返品
注釈
getItem(key)
名前に基づいてピボットテーブルを取得します。
getItem(key: string): Excel.PivotTable;パラメーター
- key
-
string
取得するピボットテーブルの名前。
返品
注釈
getItemOrNullObject(name)
名前に基づいてピボットテーブルを取得します。 ピボットテーブルが存在しない場合、このメソッドは isNullObject プロパティが true に設定されたオブジェクトを返します。 詳細については、「 *OrNullObject のメソッドとプロパティ」を参照してください。
getItemOrNullObject(name: string): Excel.PivotTable;パラメーター
- name
-
string
取得するピボットテーブルの名前。
返品
注釈
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Excel.Interfaces.PivotTableScopedCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PivotTableScopedCollection;パラメーター
- options
-
Excel.Interfaces.PivotTableScopedCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions
読み込むオブジェクトのプロパティのオプションを指定します。
返品
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Excel.PivotTableScopedCollection;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切りの文字列または文字列の配列。
返品
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.PivotTableScopedCollection;パラメーター
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列であり、 propertyNamesAndPaths.expand は読み込むナビゲーションのプロパティを指定するコンマ区切りの文字列です。
返品
toJSON()
API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Excel.PivotTableScopedCollection オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、コレクションの項目から読み込まれたプロパティの浅いコピーを含む "items" 配列を含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.PivotTableScopedCollectionData として型指定された) を返します。
toJSON(): Excel.Interfaces.PivotTableScopedCollectionData;