Excel.Interfaces.TableRowData interface

Package:

excel

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

Properties

index	Returns the index number of the row within the rows collection of the table. Zero-indexed.
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 row. Unlike TableRow.values, TableRow.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 TableRow.valuesAsJsonLocal.
valuesAsJsonLocal	A JSON representation of the values in the cells in this table row. Unlike TableRow.values, TableRow.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 TableRow.valuesAsJson.

Property Details

index

Returns the index number of the row within the rows collection of the table. Zero-indexed.

index?: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.1 ]

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 row. Unlike TableRow.values, TableRow.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 TableRow.valuesAsJsonLocal.

valuesAsJson?: CellValue[][];

Property Value

Excel.CellValue[][]

Remarks

[ API set: ExcelApi 1.16 ]

valuesAsJsonLocal

A JSON representation of the values in the cells in this table row. Unlike TableRow.values, TableRow.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 TableRow.valuesAsJson.

valuesAsJsonLocal?: CellValue[][];

Property Value

Excel.CellValue[][]

Remarks

[ API set: ExcelApi 1.16 ]