excel.interfaces.tablescopedcollectionloadoptions.yml

### YamlMime:TSType
name: Excel.Interfaces.TableScopedCollectionLoadOptions
uid: 'excel!Excel.Interfaces.TableScopedCollectionLoadOptions:interface'
package: excel!
fullName: Excel.Interfaces.TableScopedCollectionLoadOptions
summary: >-
  Represents a scoped collection of tables. For each table its top-left corner is considered its anchor location, and
  the tables are sorted top-to-bottom and then left-to-right.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: interface
properties:
  - name: $all
    uid: 'excel!Excel.Interfaces.TableScopedCollectionLoadOptions#$all:member'
    package: excel!
    fullName: $all
    summary: >-
      Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`<!-- -->) but not the
      navigational properties (e.g.: `Range.format.fill.color`<!-- -->).
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: '$all?: boolean;'
      return:
        type: boolean
  - name: autoFilter
    uid: 'excel!Excel.Interfaces.TableScopedCollectionLoadOptions#autoFilter:member'
    package: excel!
    fullName: autoFilter
    summary: 'For EACH ITEM in the collection: Represents the `AutoFilter` object of the table.'
    remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'autoFilter?: Excel.Interfaces.AutoFilterLoadOptions;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.AutoFilterLoadOptions:interface" />'
  - name: columns
    uid: 'excel!Excel.Interfaces.TableScopedCollectionLoadOptions#columns:member'
    package: excel!
    fullName: columns
    summary: 'For EACH ITEM in the collection: 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.TableColumnCollectionLoadOptions;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.TableColumnCollectionLoadOptions:interface" />'
  - name: highlightFirstColumn
    uid: 'excel!Excel.Interfaces.TableScopedCollectionLoadOptions#highlightFirstColumn:member'
    package: excel!
    fullName: highlightFirstColumn
    summary: 'For EACH ITEM in the collection: 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.TableScopedCollectionLoadOptions#highlightLastColumn:member'
    package: excel!
    fullName: highlightLastColumn
    summary: 'For EACH ITEM in the collection: 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.TableScopedCollectionLoadOptions#id:member'
    package: excel!
    fullName: id
    summary: >-
      For EACH ITEM in the collection: 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?: boolean;'
      return:
        type: boolean
  - name: legacyId
    uid: 'excel!Excel.Interfaces.TableScopedCollectionLoadOptions#legacyId:member'
    package: excel!
    fullName: legacyId
    summary: 'For EACH ITEM in the collection: Returns a numeric ID.'
    remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'legacyId?: boolean;'
      return:
        type: boolean
  - name: name
    uid: 'excel!Excel.Interfaces.TableScopedCollectionLoadOptions#name:member'
    package: excel!
    fullName: name
    summary: >-
      For EACH ITEM in the collection: 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?: boolean;'
      return:
        type: boolean
  - name: rows
    uid: 'excel!Excel.Interfaces.TableScopedCollectionLoadOptions#rows:member'
    package: excel!
    fullName: rows
    summary: 'For EACH ITEM in the collection: 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.TableRowCollectionLoadOptions;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.TableRowCollectionLoadOptions:interface" />'
  - name: showBandedColumns
    uid: 'excel!Excel.Interfaces.TableScopedCollectionLoadOptions#showBandedColumns:member'
    package: excel!
    fullName: showBandedColumns
    summary: >-
      For EACH ITEM in the collection: 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.TableScopedCollectionLoadOptions#showBandedRows:member'
    package: excel!
    fullName: showBandedRows
    summary: >-
      For EACH ITEM in the collection: 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.TableScopedCollectionLoadOptions#showFilterButton:member'
    package: excel!
    fullName: showFilterButton
    summary: >-
      For EACH ITEM in the collection: 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.TableScopedCollectionLoadOptions#showHeaders:member'
    package: excel!
    fullName: showHeaders
    summary: >-
      For EACH ITEM in the collection: 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.TableScopedCollectionLoadOptions#showTotals:member'
    package: excel!
    fullName: showTotals
    summary: >-
      For EACH ITEM in the collection: 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.TableScopedCollectionLoadOptions#sort:member'
    package: excel!
    fullName: sort
    summary: 'For EACH ITEM in the collection: 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.TableSortLoadOptions;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.TableSortLoadOptions:interface" />'
  - name: style
    uid: 'excel!Excel.Interfaces.TableScopedCollectionLoadOptions#style:member'
    package: excel!
    fullName: style
    summary: >-
      For EACH ITEM in the collection: 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?: boolean;'
      return:
        type: boolean
  - name: tableStyle
    uid: 'excel!Excel.Interfaces.TableScopedCollectionLoadOptions#tableStyle:member'
    package: excel!
    fullName: tableStyle
    summary: 'For EACH ITEM in the collection: The style applied to the table.'
    remarks: '\[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: true
    isDeprecated: false
    syntax:
      content: 'tableStyle?: Excel.Interfaces.TableStyleLoadOptions;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.TableStyleLoadOptions:interface" />'
  - name: worksheet
    uid: 'excel!Excel.Interfaces.TableScopedCollectionLoadOptions#worksheet:member'
    package: excel!
    fullName: worksheet
    summary: 'For EACH ITEM in the collection: The worksheet containing the current table.'
    remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'worksheet?: Excel.Interfaces.WorksheetLoadOptions;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.WorksheetLoadOptions:interface" />'