/
excel.rangeview.yml
317 lines (317 loc) · 12.1 KB
/
excel.rangeview.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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
### YamlMime:TSType
name: Excel.RangeView
uid: 'excel!Excel.RangeView:class'
package: excel!
fullName: Excel.RangeView
summary: RangeView represents a set of visible cells of the parent range.
remarks: '\[ [API set: ExcelApi 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: class
properties:
- name: cellAddresses
uid: 'excel!Excel.RangeView#cellAddresses:member'
package: excel!
fullName: cellAddresses
summary: Represents the cell addresses of the `RangeView`<!-- -->.
remarks: '\[ [API set: ExcelApi 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly cellAddresses: any[][];'
return:
type: 'any[][]'
- name: columnCount
uid: 'excel!Excel.RangeView#columnCount:member'
package: excel!
fullName: columnCount
summary: The number of visible columns.
remarks: '\[ [API set: ExcelApi 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly columnCount: number;'
return:
type: number
- name: context
uid: 'excel!Excel.RangeView#context:member'
package: excel!
fullName: context
summary: >-
The request context associated with the object. This connects the add-in's process to the Office host
application's process.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'context: RequestContext;'
return:
type: '<xref uid="excel!Excel.RequestContext:class" />'
- name: formulas
uid: 'excel!Excel.RangeView#formulas:member'
package: excel!
fullName: formulas
summary: 'Represents the formula in A1-style notation. If a cell has no formula, its value is returned instead.'
remarks: '\[ [API set: ExcelApi 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'formulas: any[][];'
return:
type: 'any[][]'
- name: formulasLocal
uid: 'excel!Excel.RangeView#formulasLocal:member'
package: excel!
fullName: formulasLocal
summary: >-
Represents the formula in A1-style notation, in the user's language and number-formatting locale. For example, the
English "=SUM(A1, 1.5)" formula would become "=SUMME(A1; 1,5)" in German. If a cell has no formula, its value is
returned instead.
remarks: '\[ [API set: ExcelApi 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'formulasLocal: any[][];'
return:
type: 'any[][]'
- name: formulasR1C1
uid: 'excel!Excel.RangeView#formulasR1C1:member'
package: excel!
fullName: formulasR1C1
summary: 'Represents the formula in R1C1-style notation. If a cell has no formula, its value is returned instead.'
remarks: '\[ [API set: ExcelApi 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'formulasR1C1: any[][];'
return:
type: 'any[][]'
- name: index
uid: 'excel!Excel.RangeView#index:member'
package: excel!
fullName: index
summary: Returns a value that represents the index of the `RangeView`<!-- -->.
remarks: '\[ [API set: ExcelApi 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly index: number;'
return:
type: number
- name: numberFormat
uid: 'excel!Excel.RangeView#numberFormat:member'
package: excel!
fullName: numberFormat
summary: Represents Excel's number format code for the given cell.
remarks: '\[ [API set: ExcelApi 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'numberFormat: any[][];'
return:
type: 'any[][]'
- name: rowCount
uid: 'excel!Excel.RangeView#rowCount:member'
package: excel!
fullName: rowCount
summary: The number of visible rows.
remarks: '\[ [API set: ExcelApi 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly rowCount: number;'
return:
type: number
- name: rows
uid: 'excel!Excel.RangeView#rows:member'
package: excel!
fullName: rows
summary: Represents a collection of range views associated with the range.
remarks: '\[ [API set: ExcelApi 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly rows: Excel.RangeViewCollection;'
return:
type: '<xref uid="excel!Excel.RangeViewCollection:class" />'
- name: text
uid: 'excel!Excel.RangeView#text:member'
package: excel!
fullName: text
summary: >-
Text values of the specified range. The text value will not depend on the cell width. The \# sign substitution
that happens in Excel UI will not affect the text value returned by the API.
remarks: '\[ [API set: ExcelApi 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly text: string[][];'
return:
type: 'string[][]'
- name: values
uid: 'excel!Excel.RangeView#values:member'
package: excel!
fullName: values
summary: >-
Represents the raw values of the specified range view. The data returned could be of type string, number, or a
boolean. Cells that contain an error will return the error string.
remarks: '\[ [API set: ExcelApi 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'values: any[][];'
return:
type: 'any[][]'
- name: valueTypes
uid: 'excel!Excel.RangeView#valueTypes:member'
package: excel!
fullName: valueTypes
summary: Represents the type of data of each cell.
remarks: '\[ [API set: ExcelApi 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly valueTypes: Excel.RangeValueType[][];'
return:
type: '<xref uid="excel!Excel.RangeValueType:enum" />[][]'
methods:
- name: getRange()
uid: 'excel!Excel.RangeView#getRange:member(1)'
package: excel!
fullName: getRange()
summary: Gets the parent range associated with the current `RangeView`<!-- -->.
remarks: '\[ [API set: ExcelApi 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'getRange(): Excel.Range;'
return:
type: '<xref uid="excel!Excel.Range:class" />'
description: ''
- name: load(options)
uid: 'excel!Excel.RangeView#load:member(1)'
package: excel!
fullName: load(options)
summary: >-
Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading
the properties.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'load(options?: Excel.Interfaces.RangeViewLoadOptions): Excel.RangeView;'
parameters:
- id: options
description: Provides options for which properties of the object to load.
type: '<xref uid="excel!Excel.Interfaces.RangeViewLoadOptions:interface" />'
return:
type: '<xref uid="excel!Excel.RangeView:class" />'
description: ''
- name: load(propertyNames)
uid: 'excel!Excel.RangeView#load:member(2)'
package: excel!
fullName: load(propertyNames)
summary: >-
Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading
the properties.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'load(propertyNames?: string | string[]): Excel.RangeView;'
parameters:
- id: propertyNames
description: A comma-delimited string or an array of strings that specify the properties to load.
type: 'string | string[]'
return:
type: '<xref uid="excel!Excel.RangeView:class" />'
description: ''
- name: load(propertyNamesAndPaths)
uid: 'excel!Excel.RangeView#load:member(3)'
package: excel!
fullName: load(propertyNamesAndPaths)
summary: >-
Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading
the properties.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: |-
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.RangeView;
parameters:
- id: propertyNamesAndPaths
description: >-
`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.
type: |-
{
select?: string;
expand?: string;
}
return:
type: '<xref uid="excel!Excel.RangeView:class" />'
description: ''
- name: 'set(properties, options)'
uid: 'excel!Excel.RangeView#set:member(1)'
package: excel!
fullName: 'set(properties, options)'
summary: >-
Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate
properties, or another API object of the same type.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'set(properties: Interfaces.RangeViewUpdateData, options?: OfficeExtension.UpdateOptions): void;'
parameters:
- id: properties
description: >-
A JavaScript object with properties that are structured isomorphically to the properties of the object on
which the method is called.
type: '<xref uid="excel!Excel.Interfaces.RangeViewUpdateData:interface" />'
- id: options
description: Provides an option to suppress errors if the properties object tries to set any read-only properties.
type: '<xref uid="office!OfficeExtension.UpdateOptions:interface" />'
return:
type: void
description: ''
- name: set(properties)
uid: 'excel!Excel.RangeView#set:member(2)'
package: excel!
fullName: set(properties)
summary: 'Sets multiple properties on the object at the same time, based on an existing loaded object.'
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'set(properties: Excel.RangeView): void;'
parameters:
- id: properties
description: ''
type: '<xref uid="excel!Excel.RangeView:class" />'
return:
type: void
description: ''
- name: toJSON()
uid: 'excel!Excel.RangeView#toJSON:member(1)'
package: excel!
fullName: toJSON()
summary: >-
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.RangeView object is an API object, the `toJSON` method returns a plain
JavaScript object (typed as `Excel.Interfaces.RangeViewData`<!-- -->) that contains shallow copies of any loaded
child properties from the original object.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'toJSON(): Excel.Interfaces.RangeViewData;'
return:
type: '<xref uid="excel!Excel.Interfaces.RangeViewData:interface" />'
description: ''
extends: '<xref uid="office!OfficeExtension.ClientObject:class" />'