Excel.Interfaces.DataPivotHierarchyCollectionLoadOptions interface

Package:

excel

Represents a collection of DataPivotHierarchy items associated with the PivotTable.

Remarks

[ API set: ExcelApi 1.8 ]

Properties

$all	Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).
field	For EACH ITEM in the collection: Returns the PivotFields associated with the DataPivotHierarchy.
id	For EACH ITEM in the collection: ID of the DataPivotHierarchy.
name	For EACH ITEM in the collection: Name of the DataPivotHierarchy.
numberFormat	For EACH ITEM in the collection: Number format of the DataPivotHierarchy.
position	For EACH ITEM in the collection: Position of the DataPivotHierarchy.
showAs	For EACH ITEM in the collection: Specifies if the data should be shown as a specific summary calculation.
summarizeBy	For EACH ITEM in the collection: Specifies if all items of the DataPivotHierarchy are shown.

Property Details

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

$all?: boolean;

Property Value

boolean

field

For EACH ITEM in the collection: Returns the PivotFields associated with the DataPivotHierarchy.

field?: Excel.Interfaces.PivotFieldLoadOptions;

Property Value

Excel.Interfaces.PivotFieldLoadOptions

Remarks

[ API set: ExcelApi 1.8 ]

id

For EACH ITEM in the collection: ID of the DataPivotHierarchy.

id?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

name

For EACH ITEM in the collection: Name of the DataPivotHierarchy.

name?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

numberFormat

For EACH ITEM in the collection: Number format of the DataPivotHierarchy.

numberFormat?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

position

For EACH ITEM in the collection: Position of the DataPivotHierarchy.

position?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

showAs

For EACH ITEM in the collection: Specifies if the data should be shown as a specific summary calculation.

showAs?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

summarizeBy

For EACH ITEM in the collection: Specifies if all items of the DataPivotHierarchy are shown.

summarizeBy?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]