Excel.Interfaces.PivotLayoutData interface
An interface describing the data returned by calling pivotLayout.toJSON().
Properties
| alt |
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. |
| alt |
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. |
| auto |
Specifies if formatting will be automatically formatted when it's refreshed or when fields are moved. |
| empty |
The text that is automatically filled into any empty cell in the PivotTable if |
| enable |
Specifies if the field list can be shown in the UI. |
| fill |
Specifies whether empty cells in the PivotTable should be populated with the |
| layout |
This property indicates the PivotLayoutType of all fields on the PivotTable. If fields have different states, this will be null. |
| pivot |
The style applied to the PivotTable. |
| preserve |
Specifies if formatting is preserved when the report is refreshed or recalculated by operations such as pivoting, sorting, or changing page field items. |
| show |
Specifies if the PivotTable report shows grand totals for columns. |
| show |
Specifies whether the PivotTable displays field headers (field captions and filter drop-downs). |
| show |
Specifies if the PivotTable report shows grand totals for rows. |
| subtotal |
This property indicates the |
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
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
autoFormat
Specifies if formatting will be automatically formatted when it's refreshed or when fields are moved.
autoFormat?: boolean;Property Value
boolean
Remarks
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
enableFieldList
Specifies if the field list can be shown in the UI.
enableFieldList?: boolean;Property Value
boolean
Remarks
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
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
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
Remarks
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
showColumnGrandTotals
Specifies if the PivotTable report shows grand totals for columns.
showColumnGrandTotals?: boolean;Property Value
boolean
Remarks
showFieldHeaders
Specifies whether the PivotTable displays field headers (field captions and filter drop-downs).
showFieldHeaders?: boolean;Property Value
boolean
Remarks
showRowGrandTotals
Specifies if the PivotTable report shows grand totals for rows.
showRowGrandTotals?: boolean;Property Value
boolean
Remarks
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
Office Add-ins
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for