Excel.Interfaces.TableColumnData interface

Package:

excel

An interface describing the data returned by calling tableColumn.toJSON().

Properties

filter	Retrieves the filter applied to the column.
id	Returns a unique key that identifies the column within the table.
index	Returns the index number of the column within the columns collection of the table. Zero-indexed.
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.

Property Details

filter

Retrieves the filter applied to the column.

filter?: Excel.Interfaces.FilterData;

Property Value

Excel.Interfaces.FilterData

Remarks

[ API set: ExcelApi 1.2 ]

id

Returns a unique key that identifies the column within the table.

id?: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.1 ]

index

Returns the index number of the column within the columns collection of the table. Zero-indexed.

index?: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.1 ]

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 ]