Edit

Share via

Excel.Interfaces.TableRowLoadOptions interface

  • Reference
Package:
excel

Represents a row in a table.

Note that unlike ranges or columns, which will adjust if new rows or columns are added before them, a TableRow object represents the physical location of the table row, but not the data. That is, if the data is sorted or if new rows are added, a table row will continue to point at the index for which it was created.

Remarks

[ API set: ExcelApi 1.1 ]

Properties

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).
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

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

$all?: boolean;

Property Value

boolean

index

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

index?: boolean;

Property Value

boolean

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?: boolean;

Property Value

boolean

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?: boolean;

Property Value

boolean

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?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.16 ]