Excel.Interfaces.PivotLayoutData interface

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

Properties

autoFormat

Specifies whether formatting will be automatically formatted when it’s refreshed or when fields are moved

[ API set: ExcelApi 1.9 ]

enableFieldList

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

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

layoutType

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

[ API set: ExcelApi 1.8 ]

preserveFormatting

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

[ API set: ExcelApi 1.9 ]

showColumnGrandTotals

Specifies whether the PivotTable report shows grand totals for columns.

[ API set: ExcelApi 1.8 ]

showRowGrandTotals

Specifies whether the PivotTable report shows grand totals for rows.

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

[ API set: ExcelApi 1.8 ]

Property Details

autoFormat

Specifies whether formatting will be automatically formatted when it’s refreshed or when fields are moved

[ API set: ExcelApi 1.9 ]

autoFormat?: boolean;

Property Value

boolean

enableFieldList

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

enableFieldList?: boolean;

Property Value

boolean

layoutType

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

[ API set: ExcelApi 1.8 ]

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

Property Value

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

preserveFormatting

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

[ API set: ExcelApi 1.9 ]

preserveFormatting?: boolean;

Property Value

boolean

showColumnGrandTotals

Specifies whether the PivotTable report shows grand totals for columns.

[ API set: ExcelApi 1.8 ]

showColumnGrandTotals?: boolean;

Property Value

boolean

showRowGrandTotals

Specifies whether the PivotTable report shows grand totals for rows.

[ API set: ExcelApi 1.8 ]

showRowGrandTotals?: boolean;

Property Value

boolean

subtotalLocation

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

[ API set: ExcelApi 1.8 ]

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

Property Value

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