Excel.DataPivotHierarchyCollection class
Warning
This API is now deprecated.
Represents a collection of DataPivotHierarchy items associated with the PivotTable.
- Extends
Remarks
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(pivot |
Adds the PivotHierarchy to the current axis. |
get |
Gets the number of pivot hierarchies in the collection. |
get |
Gets a DataPivotHierarchy by its name or ID. |
get |
Gets a DataPivotHierarchy by name. If the DataPivotHierarchy 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 |
remove(Data |
Removes the PivotHierarchy from the current axis. |
toJSON() | Overrides the JavaScript |
Property Details
context
Warning
This API is now deprecated.
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
Warning
This API is now deprecated.
Gets the loaded child items in this collection.
readonly items: Excel.DataPivotHierarchy[];
Property Value
Method Details
add(pivotHierarchy)
Warning
This API is now deprecated.
Adds the PivotHierarchy to the current axis.
add(pivotHierarchy: Excel.PivotHierarchy): Excel.DataPivotHierarchy;
Parameters
- pivotHierarchy
- Excel.PivotHierarchy
Returns
Remarks
getCount()
Warning
This API is now deprecated.
Gets the number of pivot hierarchies in the collection.
getCount(): OfficeExtension.ClientResult<number>;
Returns
OfficeExtension.ClientResult<number>
Remarks
getItem(name)
Warning
This API is now deprecated.
Gets a DataPivotHierarchy by its name or ID.
getItem(name: string): Excel.DataPivotHierarchy;
Parameters
- name
-
string
Name of the DataPivotHierarchy to be retrieved.
Returns
Remarks
getItemOrNullObject(name)
Warning
This API is now deprecated.
Gets a DataPivotHierarchy by name. If the DataPivotHierarchy 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.DataPivotHierarchy;
Parameters
- name
-
string
Name of the DataPivotHierarchy to be retrieved.
Returns
Remarks
load(options)
Warning
This API is now deprecated.
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.DataPivotHierarchyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.DataPivotHierarchyCollection;
Parameters
- options
-
Excel.Interfaces.DataPivotHierarchyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions
Provides options for which properties of the object to load.
Returns
load(propertyNames)
Warning
This API is now deprecated.
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.DataPivotHierarchyCollection;
Parameters
- propertyNames
-
string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
Returns
load(propertyNamesAndPaths)
Warning
This API is now deprecated.
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.DataPivotHierarchyCollection;
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(DataPivotHierarchy)
Warning
This API is now deprecated.
Removes the PivotHierarchy from the current axis.
remove(DataPivotHierarchy: Excel.DataPivotHierarchy): void;
Parameters
- DataPivotHierarchy
- Excel.DataPivotHierarchy
Returns
void
Remarks
toJSON()
Warning
This API is now deprecated.
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.DataPivotHierarchyCollection
object is an API object, the toJSON
method returns a plain JavaScript object (typed as Excel.Interfaces.DataPivotHierarchyCollectionData
) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
toJSON(): Excel.Interfaces.DataPivotHierarchyCollectionData;
Returns
Office Add-ins