excel.interfaces.tabledata.yml

### YamlMime:TSType
name: Excel.Interfaces.TableData
uid: 'excel!Excel.Interfaces.TableData:interface'
package: excel!
fullName: Excel.Interfaces.TableData
summary: An interface describing the data returned by calling `table.toJSON()`<!-- -->.
remarks: ''
isPreview: false
isDeprecated: false
type: interface
properties:
  - name: columns
    uid: 'excel!Excel.Interfaces.TableData#columns:member'
    package: excel!
    fullName: columns
    summary: Represents a collection of all the columns in the table.
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'columns?: Excel.Interfaces.TableColumnData[];'
      return:
        type: '<xref uid="excel!Excel.Interfaces.TableColumnData:interface" />[]'
  - name: highlightFirstColumn
    uid: 'excel!Excel.Interfaces.TableData#highlightFirstColumn:member'
    package: excel!
    fullName: highlightFirstColumn
    summary: Specifies if the first column contains special formatting.
    remarks: '\[ [API set: ExcelApi 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'highlightFirstColumn?: boolean;'
      return:
        type: boolean
  - name: highlightLastColumn
    uid: 'excel!Excel.Interfaces.TableData#highlightLastColumn:member'
    package: excel!
    fullName: highlightLastColumn
    summary: Specifies if the last column contains special formatting.
    remarks: '\[ [API set: ExcelApi 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'highlightLastColumn?: boolean;'
      return:
        type: boolean
  - name: id
    uid: 'excel!Excel.Interfaces.TableData#id:member'
    package: excel!
    fullName: id
    summary: >-
      Returns a value that uniquely identifies the table in a given workbook. The value of the identifier remains the
      same even when the table is renamed.
    remarks: '\[ [API set: ExcelApi 1.1](/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.TableData#name:member'
    package: excel!
    fullName: name
    summary: >-
      Name of the table.


      The set name of the table must follow the guidelines specified in the [Rename an Excel
      table](https://support.microsoft.com/office/fbf49a4f-82a3-43eb-8ba2-44d21233b114) article.
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'name?: string;'
      return:
        type: string
  - name: rows
    uid: 'excel!Excel.Interfaces.TableData#rows:member'
    package: excel!
    fullName: rows
    summary: Represents a collection of all the rows in the table.
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'rows?: Excel.Interfaces.TableRowData[];'
      return:
        type: '<xref uid="excel!Excel.Interfaces.TableRowData:interface" />[]'
  - name: showBandedColumns
    uid: 'excel!Excel.Interfaces.TableData#showBandedColumns:member'
    package: excel!
    fullName: showBandedColumns
    summary: >-
      Specifies if the columns show banded formatting in which odd columns are highlighted differently from even ones,
      to make reading the table easier.
    remarks: '\[ [API set: ExcelApi 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'showBandedColumns?: boolean;'
      return:
        type: boolean
  - name: showBandedRows
    uid: 'excel!Excel.Interfaces.TableData#showBandedRows:member'
    package: excel!
    fullName: showBandedRows
    summary: >-
      Specifies if the rows show banded formatting in which odd rows are highlighted differently from even ones, to make
      reading the table easier.
    remarks: '\[ [API set: ExcelApi 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'showBandedRows?: boolean;'
      return:
        type: boolean
  - name: showFilterButton
    uid: 'excel!Excel.Interfaces.TableData#showFilterButton:member'
    package: excel!
    fullName: showFilterButton
    summary: >-
      Specifies if the filter buttons are visible at the top of each column header. Setting this is only allowed if the
      table contains a header row.
    remarks: '\[ [API set: ExcelApi 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'showFilterButton?: boolean;'
      return:
        type: boolean
  - name: showHeaders
    uid: 'excel!Excel.Interfaces.TableData#showHeaders:member'
    package: excel!
    fullName: showHeaders
    summary: Specifies if the header row is visible. This value can be set to show or remove the header row.
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'showHeaders?: boolean;'
      return:
        type: boolean
  - name: showTotals
    uid: 'excel!Excel.Interfaces.TableData#showTotals:member'
    package: excel!
    fullName: showTotals
    summary: Specifies if the total row is visible. This value can be set to show or remove the total row.
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'showTotals?: boolean;'
      return:
        type: boolean
  - name: sort
    uid: 'excel!Excel.Interfaces.TableData#sort:member'
    package: excel!
    fullName: sort
    summary: Represents the sorting for the table.
    remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'sort?: Excel.Interfaces.TableSortData;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.TableSortData:interface" />'
  - name: style
    uid: 'excel!Excel.Interfaces.TableData#style:member'
    package: excel!
    fullName: style
    summary: >-
      Constant value that represents the table style. Possible values are: "TableStyleLight1" through
      "TableStyleLight21", "TableStyleMedium1" through "TableStyleMedium28", "TableStyleDark1" through
      "TableStyleDark11". A custom user-defined style present in the workbook can also be specified.
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'style?: string;'
      return:
        type: string