excel.interfaces.pivotlayoutdata.yml

### YamlMime:TSType
name: Excel.Interfaces.PivotLayoutData
uid: 'excel!Excel.Interfaces.PivotLayoutData:interface'
package: excel!
fullName: Excel.Interfaces.PivotLayoutData
summary: An interface describing the data returned by calling `pivotLayout.toJSON()`<!-- -->.
remarks: ''
isPreview: false
isDeprecated: false
type: interface
properties:
  - name: altTextDescription
    uid: 'excel!Excel.Interfaces.PivotLayoutData#altTextDescription:member'
    package: excel!
    fullName: altTextDescription
    summary: >-
      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.
    remarks: '\[ [API set: ExcelApi 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'altTextDescription?: string;'
      return:
        type: string
  - name: altTextTitle
    uid: 'excel!Excel.Interfaces.PivotLayoutData#altTextTitle:member'
    package: excel!
    fullName: altTextTitle
    summary: >-
      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.
    remarks: '\[ [API set: ExcelApi 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'altTextTitle?: string;'
      return:
        type: string
  - name: autoFormat
    uid: 'excel!Excel.Interfaces.PivotLayoutData#autoFormat:member'
    package: excel!
    fullName: autoFormat
    summary: Specifies if formatting will be automatically formatted when it's refreshed or when fields are moved.
    remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'autoFormat?: boolean;'
      return:
        type: boolean
  - name: emptyCellText
    uid: 'excel!Excel.Interfaces.PivotLayoutData#emptyCellText:member'
    package: excel!
    fullName: emptyCellText
    summary: >-
      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.
    remarks: '\[ [API set: ExcelApi 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'emptyCellText?: string;'
      return:
        type: string
  - name: enableFieldList
    uid: 'excel!Excel.Interfaces.PivotLayoutData#enableFieldList:member'
    package: excel!
    fullName: enableFieldList
    summary: Specifies if the field list can be shown in the UI.
    remarks: '\[ [API set: ExcelApi 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'enableFieldList?: boolean;'
      return:
        type: boolean
  - name: fillEmptyCells
    uid: 'excel!Excel.Interfaces.PivotLayoutData#fillEmptyCells:member'
    package: excel!
    fullName: fillEmptyCells
    summary: >-
      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`<!-- -->.
    remarks: '\[ [API set: ExcelApi 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'fillEmptyCells?: boolean;'
      return:
        type: boolean
  - name: layoutType
    uid: 'excel!Excel.Interfaces.PivotLayoutData#layoutType:member'
    package: excel!
    fullName: layoutType
    summary: >-
      This property indicates the PivotLayoutType of all fields on the PivotTable. If fields have different states, this
      will be null.
    remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'layoutType?: Excel.PivotLayoutType | "Compact" | "Tabular" | "Outline";'
      return:
        type: '<xref uid="excel!Excel.PivotLayoutType:enum" /> | "Compact" | "Tabular" | "Outline"'
  - name: preserveFormatting
    uid: 'excel!Excel.Interfaces.PivotLayoutData#preserveFormatting:member'
    package: excel!
    fullName: preserveFormatting
    summary: >-
      Specifies if formatting is preserved when the report is refreshed or recalculated by operations such as pivoting,
      sorting, or changing page field items.
    remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'preserveFormatting?: boolean;'
      return:
        type: boolean
  - name: showColumnGrandTotals
    uid: 'excel!Excel.Interfaces.PivotLayoutData#showColumnGrandTotals:member'
    package: excel!
    fullName: showColumnGrandTotals
    summary: Specifies if the PivotTable report shows grand totals for columns.
    remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'showColumnGrandTotals?: boolean;'
      return:
        type: boolean
  - name: showFieldHeaders
    uid: 'excel!Excel.Interfaces.PivotLayoutData#showFieldHeaders:member'
    package: excel!
    fullName: showFieldHeaders
    summary: Specifies whether the PivotTable displays field headers (field captions and filter drop-downs).
    remarks: '\[ [API set: ExcelApi 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'showFieldHeaders?: boolean;'
      return:
        type: boolean
  - name: showRowGrandTotals
    uid: 'excel!Excel.Interfaces.PivotLayoutData#showRowGrandTotals:member'
    package: excel!
    fullName: showRowGrandTotals
    summary: Specifies if the PivotTable report shows grand totals for rows.
    remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'showRowGrandTotals?: boolean;'
      return:
        type: boolean
  - name: subtotalLocation
    uid: 'excel!Excel.Interfaces.PivotLayoutData#subtotalLocation:member'
    package: excel!
    fullName: subtotalLocation
    summary: >-
      This property indicates the `SubtotalLocationType` of all fields on the PivotTable. If fields have different
      states, this will be `null`<!-- -->.
    remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'subtotalLocation?: Excel.SubtotalLocationType | "AtTop" | "AtBottom" | "Off";'
      return:
        type: '<xref uid="excel!Excel.SubtotalLocationType:enum" /> | "AtTop" | "AtBottom" | "Off"'