Edit

Share via

Excel.Interfaces.PivotFieldCollectionLoadOptions interface

  • Reference
Package:
excel

Represents a collection of all the PivotFields that are part of a PivotTable's hierarchy.

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 PivotField.
name

For EACH ITEM in the collection: Name of the PivotField.
showAllItems

For EACH ITEM in the collection: Determines whether to show all items of the PivotField.
subtotals

For EACH ITEM in the collection: Subtotals of the PivotField.

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 PivotField.

id?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

name

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

name?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

showAllItems

For EACH ITEM in the collection: Determines whether to show all items of the PivotField.

showAllItems?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

subtotals

For EACH ITEM in the collection: Subtotals of the PivotField.

subtotals?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]