Excel.RowColumnPivotHierarchy class
Represents the Excel RowColumnPivotHierarchy.
- 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. |
fields | Returns the PivotFields associated with the RowColumnPivotHierarchy. |
id | ID of the RowColumnPivotHierarchy. |
name | Name of the RowColumnPivotHierarchy. |
position | Position of the RowColumnPivotHierarchy. |
Methods
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 |
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. |
set |
Reset the RowColumnPivotHierarchy back to its default values. |
toJSON() | Overrides the JavaScript |
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
fields
Returns the PivotFields associated with the RowColumnPivotHierarchy.
readonly fields: Excel.PivotFieldCollection;
Property Value
Remarks
id
ID of the RowColumnPivotHierarchy.
readonly id: string;
Property Value
string
Remarks
name
Name of the RowColumnPivotHierarchy.
name: string;
Property Value
string
Remarks
position
Position of the RowColumnPivotHierarchy.
position: number;
Property Value
number
Remarks
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.RowColumnPivotHierarchyLoadOptions): Excel.RowColumnPivotHierarchy;
Parameters
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.RowColumnPivotHierarchy;
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?: {
select?: string;
expand?: string;
}): Excel.RowColumnPivotHierarchy;
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
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.RowColumnPivotHierarchyUpdateData, options?: OfficeExtension.UpdateOptions): void;
Parameters
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.RowColumnPivotHierarchy): void;
Parameters
- properties
- Excel.RowColumnPivotHierarchy
Returns
void
setToDefault()
Reset the RowColumnPivotHierarchy back to its default values.
setToDefault(): void;
Returns
void
Remarks
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.RowColumnPivotHierarchy
object is an API object, the toJSON
method returns a plain JavaScript object (typed as Excel.Interfaces.RowColumnPivotHierarchyData
) that contains shallow copies of any loaded child properties from the original object.
toJSON(): Excel.Interfaces.RowColumnPivotHierarchyData;
Returns
Office Add-ins