Excel.Interfaces.PivotLayoutData interface

Package:

excel

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

Properties

altTextDescription	The alt text description of the PivotTable. Alt text provides alternative, text-based representations of the information contained in the PivotTable. This information is useful for people with vision or cognitive impairments who may not be able to see or understand the table. A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
altTextTitle	The alt text title of the PivotTable. Alt text provides alternative, text-based representations of the information contained in the PivotTable. This information is useful for people with vision or cognitive impairments who may not be able to see or understand the table. A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
autoFormat	Specifies if formatting will be automatically formatted when it's refreshed or when fields are moved.
emptyCellText	The text that is automatically filled into any empty cell in the PivotTable if fillEmptyCells == true. Note that this value persists if fillEmptyCells is set to false, and that setting this value does not set that property to true. By default, this is an empty string.
enableFieldList	Specifies if the field list can be shown in the UI.
fillEmptyCells	Specifies whether empty cells in the PivotTable should be populated with the emptyCellText. Default is false. Note that the value of emptyCellText persists when this property is set to false.
layoutType	This property indicates the PivotLayoutType of all fields on the PivotTable. If fields have different states, this will be null.
pivotStyle	The style applied to the PivotTable.
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.
showFieldHeaders	Specifies whether the PivotTable displays field headers (field captions and filter drop-downs).
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

altTextDescription

The alt text description of the PivotTable.

Alt text provides alternative, text-based representations of the information contained in the PivotTable. This information is useful for people with vision or cognitive impairments who may not be able to see or understand the table. A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.

altTextDescription?: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.13 ]

altTextTitle

The alt text title of the PivotTable.

Alt text provides alternative, text-based representations of the information contained in the PivotTable. This information is useful for people with vision or cognitive impairments who may not be able to see or understand the table. A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.

altTextTitle?: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.13 ]

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 ]

emptyCellText

The text that is automatically filled into any empty cell in the PivotTable if fillEmptyCells == true. Note that this value persists if fillEmptyCells is set to false, and that setting this value does not set that property to true. By default, this is an empty string.

emptyCellText?: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.13 ]

enableFieldList

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

enableFieldList?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.10 ]

fillEmptyCells

Specifies whether empty cells in the PivotTable should be populated with the emptyCellText. Default is false. Note that the value of emptyCellText persists when this property is set to false.

fillEmptyCells?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.13 ]

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 ]

pivotStyle

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.

The style applied to the PivotTable.

pivotStyle?: Excel.Interfaces.PivotTableStyleData;

Property Value

Excel.Interfaces.PivotTableStyleData

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

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 ]

showFieldHeaders

Specifies whether the PivotTable displays field headers (field captions and filter drop-downs).

showFieldHeaders?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.13 ]

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 ]