Edit

Share via

Excel.Interfaces.PivotLayoutData interface

  • Reference
Package:
excel

An interface describing the data returned by calling pivotLayout.toJSON().

Properties

autoFormat

Specifies if formatting will be automatically formatted when it's refreshed or when fields are moved.
enableFieldList

Specifies if the field list can be shown in the UI.
layoutType

This property indicates the PivotLayoutType of all fields on the PivotTable. If fields have different states, this will be null.
preserveFormatting

Specifies if formatting is preserved when the report is refreshed or recalculated by operations such as pivoting, sorting, or changing page field items.
showColumnGrandTotals

Specifies if the PivotTable report shows grand totals for columns.
showRowGrandTotals

Specifies if the PivotTable report shows grand totals for rows.
subtotalLocation

This property indicates the SubtotalLocationType of all fields on the PivotTable. If fields have different states, this will be null.

Property Details

autoFormat

Specifies if formatting will be automatically formatted when it's refreshed or when fields are moved.

autoFormat?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

enableFieldList

Specifies if the field list can be shown in the UI.

enableFieldList?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.10 ]

layoutType

This property indicates the PivotLayoutType of all fields on the PivotTable. If fields have different states, this will be null.

layoutType?: Excel.PivotLayoutType | "Compact" | "Tabular" | "Outline";

Property Value

Excel.PivotLayoutType | "Compact" | "Tabular" | "Outline"

Remarks

[ API set: ExcelApi 1.8 ]

preserveFormatting

Specifies if formatting is preserved when the report is refreshed or recalculated by operations such as pivoting, sorting, or changing page field items.

preserveFormatting?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

showColumnGrandTotals

Specifies if the PivotTable report shows grand totals for columns.

showColumnGrandTotals?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

showRowGrandTotals

Specifies if the PivotTable report shows grand totals for rows.

showRowGrandTotals?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

subtotalLocation

This property indicates the SubtotalLocationType of all fields on the PivotTable. If fields have different states, this will be null.

subtotalLocation?: Excel.SubtotalLocationType | "AtTop" | "AtBottom" | "Off";

Property Value

Excel.SubtotalLocationType | "AtTop" | "AtBottom" | "Off"

Remarks

[ API set: ExcelApi 1.8 ]