/
excel.interfaces.nameditemarrayvaluesloadoptions.yml
83 lines (83 loc) · 3.64 KB
/
excel.interfaces.nameditemarrayvaluesloadoptions.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
### YamlMime:TSType
name: Excel.Interfaces.NamedItemArrayValuesLoadOptions
uid: 'excel!Excel.Interfaces.NamedItemArrayValuesLoadOptions:interface'
package: excel!
fullName: Excel.Interfaces.NamedItemArrayValuesLoadOptions
summary: Represents an object containing values and types of a named item.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: interface
properties:
- name: $all
uid: 'excel!Excel.Interfaces.NamedItemArrayValuesLoadOptions#$all:member'
package: excel!
fullName: $all
summary: >-
Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`<!-- -->) but not the
navigational properties (e.g.: `Range.format.fill.color`<!-- -->).
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: '$all?: boolean;'
return:
type: boolean
- name: types
uid: 'excel!Excel.Interfaces.NamedItemArrayValuesLoadOptions#types:member'
package: excel!
fullName: types
summary: Represents the types for each item in the named item array
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'types?: boolean;'
return:
type: boolean
- name: values
uid: 'excel!Excel.Interfaces.NamedItemArrayValuesLoadOptions#values:member'
package: excel!
fullName: values
summary: Represents the values of each item in the named item array.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'values?: boolean;'
return:
type: boolean
- name: valuesAsJson
uid: 'excel!Excel.Interfaces.NamedItemArrayValuesLoadOptions#valuesAsJson:member'
package: excel!
fullName: valuesAsJson
summary: >-
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`<!-- -->.
remarks: '\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'valuesAsJson?: boolean;'
return:
type: boolean
- name: valuesAsJsonLocal
uid: 'excel!Excel.Interfaces.NamedItemArrayValuesLoadOptions#valuesAsJsonLocal:member'
package: excel!
fullName: valuesAsJsonLocal
summary: >-
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`<!-- -->.
remarks: '\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'valuesAsJsonLocal?: boolean;'
return:
type: boolean