Excel.PivotHierarchy class

Represents the Excel PivotHierarchy.

[ API set: ExcelApi 1.8 ]

Extends
OfficeExtension.ClientObject

Properties

context

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

fields

Returns the PivotFields associated with the PivotHierarchy.

[ API set: ExcelApi 1.8 ]

id

Id of the PivotHierarchy.

[ API set: ExcelApi 1.8 ]

name

Name of the PivotHierarchy.

[ API set: ExcelApi 1.8 ]

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.

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 is passed to it.) Whereas the original Excel.PivotHierarchy object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.PivotHierarchyData) 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

fields

Returns the PivotFields associated with the PivotHierarchy.

[ API set: ExcelApi 1.8 ]

readonly fields: Excel.PivotFieldCollection;

Property Value

id

Id of the PivotHierarchy.

[ API set: ExcelApi 1.8 ]

readonly id: string;

Property Value

string

name

Name of the PivotHierarchy.

[ API set: ExcelApi 1.8 ]

name: string;

Property Value

string

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.PivotHierarchyLoadOptions): Excel.PivotHierarchy;

Parameters

options
Excel.Interfaces.PivotHierarchyLoadOptions

Provides options for which properties of the object to load.

Returns

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.PivotHierarchy;

Parameters

propertyNames
string | string[]

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

Returns

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.PivotHierarchy;

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

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.PivotHierarchyUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameters

properties
Interfaces.PivotHierarchyUpdateData

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

Remarks

This method has the following additional signature:

set(properties: Excel.PivotHierarchy): void

set(properties)

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

set(properties: Excel.PivotHierarchy): void;

Parameters

Returns

void

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 is passed to it.) Whereas the original Excel.PivotHierarchy object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.PivotHierarchyData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.PivotHierarchyData;

Returns