Excel.NamedItemArrayValues class

Package:

excel

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

Extends

OfficeExtension.ClientObject

Remarks

[ API set: ExcelApi 1.7 ]

Properties

context	The request context associated with the object. This connects the add-in's process to the Office host application's process.
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.

Methods

load(options)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
toJSON()	Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.NamedItemArrayValues object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.NamedItemArrayValuesData) that contains shallow copies of any loaded child properties from the original object.

Property Details

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

context: RequestContext;

Property Value

Excel.RequestContext

types

Represents the types for each item in the named item array

readonly types: Excel.RangeValueType[][];

Property Value

Excel.RangeValueType[][]

Remarks

[ API set: ExcelApi 1.7 ]

values

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

readonly values: any[][];

Property Value

any[][]

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.

readonly valuesAsJson: CellValue[][];

Property Value

Excel.CellValue[][]

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.

readonly valuesAsJsonLocal: CellValue[][];

Property Value

Excel.CellValue[][]

Remarks

[ API set: ExcelApi 1.16 ]

Method Details

load(options)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(options?: Excel.Interfaces.NamedItemArrayValuesLoadOptions): Excel.NamedItemArrayValues;

Parameters

options

Excel.Interfaces.NamedItemArrayValuesLoadOptions

Provides options for which properties of the object to load.

Returns

Excel.NamedItemArrayValues

load(propertyNames)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNames?: string | string[]): Excel.NamedItemArrayValues;

Parameters

propertyNames

string | string[]

A comma-delimited string or an array of strings that specify the properties to load.

Returns

Excel.NamedItemArrayValues

load(propertyNamesAndPaths)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.NamedItemArrayValues;

Parameters

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.

Returns

Excel.NamedItemArrayValues

toJSON()

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.NamedItemArrayValues object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.NamedItemArrayValuesData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.NamedItemArrayValuesData;

Returns

Excel.Interfaces.NamedItemArrayValuesData