Excel.PivotHierarchyCollection class
Represents a collection of all the PivotHierarchies that are part of the PivotTable.
- Extends
| 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. |
| get |
Gets the number of pivot hierarchies in the collection. |
| get |
Gets a PivotHierarchy by its name or ID. |
| get |
Gets a PivotHierarchy by name. If the PivotHierarchy does not exist, then this method returns an object with its |
| load(options) | Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| toJSON() | Overrides the JavaScript |
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
Gets the loaded child items in this collection.
readonly items: Excel.PivotHierarchy[];Property Value
Gets the number of pivot hierarchies in the collection.
getCount(): OfficeExtension.ClientResult<number>;Returns
OfficeExtension.ClientResult<number>
Remarks
Gets a PivotHierarchy by its name or ID.
getItem(name: string): Excel.PivotHierarchy;Parameters
- name
-
string
Name of the PivotHierarchy to be retrieved.
Returns
Remarks
Gets a PivotHierarchy by name. If the PivotHierarchy does not exist, then this method returns an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.
getItemOrNullObject(name: string): Excel.PivotHierarchy;Parameters
- name
-
string
Name of the PivotHierarchy to be retrieved.
Returns
Remarks
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.PivotHierarchyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PivotHierarchyCollection;Parameters
- options
-
Excel.Interfaces.PivotHierarchyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions
Provides options for which properties of the object to load.
Returns
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.PivotHierarchyCollection;Parameters
- propertyNames
-
string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
Returns
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.PivotHierarchyCollection;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
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.PivotHierarchyCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.PivotHierarchyCollectionData) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
toJSON(): Excel.Interfaces.PivotHierarchyCollectionData;Returns
Office Add-ins feedback
Office Add-ins is an open source project. Select a link to provide feedback: