Edit

Share via

Excel.Interfaces.PivotItemCollectionLoadOptions interface

  • Reference
Package:
excel

Represents a collection of all the PivotItems related to their parent PivotField.

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).
id

For EACH ITEM in the collection: ID of the PivotItem.
isExpanded

For EACH ITEM in the collection: Determines whether the item is expanded to show child items or if it's collapsed and child items are hidden.
name

For EACH ITEM in the collection: Name of the PivotItem.
visible

For EACH ITEM in the collection: Specifies if the PivotItem is visible.

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

id

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

id?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

isExpanded

For EACH ITEM in the collection: Determines whether the item is expanded to show child items or if it's collapsed and child items are hidden.

isExpanded?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

name

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

name?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

visible

For EACH ITEM in the collection: Specifies if the PivotItem is visible.

visible?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]