Excel.PivotHierarchy class

Package:

excel

Represents the Excel PivotHierarchy.

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.
fields	Returns the PivotFields associated with the PivotHierarchy.
id	ID of the PivotHierarchy.
name	Name of the PivotHierarchy.

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

Excel.RequestContext

fields

Returns the PivotFields associated with the PivotHierarchy.

readonly fields: Excel.PivotFieldCollection;

Property Value

Excel.PivotFieldCollection

Remarks

[ API set: ExcelApi 1.8 ]

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-pivotfilters.yaml

await Excel.run(async (context) => {
  // Add a PivotFilter to filter on the values correlated with a row.

  // Get the PivotTable.
  const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales");

  // Get the "Farm" field.
  const field = pivotTable.hierarchies.getItem("Farm").fields.getItem("Farm");

  // Filter to only include rows with more than 500 wholesale crates sold.
  const filter: Excel.PivotValueFilter = {
    condition: Excel.ValueFilterCondition.greaterThan,
    comparator: 500,
    value: "Sum of Crates Sold Wholesale"
  };

  // Apply the value filter to the field.
  field.applyFilter({ valueFilter: filter });

  await context.sync();
});

id

ID of the PivotHierarchy.

readonly id: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.8 ]

name

Name of the PivotHierarchy.

name: string;

Property Value

string

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

Parameters

options

Excel.Interfaces.PivotHierarchyLoadOptions

Provides options for which properties of the object to load.

Returns

Excel.PivotHierarchy

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

Excel.PivotHierarchy

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

Excel.PivotHierarchy

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

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

set(properties)

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

set(properties: Excel.PivotHierarchy): void;

Parameters

properties

Excel.PivotHierarchy

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

Excel.Interfaces.PivotHierarchyData