Excel.RowColumnPivotHierarchyCollection class

ピボットテーブルに関連付けられている RowColumnPivotHierarchy 項目のコレクションを表します。

Extends

注釈

[ API セット: ExcelApi 1.8 ]

プロパティ

context

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

items

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

メソッド

add(pivotHierarchy)

現在の軸にピボット階層を追加します。 階層が行、列、またはフィルター軸の他の場所に存在する場合は、その場所から削除されます。

getCount()

コレクションに含まれるピボット階層の数を取得します。

getItem(name)

名前または ID で RowColumnPivotHierarchy を取得します。

getItemOrNullObject(name)

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

load(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

remove(rowColumnPivotHierarchy)

現在の軸からピボット階層を削除します。

toJSON()

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

プロパティの詳細

context

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

context: RequestContext;

プロパティ値

items

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

readonly items: Excel.RowColumnPivotHierarchy[];

プロパティ値

メソッドの詳細

add(pivotHierarchy)

現在の軸にピボット階層を追加します。 階層が行、列、またはフィルター軸の他の場所に存在する場合は、その場所から削除されます。

add(pivotHierarchy: Excel.PivotHierarchy): Excel.RowColumnPivotHierarchy;

パラメーター

pivotHierarchy
Excel.PivotHierarchy

戻り値

注釈

[ API セット: ExcelApi 1.8 ]

getCount()

コレクションに含まれるピボット階層の数を取得します。

getCount(): OfficeExtension.ClientResult<number>;

戻り値

注釈

[ API セット: ExcelApi 1.8 ]

getItem(name)

名前または ID で RowColumnPivotHierarchy を取得します。

getItem(name: string): Excel.RowColumnPivotHierarchy;

パラメーター

name

string

取得する RowColumnPivotHierarchy の名前。

戻り値

注釈

[ API セット: ExcelApi 1.8 ]

getItemOrNullObject(name)

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

getItemOrNullObject(name: string): Excel.RowColumnPivotHierarchy;

パラメーター

name

string

取得する RowColumnPivotHierarchy の名前。

戻り値

注釈

[ API セット: ExcelApi 1.8 ]

load(options)

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

load(options?: Excel.Interfaces.RowColumnPivotHierarchyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.RowColumnPivotHierarchyCollection;

パラメーター

options

Excel.Interfaces.RowColumnPivotHierarchyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

戻り値

load(propertyNames)

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

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

パラメーター

propertyNames

string | string[]

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

戻り値

load(propertyNamesAndPaths)

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

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

パラメーター

propertyNamesAndPaths
OfficeExtension.LoadOption

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

戻り値

remove(rowColumnPivotHierarchy)

現在の軸からピボット階層を削除します。

remove(rowColumnPivotHierarchy: Excel.RowColumnPivotHierarchy): void;

パラメーター

rowColumnPivotHierarchy
Excel.RowColumnPivotHierarchy

戻り値

void

注釈

[ API セット: ExcelApi 1.8 ]

toJSON()

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

toJSON(): Excel.Interfaces.RowColumnPivotHierarchyCollectionData;

戻り値