Excel.RowColumnPivotHierarchyCollection class
ピボットテーブルに関連付けられている RowColumnPivotHierarchy 項目のコレクションを表します。
- Extends
プロパティ
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| items | このコレクション内に読み込まれた子アイテムを取得します。 |
メソッド
| add(pivot |
現在の軸にピボット階層を追加します。 階層が行、列、またはフィルター軸の他の場所に存在する場合は、その場所から削除されます。 |
| get |
コレクションに含まれるピボット階層の数を取得します。 |
| get |
名前または ID で RowColumnPivotHierarchy を取得します。 |
| get |
名前に基づいて RowColumnPivotHierarchy を取得します。 RowColumnPivotHierarchy が存在しない場合、このメソッドは |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| remove(row |
現在の軸からピボット階層を削除します。 |
| toJSON() | API オブジェクトが |
プロパティの詳細
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
items
このコレクション内に読み込まれた子アイテムを取得します。
readonly items: Excel.RowColumnPivotHierarchy[];プロパティ値
メソッドの詳細
add(pivotHierarchy)
現在の軸にピボット階層を追加します。 階層が行、列、またはフィルター軸の他の場所に存在する場合は、その場所から削除されます。
add(pivotHierarchy: Excel.PivotHierarchy): Excel.RowColumnPivotHierarchy;パラメーター
- pivotHierarchy
- Excel.PivotHierarchy
返品
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-slicer.yaml
await Excel.run(async (context) => {
const rangeToAnalyze = context.workbook.worksheets.getItem("Data").getRange("A1:E21");
const rangeToPlacePivot = context.workbook.worksheets.getItem("Pivot").getRange("A2");
const pivotTable = context.workbook.worksheets
.getItem("Pivot")
.pivotTables.add("Farm Sales", rangeToAnalyze, rangeToPlacePivot);
pivotTable.rowHierarchies.add(pivotTable.hierarchies.getItem("Farm"));
pivotTable.dataHierarchies.add(pivotTable.hierarchies.getItem("Crates Sold at Farm"));
pivotTable.dataHierarchies.add(pivotTable.hierarchies.getItem("Crates Sold Wholesale"));
await context.sync();
});
getCount()
コレクションに含まれるピボット階層の数を取得します。
getCount(): OfficeExtension.ClientResult<number>;返品
OfficeExtension.ClientResult<number>
注釈
getItem(name)
名前または ID で RowColumnPivotHierarchy を取得します。
getItem(name: string): Excel.RowColumnPivotHierarchy;パラメーター
- name
-
string
取得する RowColumnPivotHierarchy の名前。
返品
注釈
getItemOrNullObject(name)
名前に基づいて RowColumnPivotHierarchy を取得します。 RowColumnPivotHierarchy が存在しない場合、このメソッドは isNullObject プロパティが true に設定されたオブジェクトを返します。 詳細については、「 *OrNullObject のメソッドとプロパティ」を参照してください。
getItemOrNullObject(name: string): Excel.RowColumnPivotHierarchy;パラメーター
- name
-
string
取得する RowColumnPivotHierarchy の名前。
返品
注釈
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
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-create-and-modify.yaml
await Excel.run(async (context) => {
const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales");
// Check if the PivotTable already has rows.
const farmRow = pivotTable.rowHierarchies.getItemOrNullObject("Farm");
const typeRow = pivotTable.rowHierarchies.getItemOrNullObject("Type");
const classificationRow = pivotTable.rowHierarchies.getItemOrNullObject("Classification");
pivotTable.rowHierarchies.load();
await context.sync();
if (!classificationRow.isNullObject) {
pivotTable.rowHierarchies.remove(classificationRow);
} else if (!typeRow.isNullObject) {
pivotTable.rowHierarchies.remove(typeRow);
} else if (!farmRow.isNullObject) {
pivotTable.rowHierarchies.remove(farmRow);
}
await context.sync();
});
toJSON()
API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Excel.RowColumnPivotHierarchyCollection オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、コレクションの項目から読み込まれたプロパティの浅いコピーを含む "items" 配列を含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.RowColumnPivotHierarchyCollectionData として型指定された) を返します。
toJSON(): Excel.Interfaces.RowColumnPivotHierarchyCollectionData;