Edit

Excel.Interfaces.TableColumnUpdateData interface

An interface for updating data on the TableColumn object, for use in tableColumn.set({ ... }).

Remarks

Used by

Properties

name

Specifies the name of the table column.

values

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.

valuesAsJson

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.

valuesAsJsonLocal

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.

Property Details

name

Specifies the name of the table column.

name?: string;

Property Value

string

Remarks

API set: ExcelApi 1.1 for getting the name; 1.4 for setting it.

values

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.

values?: any[][];

Property Value

any[][]

Remarks

API set: ExcelApi 1.1

valuesAsJson

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.

valuesAsJson?: CellValue[][];

Property Value

Remarks

API set: ExcelApi 1.16

valuesAsJsonLocal

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.

valuesAsJsonLocal?: CellValue[][];

Property Value

Remarks

API set: ExcelApi 1.16