Edit

Share via

Excel.FilterPivotHierarchy class

Package:
excel

Represents the Excel FilterPivotHierarchy.

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

Determines whether to allow multiple filter items.
fields

Returns the PivotFields associated with the FilterPivotHierarchy.
id

ID of the FilterPivotHierarchy.
name

Name of the FilterPivotHierarchy.
position

Position of the FilterPivotHierarchy.

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 FilterPivotHierarchy 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.FilterPivotHierarchy object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.FilterPivotHierarchyData) 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

enableMultipleFilterItems

Determines whether to allow multiple filter items.

enableMultipleFilterItems: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

fields

Returns the PivotFields associated with the FilterPivotHierarchy.

readonly fields: Excel.PivotFieldCollection;

Property Value

Excel.PivotFieldCollection

Remarks

[ API set: ExcelApi 1.8 ]

id

ID of the FilterPivotHierarchy.

readonly id: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.8 ]

name

Name of the FilterPivotHierarchy.

name: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.8 ]

position

Position of the FilterPivotHierarchy.

position: number;

Property Value

number

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.FilterPivotHierarchyLoadOptions): Excel.FilterPivotHierarchy;

Parameters

options
Excel.Interfaces.FilterPivotHierarchyLoadOptions

Provides options for which properties of the object to load.

Returns

Excel.FilterPivotHierarchy

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

Parameters

propertyNames

string | string[]

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

Returns

Excel.FilterPivotHierarchy

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

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

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

Parameters

properties
Excel.Interfaces.FilterPivotHierarchyUpdateData

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.FilterPivotHierarchy): void;

Parameters

properties
Excel.FilterPivotHierarchy

Returns

void

setToDefault()

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

toJSON(): Excel.Interfaces.FilterPivotHierarchyData;

Returns

Excel.Interfaces.FilterPivotHierarchyData