excel.interfaces.tablecolumnloadoptions.yml

### YamlMime:TSType
name: Excel.Interfaces.TableColumnLoadOptions
uid: 'excel!Excel.Interfaces.TableColumnLoadOptions:interface'
package: excel!
fullName: Excel.Interfaces.TableColumnLoadOptions
summary: Represents a column in a table.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: interface
properties:
  - name: $all
    uid: 'excel!Excel.Interfaces.TableColumnLoadOptions#$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: filter
    uid: 'excel!Excel.Interfaces.TableColumnLoadOptions#filter:member'
    package: excel!
    fullName: filter
    summary: Retrieves the filter applied to the column.
    remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'filter?: Excel.Interfaces.FilterLoadOptions;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.FilterLoadOptions:interface" />'
  - name: id
    uid: 'excel!Excel.Interfaces.TableColumnLoadOptions#id:member'
    package: excel!
    fullName: id
    summary: Returns a unique key that identifies the column within the table.
    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: index
    uid: 'excel!Excel.Interfaces.TableColumnLoadOptions#index:member'
    package: excel!
    fullName: index
    summary: Returns the index number of the column within the columns collection of the table. Zero-indexed.
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'index?: boolean;'
      return:
        type: boolean
  - name: name
    uid: 'excel!Excel.Interfaces.TableColumnLoadOptions#name:member'
    package: excel!
    fullName: name
    summary: Specifies the name of the table column.
    remarks: >-
      \[ [API set: ExcelApi 1.1 for getting the name; 1.4 for setting
      it.](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'name?: boolean;'
      return:
        type: boolean
  - name: values
    uid: 'excel!Excel.Interfaces.TableColumnLoadOptions#values:member'
    package: excel!
    fullName: values
    summary: >-
      Represents the raw values of the specified range. The data returned could be a string, number, or boolean. Cells
      that contain an error will return the error string. If the returned value starts with a plus ("+"), minus ("-"),
      or equal sign ("="), Excel interprets this value as a formula.
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'values?: boolean;'
      return:
        type: boolean
  - name: valuesAsJson
    uid: 'excel!Excel.Interfaces.TableColumnLoadOptions#valuesAsJson:member'
    package: excel!
    fullName: valuesAsJson
    summary: >-
      A JSON representation of the values in the cells in this table column. Unlike `TableColumn.values`<!-- -->,
      `TableColumn.valuesAsJson` supports all data types which can be in a cell. Examples include formatted number
      values and web images, in addition to the standard boolean, number, and string values. Data returned from this API
      always aligns with the en-US locale. To retrieve data in the user's display locale, use
      `TableColumn.valuesAsJsonLocal`<!-- -->.
    remarks: '\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'valuesAsJson?: boolean;'
      return:
        type: boolean
  - name: valuesAsJsonLocal
    uid: 'excel!Excel.Interfaces.TableColumnLoadOptions#valuesAsJsonLocal:member'
    package: excel!
    fullName: valuesAsJsonLocal
    summary: >-
      A JSON representation of the values in the cells in this table column. Unlike `TableColumn.values`<!-- -->,
      `TableColumn.valuesAsJsonLocal` supports all data types which can be in a cell. Examples include formatted number
      values and web images, in addition to the standard boolean, number, and string values. Data returned from this API
      always aligns with the user's display locale. To retrieve data independent of locale, use
      `TableColumn.valuesAsJson`<!-- -->.
    remarks: '\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'valuesAsJsonLocal?: boolean;'
      return:
        type: boolean