Excel.DataPivotHierarchyCollection class
ピボットテーブルに関連付けられている DataPivotHierarchy 項目のコレクションを表します。
- Extends
注釈
プロパティ
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| items | このコレクション内に読み込まれた子アイテムを取得します。 |
メソッド
| add(pivot |
現在の軸にピボット階層を追加します。 |
| get |
コレクションに含まれるピボット階層の数を取得します。 |
| get |
名前または ID で DataPivotHierarchy を取得します。 |
| get |
名前に基づいて DataPivotHierarchy を取得します。 DataPivotHierarchy が存在しない場合、このメソッドは |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| remove(Data |
現在の軸からピボット階層を削除します。 |
| toJSON() | API オブジェクトが |
プロパティの詳細
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
items
このコレクション内に読み込まれた子アイテムを取得します。
readonly items: Excel.DataPivotHierarchy[];プロパティ値
メソッドの詳細
add(pivotHierarchy)
現在の軸にピボット階層を追加します。
add(pivotHierarchy: Excel.PivotHierarchy): Excel.DataPivotHierarchy;パラメーター
- pivotHierarchy
- Excel.PivotHierarchy
戻り値
注釈
getCount()
コレクションに含まれるピボット階層の数を取得します。
getCount(): OfficeExtension.ClientResult<number>;戻り値
OfficeExtension.ClientResult<number>
注釈
getItem(name)
名前または ID で DataPivotHierarchy を取得します。
getItem(name: string): Excel.DataPivotHierarchy;パラメーター
- name
-
string
取得する DataPivotHierarchy の名前。
戻り値
注釈
getItemOrNullObject(name)
名前に基づいて DataPivotHierarchy を取得します。 DataPivotHierarchy が存在しない場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
getItemOrNullObject(name: string): Excel.DataPivotHierarchy;パラメーター
- name
-
string
取得する DataPivotHierarchy の名前。
戻り値
注釈
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Excel.Interfaces.DataPivotHierarchyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.DataPivotHierarchyCollection;パラメーター
- options
-
Excel.Interfaces.DataPivotHierarchyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions
読み込むオブジェクトのプロパティのオプションを提供します。
戻り値
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Excel.DataPivotHierarchyCollection;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。
戻り値
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.DataPivotHierarchyCollection;パラメーター
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。
戻り値
remove(DataPivotHierarchy)
現在の軸からピボット階層を削除します。
remove(DataPivotHierarchy: Excel.DataPivotHierarchy): void;パラメーター
- DataPivotHierarchy
- Excel.DataPivotHierarchy
戻り値
void
注釈
toJSON()
API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Excel.DataPivotHierarchyCollection オブジェクトは API オブジェクトですが、 toJSON メソッドは、コレクションの項目から読み込まれたプロパティの浅いコピーを含む "items" 配列を含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.DataPivotHierarchyCollectionDataとして型指定) を返します。
toJSON(): Excel.Interfaces.DataPivotHierarchyCollectionData;戻り値
Office Add-ins