excel.interfaces.pivottabledata.yml

### YamlMime:TSType
name: Excel.Interfaces.PivotTableData
uid: 'excel!Excel.Interfaces.PivotTableData:interface'
package: excel!
fullName: Excel.Interfaces.PivotTableData
summary: An interface describing the data returned by calling `pivotTable.toJSON()`<!-- -->.
remarks: ''
isPreview: false
isDeprecated: false
type: interface
properties:
  - name: allowMultipleFiltersPerField
    uid: 'excel!Excel.Interfaces.PivotTableData#allowMultipleFiltersPerField:member'
    package: excel!
    fullName: allowMultipleFiltersPerField
    summary: Specifies if the PivotTable allows the application of multiple PivotFilters on a given PivotField in the table.
    remarks: '\[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'allowMultipleFiltersPerField?: boolean;'
      return:
        type: boolean
  - name: columnHierarchies
    uid: 'excel!Excel.Interfaces.PivotTableData#columnHierarchies:member'
    package: excel!
    fullName: columnHierarchies
    summary: The Column Pivot Hierarchies of the PivotTable.
    remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'columnHierarchies?: Excel.Interfaces.RowColumnPivotHierarchyData[];'
      return:
        type: '<xref uid="excel!Excel.Interfaces.RowColumnPivotHierarchyData:interface" />[]'
  - name: dataHierarchies
    uid: 'excel!Excel.Interfaces.PivotTableData#dataHierarchies:member'
    package: excel!
    fullName: dataHierarchies
    summary: The Data Pivot Hierarchies of the PivotTable.
    remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'dataHierarchies?: Excel.Interfaces.DataPivotHierarchyData[];'
      return:
        type: '<xref uid="excel!Excel.Interfaces.DataPivotHierarchyData:interface" />[]'
  - name: enableDataValueEditing
    uid: 'excel!Excel.Interfaces.PivotTableData#enableDataValueEditing:member'
    package: excel!
    fullName: enableDataValueEditing
    summary: Specifies if the PivotTable allows values in the data body to be edited by the user.
    remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'enableDataValueEditing?: boolean;'
      return:
        type: boolean
  - name: filterHierarchies
    uid: 'excel!Excel.Interfaces.PivotTableData#filterHierarchies:member'
    package: excel!
    fullName: filterHierarchies
    summary: The Filter Pivot Hierarchies of the PivotTable.
    remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'filterHierarchies?: Excel.Interfaces.FilterPivotHierarchyData[];'
      return:
        type: '<xref uid="excel!Excel.Interfaces.FilterPivotHierarchyData:interface" />[]'
  - name: hierarchies
    uid: 'excel!Excel.Interfaces.PivotTableData#hierarchies:member'
    package: excel!
    fullName: hierarchies
    summary: The Pivot Hierarchies of the PivotTable.
    remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'hierarchies?: Excel.Interfaces.PivotHierarchyData[];'
      return:
        type: '<xref uid="excel!Excel.Interfaces.PivotHierarchyData:interface" />[]'
  - name: id
    uid: 'excel!Excel.Interfaces.PivotTableData#id:member'
    package: excel!
    fullName: id
    summary: ID of the PivotTable.
    remarks: '\[ [API set: ExcelApi 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'id?: string;'
      return:
        type: string
  - name: name
    uid: 'excel!Excel.Interfaces.PivotTableData#name:member'
    package: excel!
    fullName: name
    summary: Name of the PivotTable.
    remarks: '\[ [API set: ExcelApi 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'name?: string;'
      return:
        type: string
  - name: refreshOnOpen
    uid: 'excel!Excel.Interfaces.PivotTableData#refreshOnOpen:member'
    package: excel!
    fullName: refreshOnOpen
    summary: >-
      Specifies whether the PivotTable refreshes when the workbook opens. Corresponds to "Refresh on load" setting in
      the UI.
    remarks: '\[ [API set: ExcelApi 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'refreshOnOpen?: boolean;'
      return:
        type: boolean
  - name: rowHierarchies
    uid: 'excel!Excel.Interfaces.PivotTableData#rowHierarchies:member'
    package: excel!
    fullName: rowHierarchies
    summary: The Row Pivot Hierarchies of the PivotTable.
    remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'rowHierarchies?: Excel.Interfaces.RowColumnPivotHierarchyData[];'
      return:
        type: '<xref uid="excel!Excel.Interfaces.RowColumnPivotHierarchyData:interface" />[]'
  - name: useCustomSortLists
    uid: 'excel!Excel.Interfaces.PivotTableData#useCustomSortLists:member'
    package: excel!
    fullName: useCustomSortLists
    summary: Specifies if the PivotTable uses custom lists when sorting.
    remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'useCustomSortLists?: boolean;'
      return:
        type: boolean