-
Notifications
You must be signed in to change notification settings - Fork 61
/
excel.worksheet.yml
507 lines (473 loc) · 18.1 KB
/
excel.worksheet.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
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
### YamlMime:TSType
name: Excel.Worksheet
uid: 'excel!Excel.Worksheet:class'
package: excel!
fullName: Excel.Worksheet
summary: >-
An Excel worksheet is a grid of cells. It can contain data, tables, charts, etc. To learn more about the worksheet
object model, read [Work with worksheets using the Excel JavaScript
API](https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-worksheets)<!-- -->.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: class
properties:
- name: charts
uid: 'excel!Excel.Worksheet#charts:member'
package: excel!
fullName: charts
summary: Returns a collection of charts that are part of the worksheet.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly charts: Excel.ChartCollection;'
return:
type: '<xref uid="excel!Excel.ChartCollection:class" />'
- name: context
uid: 'excel!Excel.Worksheet#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: id
uid: 'excel!Excel.Worksheet#id:member'
package: excel!
fullName: id
summary: >-
Returns a value that uniquely identifies the worksheet in a given workbook. The value of the identifier remains
the same even when the worksheet is renamed or moved.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly id: string;'
return:
type: string
- name: name
uid: 'excel!Excel.Worksheet#name:member'
package: excel!
fullName: name
summary: The display name of the worksheet. The name must be fewer than 32 characters.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'name: string;'
return:
type: string
- name: pivotTables
uid: 'excel!Excel.Worksheet#pivotTables:member'
package: excel!
fullName: pivotTables
summary: Collection of PivotTables that are part of the worksheet.
remarks: >-
\[ [API set: ExcelApi 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
#### Examples
```TypeScript
// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-get-pivottables.yaml
await Excel.run(async (context) => {
// Get the names of all the PivotTables in the current worksheet.
const pivotTables = context.workbook.worksheets.getActiveWorksheet().pivotTables;
pivotTables.load("name");
await context.sync();
// Display the names in the console.
console.log("PivotTables in the current worksheet:")
pivotTables.items.forEach((pivotTable) => {
console.log(`\t${pivotTable.name}`);
});
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'readonly pivotTables: Excel.PivotTableCollection;'
return:
type: '<xref uid="excel!Excel.PivotTableCollection:class" />'
- name: position
uid: 'excel!Excel.Worksheet#position:member'
package: excel!
fullName: position
summary: The zero-based position of the worksheet within the workbook.
remarks: |-
\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
#### Examples
```TypeScript
// Set worksheet position.
await Excel.run(async (context) => {
const wSheetName = 'Sheet1';
const worksheet = context.workbook.worksheets.getItem(wSheetName);
worksheet.position = 2;
await context.sync();
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'position: number;'
return:
type: number
- name: protection
uid: 'excel!Excel.Worksheet#protection:member'
package: excel!
fullName: protection
summary: Returns the sheet protection object for a worksheet.
remarks: |-
\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
#### Examples
```TypeScript
// Unprotecting a worksheet with unprotect() will remove all
// WorksheetProtectionOptions options applied to a worksheet.
// To remove only a subset of WorksheetProtectionOptions use the
// protect() method and set the options you wish to remove to true.
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sheet1");
sheet.protection.protect({
allowInsertRows: false, // Protect row insertion
allowDeleteRows: true // Unprotect row deletion
});
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'readonly protection: Excel.WorksheetProtection;'
return:
type: '<xref uid="excel!Excel.WorksheetProtection:class" />'
- name: tables
uid: 'excel!Excel.Worksheet#tables:member'
package: excel!
fullName: tables
summary: Collection of tables that are part of the worksheet.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly tables: Excel.TableCollection;'
return:
type: '<xref uid="excel!Excel.TableCollection:class" />'
- name: visibility
uid: 'excel!Excel.Worksheet#visibility:member'
package: excel!
fullName: visibility
summary: The visibility of the worksheet.
remarks: >-
\[ [API set: ExcelApi 1.1 for reading visibility; 1.2 for setting
it.](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
isPreview: false
isDeprecated: false
syntax:
content: 'visibility: Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden";'
return:
type: '<xref uid="excel!Excel.SheetVisibility:enum" /> | "Visible" | "Hidden" | "VeryHidden"'
methods:
- name: activate()
uid: 'excel!Excel.Worksheet#activate:member(1)'
package: excel!
fullName: activate()
summary: Activate the worksheet in the Excel UI.
remarks: |-
\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
#### Examples
```TypeScript
await Excel.run(async (context) => {
const wSheetName = 'Sheet1';
const worksheet = context.workbook.worksheets.getItem(wSheetName);
worksheet.activate();
await context.sync();
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'activate(): void;'
return:
type: void
description: ''
- name: delete()
uid: 'excel!Excel.Worksheet#delete:member(1)'
package: excel!
fullName: delete()
summary: >-
Deletes the worksheet from the workbook. Note that if the worksheet's visibility is set to "VeryHidden", the
delete operation will fail with an `InvalidOperation` exception. You should first change its visibility to hidden
or visible before deleting it.
remarks: |-
\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
#### Examples
```TypeScript
await Excel.run(async (context) => {
const wSheetName = 'Sheet1';
const worksheet = context.workbook.worksheets.getItem(wSheetName);
worksheet.delete();
await context.sync();
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'delete(): void;'
return:
type: void
description: ''
- name: 'getCell(row, column)'
uid: 'excel!Excel.Worksheet#getCell:member(1)'
package: excel!
fullName: 'getCell(row, column)'
summary: >-
Gets the `Range` object containing the single cell based on row and column numbers. The cell can be outside the
bounds of its parent range, so long as it stays within the worksheet grid.
remarks: |-
\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
#### Examples
```TypeScript
await Excel.run(async (context) => {
const sheetName = "Sheet1";
const rangeAddress = "A1:F8";
const worksheet = context.workbook.worksheets.getItem(sheetName);
const cell = worksheet.getCell(0,0);
cell.load('address');
await context.sync();
console.log(cell.address);
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'getCell(row: number, column: number): Excel.Range;'
parameters:
- id: row
description: The row number of the cell to be retrieved. Zero-indexed.
type: number
- id: column
description: The column number of the cell to be retrieved. Zero-indexed.
type: number
return:
type: '<xref uid="excel!Excel.Range:class" />'
description: ''
- name: getRange(address)
uid: 'excel!Excel.Worksheet#getRange:member(1)'
package: excel!
fullName: getRange(address)
summary: 'Gets the `Range` object, representing a single rectangular block of cells, specified by the address or name.'
remarks: |-
\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
#### Examples
```TypeScript
// Use the range address to get the range object.
await Excel.run(async (context) => {
const sheetName = "Sheet1";
const rangeAddress = "A1:F8";
const worksheet = context.workbook.worksheets.getItem(sheetName);
const range = worksheet.getRange(rangeAddress);
range.load('cellCount');
await context.sync();
console.log(range.cellCount);
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'getRange(address?: string): Excel.Range;'
parameters:
- id: address
description: >-
Optional. The string representing the address or name of the range. For example, "A1:B2". If not specified,
the entire worksheet range is returned.
type: string
return:
type: '<xref uid="excel!Excel.Range:class" />'
description: ''
- name: getUsedRange(valuesOnly)
uid: 'excel!Excel.Worksheet#getUsedRange:member(1)'
package: excel!
fullName: getUsedRange(valuesOnly)
summary: >-
The used range is the smallest range that encompasses any cells that have a value or formatting assigned to them.
If the entire worksheet is blank, this function will return the top left cell (i.e. it will *not* throw an
error).
remarks: |-
\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
#### Examples
```TypeScript
await Excel.run(async (context) => {
const wSheetName = 'Sheet1';
const worksheet = context.workbook.worksheets.getItem(wSheetName);
const usedRange = worksheet.getUsedRange();
usedRange.load('address');
await context.sync();
console.log(usedRange.address);
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'getUsedRange(valuesOnly?: boolean): Excel.Range;'
parameters:
- id: valuesOnly
description: >-
Optional. If `true`<!-- -->, considers only cells with values as used cells (ignoring formatting). \[Api
set: ExcelApi 1.2\]
type: boolean
return:
type: '<xref uid="excel!Excel.Range:class" />'
description: ''
- name: load(options)
uid: 'excel!Excel.Worksheet#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.WorksheetLoadOptions): Excel.Worksheet;'
parameters:
- id: options
description: Provides options for which properties of the object to load.
type: '<xref uid="excel!Excel.Interfaces.WorksheetLoadOptions:interface" />'
return:
type: '<xref uid="excel!Excel.Worksheet:class" />'
description: ''
- name: load(propertyNames)
uid: 'excel!Excel.Worksheet#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.Worksheet;'
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.Worksheet:class" />'
description: |-
#### Examples
```TypeScript
// Get worksheet properties based on sheet name.
await Excel.run(async (context) => {
const wSheetName = 'Sheet1';
const worksheet = context.workbook.worksheets.getItem(wSheetName);
worksheet.load('position')
await context.sync();
console.log(worksheet.position);
});
```
- name: load(propertyNamesAndPaths)
uid: 'excel!Excel.Worksheet#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.Worksheet;
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.Worksheet:class" />'
description: ''
- name: 'set(properties, options)'
uid: 'excel!Excel.Worksheet#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.WorksheetUpdateData, 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.WorksheetUpdateData: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: |-
#### Examples
```TypeScript
// Set the color and name of the current worksheet.
await Excel.run(async (context) => {
const activeSheet = context.workbook.worksheets.getActiveWorksheet();
activeSheet.set({
tabColor: "yellow",
name: "MySheet"
});
await context.sync();
});
```
- name: set(properties)
uid: 'excel!Excel.Worksheet#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.Worksheet): void;'
parameters:
- id: properties
description: ''
type: '<xref uid="excel!Excel.Worksheet:class" />'
return:
type: void
description: ''
- name: toJSON()
uid: 'excel!Excel.Worksheet#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.Worksheet object is an API object, the `toJSON` method returns a plain
JavaScript object (typed as `Excel.Interfaces.WorksheetData`<!-- -->) that contains shallow copies of any loaded
child properties from the original object.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'toJSON(): Excel.Interfaces.WorksheetData;'
return:
type: '<xref uid="excel!Excel.Interfaces.WorksheetData:interface" />'
description: ''
extends: '<xref uid="office!OfficeExtension.ClientObject:class" />'