Excel.Interfaces.NamedItemArrayValuesLoadOptions interface

Package:

excel

Represents an object containing values and types of a named item.

Remarks

[ API set: ExcelApi 1.7 ]

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).
types	Represents the types for each item in the named item array
values	Represents the values of each item in the named item array.
valuesAsJson	A JSON representation of the values in this named item array. Unlike NamedItemArrayValues.values, NamedItemArrayValues.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 NamedItemArrayValues.valuesAsJsonLocal.
valuesAsJsonLocal	A JSON representation of the values in this named item array. Unlike NamedItemArrayValues.values, NamedItemArrayValues.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 NamedItemArrayValues.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

types

Represents the types for each item in the named item array

types?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

values

Represents the values of each item in the named item array.

values?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

valuesAsJson

A JSON representation of the values in this named item array. Unlike NamedItemArrayValues.values, NamedItemArrayValues.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 NamedItemArrayValues.valuesAsJsonLocal.

valuesAsJson?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.16 ]

valuesAsJsonLocal

A JSON representation of the values in this named item array. Unlike NamedItemArrayValues.values, NamedItemArrayValues.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 NamedItemArrayValues.valuesAsJson.

valuesAsJsonLocal?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.16 ]