次の方法で共有

Excel.PivotTableScopedCollection class

  • リファレンス
パッケージ:
excel

ピボットテーブルのスコープ付きコレクションを表します。 ピボットテーブルは、ピボットテーブルの左上隅の場所に基づいて並べ替えられます。 これらは、上から下に並べ替えられた後、左から右に並べ替えます。

Extends
OfficeExtension.ClientObject

注釈

[ API セット: ExcelApi 1.12 ]

プロパティ

context

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

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

メソッド

getCount()

コレクション内のピボットテーブルの数を取得します。
getFirst()

コレクション内の最初のピボットテーブルを取得します。 コレクション内のピボットテーブルは、左上のテーブルがコレクションの最初のピボットテーブルになるように、上から下、左から右に並べ替えられます。
getFirstOrNullObject()

コレクション内の最初のピボットテーブルを取得します。 コレクション内のピボットテーブルは、左上のテーブルがコレクションの最初のピボットテーブルになるように、上から下、左から右に並べ替えられます。 コレクションが空の場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
getItem(key)

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

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

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

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

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

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

プロパティの詳細

context

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

context: RequestContext;

プロパティ値

Excel.RequestContext

items

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

readonly items: Excel.PivotTable[];

プロパティ値

Excel.PivotTable[]

メソッドの詳細

getCount()

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

getCount(): OfficeExtension.ClientResult<number>;

戻り値

OfficeExtension.ClientResult<number>

注釈

[ API セット: ExcelApi 1.12 ]

getFirst()

コレクション内の最初のピボットテーブルを取得します。 コレクション内のピボットテーブルは、左上のテーブルがコレクションの最初のピボットテーブルになるように、上から下、左から右に並べ替えられます。

getFirst(): Excel.PivotTable;

戻り値

Excel.PivotTable

注釈

[ API セット: ExcelApi 1.12 ]

getFirstOrNullObject()

コレクション内の最初のピボットテーブルを取得します。 コレクション内のピボットテーブルは、左上のテーブルがコレクションの最初のピボットテーブルになるように、上から下、左から右に並べ替えられます。 コレクションが空の場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

getFirstOrNullObject(): Excel.PivotTable;

戻り値

Excel.PivotTable

注釈

[ API セット: ExcelApi 1.15 ]

getItem(key)

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

getItem(key: string): Excel.PivotTable;

パラメーター

key

string

取得するピボットテーブルの名前。

戻り値

Excel.PivotTable

注釈

[ API セット: ExcelApi 1.12 ]

getItemOrNullObject(name)

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

getItemOrNullObject(name: string): Excel.PivotTable;

パラメーター

name

string

取得するピボットテーブルの名前。

戻り値

Excel.PivotTable

注釈

[ API セット: ExcelApi 1.12 ]

load(options)

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

load(options?: Excel.Interfaces.PivotTableScopedCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PivotTableScopedCollection;

パラメーター

options

Excel.Interfaces.PivotTableScopedCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

読み込むオブジェクトのプロパティのオプションを提供します。

戻り値

Excel.PivotTableScopedCollection

load(propertyNames)

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

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

パラメーター

propertyNames

string | string[]

読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。

戻り値

Excel.PivotTableScopedCollection

load(propertyNamesAndPaths)

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

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

パラメーター

propertyNamesAndPaths
OfficeExtension.LoadOption

propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。

戻り値

Excel.PivotTableScopedCollection

toJSON()

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

toJSON(): Excel.Interfaces.PivotTableScopedCollectionData;

戻り値

Excel.Interfaces.PivotTableScopedCollectionData