Excel.PivotTableScopedCollection class
ピボットテーブルのスコープ付きコレクションを表します。 ピボットテーブルは、ピボットテーブルの左上隅の場所に基づいて並べ替えられます。 これらは、上から下に並べ替えられた後、左から右に並べ替えます。
- Extends
注釈
プロパティ
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| items | このコレクション内に読み込まれた子アイテムを取得します。 |
メソッド
| get |
コレクション内のピボットテーブルの数を取得します。 |
| get |
コレクション内の最初のピボットテーブルを取得します。 コレクション内のピボットテーブルは、左上のテーブルがコレクションの最初のピボットテーブルになるように、上から下、左から右に並べ替えられます。 |
| get |
コレクション内の最初のピボットテーブルを取得します。 コレクション内のピボットテーブルは、左上のテーブルがコレクションの最初のピボットテーブルになるように、上から下、左から右に並べ替えられます。 コレクションが空の場合、このメソッドは プロパティが に設定されたオブジェクトを |
| get |
名前に基づいてピボットテーブルを取得します。 |
| get |
名前に基づいてピボットテーブルを取得します。 ピボットテーブルが存在しない場合、このメソッドは プロパティが に設定されたオブジェクトを |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| toJSON() | API オブジェクトが に渡されたときにより便利な出力を提供するために、JavaScript |
プロパティの詳細
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
items
メソッドの詳細
getCount()
コレクション内のピボットテーブルの数を取得します。
getCount(): OfficeExtension.ClientResult<number>;戻り値
OfficeExtension.ClientResult<number>
注釈
getFirst()
コレクション内の最初のピボットテーブルを取得します。 コレクション内のピボットテーブルは、左上のテーブルがコレクションの最初のピボットテーブルになるように、上から下、左から右に並べ替えられます。
getFirst(): Excel.PivotTable;戻り値
注釈
getFirstOrNullObject()
コレクション内の最初のピボットテーブルを取得します。 コレクション内のピボットテーブルは、左上のテーブルがコレクションの最初のピボットテーブルになるように、上から下、左から右に並べ替えられます。 コレクションが空の場合、このメソッドは プロパティが に設定されたオブジェクトをisNullObjecttrue返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
getFirstOrNullObject(): Excel.PivotTable;戻り値
注釈
getItem(key)
名前に基づいてピボットテーブルを取得します。
getItem(key: string): Excel.PivotTable;パラメーター
- key
-
string
取得するピボットテーブルの名前。
戻り値
注釈
getItemOrNullObject(name)
名前に基づいてピボットテーブルを取得します。 ピボットテーブルが存在しない場合、このメソッドは プロパティが に設定されたオブジェクトをisNullObjecttrue返します。 詳細については、「 *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 オブジェクトが に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドを JSON.stringify()オーバーライドします。 (JSON.stringifyさらに、渡される オブジェクトの メソッドを呼び出 toJSON します)。元 Excel.PivotTableScopedCollection のオブジェクトは API オブジェクトですが、 toJSON メソッドは、コレクションの項目から読み込まれたプロパティの浅いコピーを含む "items" 配列を含むプレーンな JavaScript オブジェクト (として Excel.Interfaces.PivotTableScopedCollectionData型指定) を返します。
toJSON(): Excel.Interfaces.PivotTableScopedCollectionData;戻り値
Office Add-ins
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示