Excel.FilterPivotHierarchyCollection class

Represents a collection of FilterPivotHierarchy items associated with the PivotTable.

[ 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.

items

Gets the loaded child items in this collection.

Methods

add(pivotHierarchy)

Adds the PivotHierarchy to the current axis. If the hierarchy is present elsewhere on the row, column, or filter axis, it will be removed from that location.

[ API set: ExcelApi 1.8 ]

getCount()

Gets the number of pivot hierarchies in the collection.

[ API set: ExcelApi 1.8 ]

getItem(name)

Gets a FilterPivotHierarchy by its name or id.

[ API set: ExcelApi 1.8 ]

getItemOrNullObject(name)

Gets a FilterPivotHierarchy by name. If the FilterPivotHierarchy does not exist, will return a null object.

[ API set: ExcelApi 1.8 ]

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.

remove(filterPivotHierarchy)

Removes the PivotHierarchy from the current axis.

[ 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 is passed to it.) Whereas the original Excel.FilterPivotHierarchyCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.FilterPivotHierarchyCollectionData) that contains an "items" array with shallow copies of any loaded properties from the collection's items.

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

items

Gets the loaded child items in this collection.

readonly items: Excel.FilterPivotHierarchy[];

Property Value

Method Details

add(pivotHierarchy)

Adds the PivotHierarchy to the current axis. If the hierarchy is present elsewhere on the row, column, or filter axis, it will be removed from that location.

[ API set: ExcelApi 1.8 ]

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

Parameters

pivotHierarchy
Excel.PivotHierarchy

Returns

getCount()

Gets the number of pivot hierarchies in the collection.

[ API set: ExcelApi 1.8 ]

getCount(): OfficeExtension.ClientResult<number>;

Returns

OfficeExtension.ClientResult<number>

getItem(name)

Gets a FilterPivotHierarchy by its name or id.

[ API set: ExcelApi 1.8 ]

getItem(name: string): Excel.FilterPivotHierarchy;

Parameters

name
string

Name of the FilterPivotHierarchy to be retrieved.

Returns

getItemOrNullObject(name)

Gets a FilterPivotHierarchy by name. If the FilterPivotHierarchy does not exist, will return a null object.

[ API set: ExcelApi 1.8 ]

getItemOrNullObject(name: string): Excel.FilterPivotHierarchy;

Parameters

name
string

Name of the FilterPivotHierarchy to be retrieved.

Returns

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.FilterPivotHierarchyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.FilterPivotHierarchyCollection;

Parameters

options
Excel.Interfaces.FilterPivotHierarchyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

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?: OfficeExtension.LoadOption): Excel.FilterPivotHierarchyCollection;

Parameters

propertyNamesAndPaths
OfficeExtension.LoadOption

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

remove(filterPivotHierarchy)

Removes the PivotHierarchy from the current axis.

[ API set: ExcelApi 1.8 ]

remove(filterPivotHierarchy: Excel.FilterPivotHierarchy): void;

Parameters

filterPivotHierarchy
Excel.FilterPivotHierarchy

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.FilterPivotHierarchyCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.FilterPivotHierarchyCollectionData) that contains an "items" array with shallow copies of any loaded properties from the collection's items.

toJSON(): Excel.Interfaces.FilterPivotHierarchyCollectionData;

Returns