Excel.DataPivotHierarchy class

Excel の DataPivotHierarchy を表します。Represents the Excel DataPivotHierarchy.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

Extends

プロパティ

context

オブジェクトに関連付けられている要求コンテキスト。The request context associated with the object. これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。This connects the add-in's process to the Office host application's process.

field

DataPivotHierarchy に関連付けられているピボット フィールドを返します。Returns the PivotFields associated with the DataPivotHierarchy.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

id

DataPivotHierarchy の ID。Id of the DataPivotHierarchy.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

name

DataPivotHierarchy の名前。Name of the DataPivotHierarchy.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

numberFormat

DataPivotHierarchy の数値形式。Number format of the DataPivotHierarchy.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

position

DataPivotHierarchy の位置。Position of the DataPivotHierarchy.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

showAs

データを特定の集計計算として表示するかどうかどうかを指定します。Determines whether the data should be shown as a specific summary calculation or not.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

summarizeBy

DataPivotHierarchy のすべての項目を表示するかどうかを指定します。Determines whether to show all items of the DataPivotHierarchy.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

メソッド

load(option)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るには先に "context.sync()" を呼び出す必要があります。You must call "context.sync()" before reading the properties.

load(propertyNames)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

load(propertyNamesAndPaths)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

set(properties, options)

一度に1つのオブジェクトの複数のプロパティを設定します。Sets multiple properties of an object at the same time. 適切なプロパティを持つプレーンオブジェクト、または同じ種類の別の API オブジェクトのいずれかを渡すことができます。You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを設定します。Sets multiple properties on the object at the same time, based on an existing loaded object.

setToDefault()

DataPivotHierarchy を既定値にリセットします。Reset the DataPivotHierarchy back to its default values.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

toJSON()

API オブジェクトがtoJSON()渡されるときに、より有用な出力を提供するために、JavaScript メソッドをオーバーライドします。JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringifyその後、渡されたtoJSONオブジェクトのメソッドを呼び出します。元の DataPivotHierarchy オブジェクトは API オブジェクトであるのに対し、 toJSONメソッドはプレーンな JavaScript オブジェクトを返します (型はExcel.Interfaces.DataPivotHierarchyData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.DataPivotHierarchy object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.DataPivotHierarchyData) は、元のオブジェクトから読み込まれた子プロパティの浅いコピーを格納します。) that contains shallow copies of any loaded child properties from the original object.

プロパティの詳細

context

オブジェクトに関連付けられている要求コンテキスト。The request context associated with the object. これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。This connects the add-in's process to the Office host application's process.

context: RequestContext;

プロパティ値

RequestContext

field

DataPivotHierarchy に関連付けられているピボット フィールドを返します。Returns the PivotFields associated with the DataPivotHierarchy.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

readonly field: Excel.PivotField;

プロパティ値

id

DataPivotHierarchy の ID。Id of the DataPivotHierarchy.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

readonly id: string;

プロパティ値

string

name

DataPivotHierarchy の名前。Name of the DataPivotHierarchy.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

name: string;

プロパティ値

string

Examples

await Excel.run(async (context) => {
    const dataHierarchies = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales").dataHierarchies
    dataHierarchies.load("no-properties-needed");
    await context.sync();

    dataHierarchies.items[0].name = "Farm Sales";
    dataHierarchies.items[1].name = "Wholesale";
    await context.sync();
});

numberFormat

DataPivotHierarchy の数値形式。Number format of the DataPivotHierarchy.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

numberFormat: string;

プロパティ値

string

position

DataPivotHierarchy の位置。Position of the DataPivotHierarchy.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

position: number;

プロパティ値

number

showAs

データを特定の集計計算として表示するかどうかどうかを指定します。Determines whether the data should be shown as a specific summary calculation or not.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

showAs: Excel.ShowAsRule;

プロパティ値

Examples

await Excel.run(async (context) => {
    const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales");
    const farmDataHierarchy: Excel.DataPivotHierarchy = pivotTable.dataHierarchies.getItem("Sum of Crates Sold at Farm");        
    const wholesaleDataHierarchy: Excel.DataPivotHierarchy = pivotTable.dataHierarchies.getItem("Sum of Crates Sold Wholesale");

    farmDataHierarchy.load("showAs");
    wholesaleDataHierarchy.load("showAs");
    await context.sync();

    // show the crates of each fruit type sold at the farm as a percentage of the column's total
    let farmShowAs = farmDataHierarchy.showAs;
    farmShowAs.calculation = Excel.ShowAsCalculation.percentOfColumnTotal;
    farmShowAs.baseField = pivotTable.rowHierarchies.getItem("Type").fields.getItem("Type");
    farmDataHierarchy.showAs = farmShowAs;

    let wholesaleShowAs = wholesaleDataHierarchy.showAs;
    wholesaleShowAs.calculation = Excel.ShowAsCalculation.percentOfColumnTotal;
    wholesaleShowAs.baseField = pivotTable.rowHierarchies.getItem("Type").fields.getItem("Type");
    wholesaleDataHierarchy.showAs = wholesaleShowAs;
    await context.sync();
});

summarizeBy

DataPivotHierarchy のすべての項目を表示するかどうかを指定します。Determines whether to show all items of the DataPivotHierarchy.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

summarizeBy: Excel.AggregationFunction | "Unknown" | "Automatic" | "Sum" | "Count" | "Average" | "Max" | "Min" | "Product" | "CountNumbers" | "StandardDeviation" | "StandardDeviationP" | "Variance" | "VarianceP";

プロパティ値

Excel.AggregationFunction | "Unknown" | "Automatic" | "Sum" | "Count" | "Average" | "Max" | "Min" | "Product" | "CountNumbers" | "StandardDeviation" | "StandardDeviationP" | "Variance" | "VarianceP"

メソッドの詳細

load(option)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るには先に "context.sync()" を呼び出す必要があります。You must call "context.sync()" before reading the properties.

load(option?: Excel.Interfaces.DataPivotHierarchyLoadOptions): Excel.DataPivotHierarchy;

パラメーター

戻り値

注釈

このシグネチャに加えて、このメソッドのシグネチャは次のとおりです。In addition to this signature, this method has the following signatures:

load(option?: string | string[]): Excel.DataPivotHierarchy-Where オプションは、読み込むプロパティを指定する、コンマで区切られた文字列または文字列の配列です。load(option?: string | string[]): Excel.DataPivotHierarchy - Where option is a comma-delimited string or an array of strings that specify the properties to load.

load(option?: { select?: string; expand?: string; }): Excel.DataPivotHierarchy-Where オプションを指定します。 select は、読み込むプロパティを指定するコンマで区切られた文字列で、オプション expand は読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。load(option?: { select?: string; expand?: string; }): Excel.DataPivotHierarchy - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load.

load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.DataPivotHierarchy-コレクション型でのみ使用できます。load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.DataPivotHierarchy - Only available on collection types. これは、前述の署名に似ています。It is similar to the preceding signature. top は、結果に含めることができるコレクション項目の最大数を指定します。Option.top specifies the maximum number of collection items that can be included in the result. 省略すると、スキップされ、結果に含まれないアイテムの数を指定します。Option.skip specifies the number of items that are to be skipped and not included in the result. option を指定すると、指定した数のアイテムをスキップした後に結果セットが開始されます。If option.top is specified, the result set will start after skipping the specified number of items.

load(propertyNames)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

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

パラメーター

propertyNames
string | string[]

読み込むプロパティを指定する、コンマで区切られた文字列または文字列の配列。A comma-delimited string or an array of strings that specify the properties to load.

戻り値

load(propertyNamesAndPaths)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.DataPivotHierarchy;

パラメーター

propertyNamesAndPaths
{ select?: string; expand?: string; }

ここで、は、読み込むプロパティを指定するコンマで区切られた文字列を指定します。 expand は、読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。Where propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.

戻り値

set(properties, options)

一度に1つのオブジェクトの複数のプロパティを設定します。Sets multiple properties of an object at the same time. 適切なプロパティを持つプレーンオブジェクト、または同じ種類の別の API オブジェクトのいずれかを渡すことができます。You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties: Interfaces.DataPivotHierarchyUpdateData, options?: OfficeExtension.UpdateOptions): void;

パラメーター

properties
Interfaces.DataPivotHierarchyUpdateData

メソッドが呼び出されるオブジェクトのプロパティに構造化 isomorphically されているプロパティを持つ JavaScript オブジェクト。A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.

options
OfficeExtension.UpdateOptions

プロパティオブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。Provides an option to suppress errors if the properties object tries to set any read-only properties.

戻り値

void

注釈

このメソッドには、次の追加のシグネチャがあります。This method has the following additional signature:

set(properties: Excel.DataPivotHierarchy): void

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを設定します。Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Excel.DataPivotHierarchy): void;

パラメーター

戻り値

void

setToDefault()

DataPivotHierarchy を既定値にリセットします。Reset the DataPivotHierarchy back to its default values.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

setToDefault(): void;

戻り値

void

toJSON()

API オブジェクトがtoJSON()渡されるときに、より有用な出力を提供するために、JavaScript メソッドをオーバーライドします。JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringifyその後、渡されたtoJSONオブジェクトのメソッドを呼び出します。元の DataPivotHierarchy オブジェクトは API オブジェクトであるのに対し、 toJSONメソッドはプレーンな JavaScript オブジェクトを返します (型はExcel.Interfaces.DataPivotHierarchyData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.DataPivotHierarchy object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.DataPivotHierarchyData) は、元のオブジェクトから読み込まれた子プロパティの浅いコピーを格納します。) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.DataPivotHierarchyData;

戻り値