Excel.DataPivotHierarchy class

Package:

excel

Represents the Excel DataPivotHierarchy.

Extends

OfficeExtension.ClientObject

Remarks

[Api set: ExcelApi 1.8]

Properties

context	The request context associated with the object. This connects the add-in's process to the Office host application's process.
field	Returns the PivotFields associated with the DataPivotHierarchy.
id	ID of the DataPivotHierarchy.
name	Name of the DataPivotHierarchy.
numberFormat	Number format of the DataPivotHierarchy.
position	Position of the DataPivotHierarchy.
showAs	Specifies if the data should be shown as a specific summary calculation.
summarizeBy	Specifies if all items of the DataPivotHierarchy are shown.

Methods

load(options)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
set(properties, options)	Sets multiple properties of an object at the same time. 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()	Reset the DataPivotHierarchy back to its default values.
toJSON()	Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's 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.

Property Details

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

context: RequestContext;

Property Value

Excel.RequestContext

field

Returns the PivotFields associated with the DataPivotHierarchy.

readonly field: Excel.PivotField;

Property Value

Excel.PivotField

Remarks

[Api set: ExcelApi 1.8]

id

ID of the DataPivotHierarchy.

readonly id: string;

Property Value

string

Remarks

[Api set: ExcelApi 1.8]

name

Name of the DataPivotHierarchy.

name: string;

Property Value

string

Remarks

[Api set: ExcelApi 1.8]

numberFormat

Number format of the DataPivotHierarchy.

numberFormat: string;

Property Value

string

Remarks

[Api set: ExcelApi 1.8]

position

Position of the DataPivotHierarchy.

position: number;

Property Value

number

Remarks

[Api set: ExcelApi 1.8]

showAs

Specifies if the data should be shown as a specific summary calculation.

showAs: Excel.ShowAsRule;

Property Value

Excel.ShowAsRule

Remarks

[Api set: ExcelApi 1.8]

summarizeBy

Specifies if all items of the DataPivotHierarchy are shown.

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

Property Value

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

Remarks

[Api set: ExcelApi 1.8]

Method Details

load(options)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

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

Parameters

options

Excel.Interfaces.DataPivotHierarchyLoadOptions

Provides options for which properties of the object to load.

Returns

Excel.DataPivotHierarchy

load(propertyNames)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

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

Parameters

propertyNames

string | string[]

A comma-delimited string or an array of strings that specify the properties to load.

Returns

Excel.DataPivotHierarchy

load(propertyNamesAndPaths)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

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

Parameters

propertyNamesAndPaths

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

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.

Returns

Excel.DataPivotHierarchy

set(properties, options)

Sets multiple properties of an object at the same time. 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;

Parameters

properties

Excel.Interfaces.DataPivotHierarchyUpdateData

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.

Returns

void

set(properties)

Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Excel.DataPivotHierarchy): void;

Parameters

properties

Excel.DataPivotHierarchy

Returns

void

setToDefault()

Reset the DataPivotHierarchy back to its default values.

setToDefault(): void;

Returns

void

Remarks

[Api set: ExcelApi 1.8]

toJSON()

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's 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;

Returns

Excel.Interfaces.DataPivotHierarchyData