-
Notifications
You must be signed in to change notification settings - Fork 62
/
excel.range.yml
3661 lines (3276 loc) · 145 KB
/
excel.range.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
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
### YamlMime:TSType
name: Excel.Range
uid: 'excel!Excel.Range:class'
package: excel!
fullName: Excel.Range
summary: >-
Range represents a set of one or more contiguous cells such as a cell, a row, a column, or a block of cells. To learn
more about how ranges are used throughout the API, start with [Ranges in the Excel JavaScript
API](https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-core-concepts#ranges)<!-- -->.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: class
properties:
- name: address
uid: 'excel!Excel.Range#address:member'
package: excel!
fullName: address
summary: 'Specifies the range reference in A1-style. Address value contains the sheet reference (e.g., "Sheet1!A1:B4").'
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly address: string;'
return:
type: string
- name: addressLocal
uid: 'excel!Excel.Range#addressLocal:member'
package: excel!
fullName: addressLocal
summary: Represents the range reference for the specified range in the language of the user.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly addressLocal: string;'
return:
type: string
- name: cellCount
uid: 'excel!Excel.Range#cellCount:member'
package: excel!
fullName: cellCount
summary: >-
Specifies the number of cells in the range. This API will return -1 if the cell count exceeds 2^31-1
(2,147,483,647).
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly cellCount: number;'
return:
type: number
- name: columnCount
uid: 'excel!Excel.Range#columnCount:member'
package: excel!
fullName: columnCount
summary: Specifies the total number of columns in the range.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly columnCount: number;'
return:
type: number
- name: columnHidden
uid: 'excel!Excel.Range#columnHidden:member'
package: excel!
fullName: columnHidden
summary: >-
Represents if all columns in the current range are hidden. Value is `true` when all columns in a range are hidden.
Value is `false` when no columns in the range are hidden. Value is `null` when some columns in a range are hidden
and other columns in the same range are not hidden.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'columnHidden: boolean;'
return:
type: boolean
- name: columnIndex
uid: 'excel!Excel.Range#columnIndex:member'
package: excel!
fullName: columnIndex
summary: Specifies the column number of the first cell in the range. Zero-indexed.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly columnIndex: number;'
return:
type: number
- name: conditionalFormats
uid: 'excel!Excel.Range#conditionalFormats:member'
package: excel!
fullName: conditionalFormats
summary: The collection of `ConditionalFormats` that intersect the range.
remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly conditionalFormats: Excel.ConditionalFormatCollection;'
return:
type: '<xref uid="excel!Excel.ConditionalFormatCollection:class" />'
- name: context
uid: 'excel!Excel.Range#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: control
uid: 'excel!Excel.Range#control:member'
package: excel!
fullName: control
summary: >-
Accesses the cell control applied to this range. If the range has multiple cell controls, this returns
`EmptyCellControl`<!-- -->.
remarks: '\[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: true
isDeprecated: false
syntax:
content: 'control: CellControl;'
return:
type: '<xref uid="excel!Excel.CellControl:type" />'
- name: dataValidation
uid: 'excel!Excel.Range#dataValidation:member'
package: excel!
fullName: dataValidation
summary: Returns a data validation object.
remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly dataValidation: Excel.DataValidation;'
return:
type: '<xref uid="excel!Excel.DataValidation:class" />'
- name: format
uid: 'excel!Excel.Range#format:member'
package: excel!
fullName: format
summary: 'Returns a format object, encapsulating the range''s font, fill, borders, alignment, and other properties.'
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly format: Excel.RangeFormat;'
return:
type: '<xref uid="excel!Excel.RangeFormat:class" />'
- name: formulas
uid: 'excel!Excel.Range#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.1](/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.Range#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.1](/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.Range#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.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'formulasR1C1: any[][];'
return:
type: 'any[][]'
- name: hasSpill
uid: 'excel!Excel.Range#hasSpill:member'
package: excel!
fullName: hasSpill
summary: >-
Represents if all cells have a spill border. Returns `true` if all cells have a spill border, or `false` if all
cells do not have a spill border. Returns `null` if there are cells both with and without spill borders within the
range.
remarks: '\[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly hasSpill: boolean;'
return:
type: boolean
- name: height
uid: 'excel!Excel.Range#height:member'
package: excel!
fullName: height
summary: 'Returns the distance in points, for 100% zoom, from the top edge of the range to the bottom edge of the range.'
remarks: '\[ [API set: ExcelApi 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly height: number;'
return:
type: number
- name: hidden
uid: 'excel!Excel.Range#hidden:member'
package: excel!
fullName: hidden
summary: >-
Represents if all cells in the current range are hidden. Value is `true` when all cells in a range are hidden.
Value is `false` when no cells in the range are hidden. Value is `null` when some cells in a range are hidden and
other cells in the same range are not hidden.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly hidden: boolean;'
return:
type: boolean
- name: hyperlink
uid: 'excel!Excel.Range#hyperlink:member'
package: excel!
fullName: hyperlink
summary: Represents the hyperlink for the current range.
remarks: >-
\[ [API set: ExcelApi 1.7](/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/42-range/range-hyperlink.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Orders");
let productsRange = sheet.getRange("A3:A5");
productsRange.load("values");
await context.sync();
// Create a hyperlink to a URL
// for each product name in the first table.
for (let i = 0; i < productsRange.values.length; i++) {
let cellRange = productsRange.getCell(i, 0);
let cellText = productsRange.values[i][0];
let hyperlink = {
textToDisplay: cellText,
screenTip: "Search Bing for '" + cellText + "'",
address: "https://www.bing.com?q=" + cellText
}
cellRange.hyperlink = hyperlink;
}
await context.sync();
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'hyperlink: Excel.RangeHyperlink;'
return:
type: '<xref uid="excel!Excel.RangeHyperlink:interface" />'
- name: isEntireColumn
uid: 'excel!Excel.Range#isEntireColumn:member'
package: excel!
fullName: isEntireColumn
summary: Represents if the current range is an entire column.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly isEntireColumn: boolean;'
return:
type: boolean
- name: isEntireRow
uid: 'excel!Excel.Range#isEntireRow:member'
package: excel!
fullName: isEntireRow
summary: Represents if the current range is an entire row.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly isEntireRow: boolean;'
return:
type: boolean
- name: left
uid: 'excel!Excel.Range#left:member'
package: excel!
fullName: left
summary: 'Returns the distance in points, for 100% zoom, from the left edge of the worksheet to the left edge of the range.'
remarks: '\[ [API set: ExcelApi 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly left: number;'
return:
type: number
- name: linkedDataTypeState
uid: 'excel!Excel.Range#linkedDataTypeState:member'
package: excel!
fullName: linkedDataTypeState
summary: Represents the data type state of each cell.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly linkedDataTypeState: Excel.LinkedDataTypeState[][];'
return:
type: '<xref uid="excel!Excel.LinkedDataTypeState:enum" />[][]'
- name: numberFormat
uid: 'excel!Excel.Range#numberFormat:member'
package: excel!
fullName: numberFormat
summary: >-
Represents Excel's number format code for the given range. For more information about Excel number formatting, see
[Number format
codes](https://support.microsoft.com/office/number-format-codes-5026bbd6-04bc-48cd-bf33-80f18b4eae68)<!-- -->.
remarks: |-
\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
#### Examples
```TypeScript
// Set the text of the chart title to "My Chart" and display it as an overlay on the chart.
await Excel.run(async (context) => {
const sheetName = "Sheet1";
const rangeAddress = "F5:G7";
const numberFormat = [[null, "d-mmm"], [null, "d-mmm"], [null, null]]
const values = [["Today", 42147], ["Tomorrow", "5/24"], ["Difference in days", null]];
const formulas = [[null,null], [null,null], [null,"=G6-G5"]];
const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
range.numberFormat = numberFormat;
range.values = values;
range.formulas= formulas;
range.load('text');
await context.sync();
console.log(range.text);
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'numberFormat: any[][];'
return:
type: 'any[][]'
- name: numberFormatCategories
uid: 'excel!Excel.Range#numberFormatCategories:member'
package: excel!
fullName: numberFormatCategories
summary: Represents the category of number format of each cell.
remarks: '\[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly numberFormatCategories: Excel.NumberFormatCategory[][];'
return:
type: '<xref uid="excel!Excel.NumberFormatCategory:enum" />[][]'
- name: numberFormatLocal
uid: 'excel!Excel.Range#numberFormatLocal:member'
package: excel!
fullName: numberFormatLocal
summary: >-
Represents Excel's number format code for the given range, based on the language settings of the user. Excel does
not perform any language or format coercion when getting or setting the `numberFormatLocal` property. Any returned
text uses the locally-formatted strings based on the language specified in the system settings.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'numberFormatLocal: any[][];'
return:
type: 'any[][]'
- name: rowCount
uid: 'excel!Excel.Range#rowCount:member'
package: excel!
fullName: rowCount
summary: Returns the total number of rows in the range.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly rowCount: number;'
return:
type: number
- name: rowHidden
uid: 'excel!Excel.Range#rowHidden:member'
package: excel!
fullName: rowHidden
summary: >-
Represents if all rows in the current range are hidden. Value is `true` when all rows in a range are hidden. Value
is `false` when no rows in the range are hidden. Value is `null` when some rows in a range are hidden and other
rows in the same range are not hidden.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'rowHidden: boolean;'
return:
type: boolean
- name: rowIndex
uid: 'excel!Excel.Range#rowIndex:member'
package: excel!
fullName: rowIndex
summary: Returns the row number of the first cell in the range. Zero-indexed.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly rowIndex: number;'
return:
type: number
- name: savedAsArray
uid: 'excel!Excel.Range#savedAsArray:member'
package: excel!
fullName: savedAsArray
summary: >-
Represents if all the cells would be saved as an array formula. Returns `true` if all cells would be saved as an
array formula, or `false` if all cells would not be saved as an array formula. Returns `null` if some cells would
be saved as an array formula and some would not be.
remarks: '\[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly savedAsArray: boolean;'
return:
type: boolean
- name: sort
uid: 'excel!Excel.Range#sort:member'
package: excel!
fullName: sort
summary: Represents the range sort of the current range.
remarks: >-
\[ [API set: ExcelApi 1.2](/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/30-events/event-column-and-row-sort.yaml
async function sortTopToBottom(criteria: string) {
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getActiveWorksheet();
const range = sheet.getRange("A1:E5");
// Find the column header that provides the sort criteria.
const header = range.find(criteria, {});
header.load("columnIndex");
await context.sync();
range.sort.apply(
[
{
key: header.columnIndex,
sortOn: Excel.SortOn.value
}
],
false /*matchCase*/,
true /*hasHeaders*/,
Excel.SortOrientation.rows
);
await context.sync();
});
}
```
isPreview: false
isDeprecated: false
syntax:
content: 'readonly sort: Excel.RangeSort;'
return:
type: '<xref uid="excel!Excel.RangeSort:class" />'
- name: style
uid: 'excel!Excel.Range#style:member'
package: excel!
fullName: style
summary: >-
Represents the style of the current range. If the styles of the cells are inconsistent, `null` will be returned.
For custom styles, the style name will be returned. For built-in styles, a string representing a value in the
`BuiltInStyle` enum will be returned.
remarks: >-
\[ [API set: ExcelApi 1.7](/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/42-range/style.yaml
await Excel.run(async (context) => {
let worksheet = context.workbook.worksheets.getItem("Sample");
let range = worksheet.getRange("A1:E1");
// Apply built-in style.
// Styles are in the Home tab ribbon.
range.style = Excel.BuiltInStyle.neutral;
range.format.horizontalAlignment = "Right";
await context.sync();
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'style: string;'
return:
type: string
- name: text
uid: 'excel!Excel.Range#text:member'
package: excel!
fullName: text
summary: >-
Text values of the specified range. The text value will not depend on the cell width. The number sign (\#)
substitution that happens in the Excel UI will not affect the text value returned by the API.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly text: string[][];'
return:
type: 'string[][]'
- name: top
uid: 'excel!Excel.Range#top:member'
package: excel!
fullName: top
summary: 'Returns the distance in points, for 100% zoom, from the top edge of the worksheet to the top edge of the range.'
remarks: '\[ [API set: ExcelApi 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly top: number;'
return:
type: number
- name: values
uid: 'excel!Excel.Range#values:member'
package: excel!
fullName: values
summary: >-
Represents the raw values of the specified range. The data returned could be a string, number, or boolean. Cells
that contain an error will return the error string. If the returned value starts with a plus ("+"), minus ("-"),
or equal sign ("="), Excel interprets this value as a formula.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'values: any[][];'
return:
type: 'any[][]'
- name: valuesAsJson
uid: 'excel!Excel.Range#valuesAsJson:member'
package: excel!
fullName: valuesAsJson
summary: >-
A JSON representation of the values in the cells in this range. Unlike `Range.values`<!-- -->,
`Range.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 `Range.valuesAsJsonLocal`<!--
-->.
remarks: >-
\[ [API set: ExcelApi 1.16](/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/20-data-types/data-types-formatted-number.yaml
// This function creates a formatted number data type,
// and sets the format of this data type as a date.
await Excel.run(async (context) => {
// Get the Sample worksheet and a range on that sheet.
const sheet = context.workbook.worksheets.getItemOrNullObject("Sample");
const dateRange = sheet.getRange("A1");
// Write a number formatted as a date to cell A1.
dateRange.valuesAsJson = [
[
{
type: Excel.CellValueType.formattedNumber,
basicValue: 32889.0,
numberFormat: "m/d/yyyy"
}
]
];
await context.sync();
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'valuesAsJson: CellValue[][];'
return:
type: '<xref uid="excel!Excel.CellValue:type" />[][]'
- name: valuesAsJsonLocal
uid: 'excel!Excel.Range#valuesAsJsonLocal:member'
package: excel!
fullName: valuesAsJsonLocal
summary: >-
A JSON representation of the values in the cells in this range. Unlike `Range.values`<!-- -->,
`Range.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 `Range.valuesAsJson`<!-- -->.
remarks: '\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'valuesAsJsonLocal: CellValue[][];'
return:
type: '<xref uid="excel!Excel.CellValue:type" />[][]'
- name: valueTypes
uid: 'excel!Excel.Range#valueTypes:member'
package: excel!
fullName: valueTypes
summary: Specifies the type of data in each cell.
remarks: '\[ [API set: ExcelApi 1.1](/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" />[][]'
- name: width
uid: 'excel!Excel.Range#width:member'
package: excel!
fullName: width
summary: 'Returns the distance in points, for 100% zoom, from the left edge of the range to the right edge of the range.'
remarks: '\[ [API set: ExcelApi 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly width: number;'
return:
type: number
- name: worksheet
uid: 'excel!Excel.Range#worksheet:member'
package: excel!
fullName: worksheet
summary: The worksheet containing the current range.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly worksheet: Excel.Worksheet;'
return:
type: '<xref uid="excel!Excel.Worksheet:class" />'
methods:
- name: 'autoFill(destinationRange, autoFillType)'
uid: 'excel!Excel.Range#autoFill:member(1)'
package: excel!
fullName: 'autoFill(destinationRange, autoFillType)'
summary: >-
Fills a range from the current range to the destination range using the specified AutoFill logic. The destination
range can be `null` or can extend the source range either horizontally or vertically. Discontiguous ranges are not
supported.
For more information, see [Use AutoFill and Flash
Fill](https://support.microsoft.com/office/2e79a709-c814-4b27-8bc2-c4dc84d49464)<!-- -->.
remarks: >-
\[ [API set: ExcelApi 1.9, ExcelApi Preview for null `destinationRange`<!--
-->](/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/42-range/range-auto-fill.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getActiveWorksheet();
const sumCell = sheet.getRange("P4");
// Copy everything. The formulas will be contextually updated based on their new locations.
sumCell.autoFill("P4:P7", Excel.AutoFillType.fillCopy);
sumCell.format.autofitColumns();
await context.sync();
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'autoFill(destinationRange?: Range | string, autoFillType?: Excel.AutoFillType): void;'
parameters:
- id: destinationRange
description: >-
The destination range to AutoFill. If the destination range is `null`<!-- -->, data is filled out based on
the surrounding cells (which is the behavior when double-clicking the UI's range fill handle).
type: '<xref uid="excel!Excel.Range:class" /> | string'
- id: autoFillType
description: >-
The type of AutoFill. Specifies how the destination range is to be filled, based on the contents of the
current range. Default is "FillDefault".
type: '<xref uid="excel!Excel.AutoFillType:enum" />'
return:
type: void
description: ''
- name: 'autoFill(destinationRange, autoFillTypeString)'
uid: 'excel!Excel.Range#autoFill:member(2)'
package: excel!
fullName: 'autoFill(destinationRange, autoFillTypeString)'
summary: >-
Fills a range from the current range to the destination range using the specified AutoFill logic. The destination
range can be `null` or can extend the source range either horizontally or vertically. Discontiguous ranges are not
supported.
For more information, see [Use AutoFill and Flash
Fill](https://support.microsoft.com/office/2e79a709-c814-4b27-8bc2-c4dc84d49464)<!-- -->.
remarks: >-
\[ [API set: ExcelApi 1.9, ExcelApi Preview for null `destinationRange`<!--
-->](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
isPreview: false
isDeprecated: false
syntax:
content: >-
autoFill(destinationRange?: Range | string, autoFillTypeString?: "FillDefault" | "FillCopy" | "FillSeries" |
"FillFormats" | "FillValues" | "FillDays" | "FillWeekdays" | "FillMonths" | "FillYears" | "LinearTrend" |
"GrowthTrend" | "FlashFill"): void;
parameters:
- id: destinationRange
description: >-
The destination range to AutoFill. If the destination range is `null`<!-- -->, data is filled out based on
the surrounding cells (which is the behavior when double-clicking the UI's range fill handle).
type: '<xref uid="excel!Excel.Range:class" /> | string'
- id: autoFillTypeString
description: >-
The type of AutoFill. Specifies how the destination range is to be filled, based on the contents of the
current range. Default is "FillDefault".
type: >-
"FillDefault" | "FillCopy" | "FillSeries" | "FillFormats" | "FillValues" | "FillDays" | "FillWeekdays" |
"FillMonths" | "FillYears" | "LinearTrend" | "GrowthTrend" | "FlashFill"
return:
type: void
description: ''
- name: calculate()
uid: 'excel!Excel.Range#calculate:member(1)'
package: excel!
fullName: calculate()
summary: Calculates a range of cells on a worksheet.
remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'calculate(): void;'
return:
type: void
description: ''
- name: clear(applyTo)
uid: 'excel!Excel.Range#clear:member(1)'
package: excel!
fullName: clear(applyTo)
summary: 'Clear range values, format, fill, border, etc.'
remarks: |-
\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
#### Examples
```TypeScript
// Clear the format and contents of the range.
await Excel.run(async (context) => {
const sheetName = "Sheet1";
const rangeAddress = "D:F";
const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
range.clear();
await context.sync();
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'clear(applyTo?: Excel.ClearApplyTo): void;'
parameters:
- id: applyTo
description: Optional. Determines the type of clear action. See `Excel.ClearApplyTo` for details.
type: '<xref uid="excel!Excel.ClearApplyTo:enum" />'
return:
type: void
description: ''
- name: clear(applyToString)
uid: 'excel!Excel.Range#clear:member(2)'
package: excel!
fullName: clear(applyToString)
summary: 'Clear range values, format, fill, border, etc.'
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'clear(applyToString?: "All" | "Formats" | "Contents" | "Hyperlinks" | "RemoveHyperlinks"): void;'
parameters:
- id: applyToString
description: Optional. Determines the type of clear action. See `Excel.ClearApplyTo` for details.
type: '"All" | "Formats" | "Contents" | "Hyperlinks" | "RemoveHyperlinks"'
return:
type: void
description: ''
- name: convertDataTypeToText()
uid: 'excel!Excel.Range#convertDataTypeToText:member(1)'
package: excel!
fullName: convertDataTypeToText()
summary: Converts the range cells with data types into text.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'convertDataTypeToText(): void;'
return:
type: void
description: ''
- name: 'convertToLinkedDataType(serviceID, languageCulture)'
uid: 'excel!Excel.Range#convertToLinkedDataType:member(1)'
package: excel!
fullName: 'convertToLinkedDataType(serviceID, languageCulture)'
summary: Converts the range cells into linked data types in the worksheet.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'convertToLinkedDataType(serviceID: number, languageCulture: string): void;'
parameters:
- id: serviceID
description: The service ID which will be used to query the data.
type: number
- id: languageCulture
description: Language culture to query the service for.
type: string
return:
type: void
description: ''
- name: 'copyFrom(sourceRange, copyType, skipBlanks, transpose)'
uid: 'excel!Excel.Range#copyFrom:member(1)'
package: excel!
fullName: 'copyFrom(sourceRange, copyType, skipBlanks, transpose)'
summary: >-
Copies cell data or formatting from the source range or `RangeAreas` to the current range. The destination range
can be a different size than the source range or `RangeAreas`<!-- -->. The destination is expanded automatically
if it's smaller than the source. Note: Like the copy functionality in the Excel UI, if the destination range is an
exact multiple greater than the source range in either rows or columns, then the source content is replicated
multiple times. For example, a 2x2 range copy into a 2x6 range will result in 3 copies of the original 2x2 range.
remarks: >-
\[ [API set: ExcelApi 1.9](/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/42-range/range-copyfrom.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
// Place a label in front of the copied data.
sheet.getRange("F2").values = [["Copied Formula"]];
// Copy a range preserving the formulas.
// Note: non-formula values are copied over as is.
sheet.getRange("G2").copyFrom("A1:E1", Excel.RangeCopyType.formulas);
await context.sync();
});
```
isPreview: false
isDeprecated: false
syntax:
content: >-
copyFrom(sourceRange: Range | RangeAreas | string, copyType?: Excel.RangeCopyType, skipBlanks?: boolean,
transpose?: boolean): void;
parameters:
- id: sourceRange
description: >-
The source range or `RangeAreas` to copy from. When the source `RangeAreas` has multiple ranges, their form
must be able to be created by removing full rows or columns from a rectangular range.
type: '<xref uid="excel!Excel.Range:class" /> | <xref uid="excel!Excel.RangeAreas:class" /> | string'
- id: copyType
description: The type of cell data or formatting to copy over. Default is "All".
type: '<xref uid="excel!Excel.RangeCopyType:enum" />'
- id: skipBlanks
description: True if to skip blank cells in the source range. Default is false.
type: boolean
- id: transpose
description: True if to transpose the cells in the destination range. Default is false.
type: boolean
return:
type: void
description: ''
- name: 'copyFrom(sourceRange, copyTypeString, skipBlanks, transpose)'
uid: 'excel!Excel.Range#copyFrom:member(2)'
package: excel!
fullName: 'copyFrom(sourceRange, copyTypeString, skipBlanks, transpose)'
summary: >-
Copies cell data or formatting from the source range or `RangeAreas` to the current range. The destination range
can be a different size than the source range or `RangeAreas`<!-- -->. The destination is expanded automatically
if it's smaller than the source. Note: Like the copy functionality in the Excel UI, if the destination range is an
exact multiple greater than the source range in either rows or columns, then the source content is replicated
multiple times. For example, a 2x2 range copy into a 2x6 range will result in 3 copies of the original 2x2 range.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: >-
copyFrom(sourceRange: Range | RangeAreas | string, copyTypeString?: "All" | "Formulas" | "Values" | "Formats" |
"Link" | "ColumnWidths", skipBlanks?: boolean, transpose?: boolean): void;
parameters:
- id: sourceRange
description: >-
The source range or `RangeAreas` to copy from. When the source `RangeAreas` has multiple ranges, their form
must be able to be created by removing full rows or columns from a rectangular range.
type: '<xref uid="excel!Excel.Range:class" /> | <xref uid="excel!Excel.RangeAreas:class" /> | string'
- id: copyTypeString
description: The type of cell data or formatting to copy over. Default is "All".
type: '"All" | "Formulas" | "Values" | "Formats" | "Link" | "ColumnWidths"'
- id: skipBlanks
description: True if to skip blank cells in the source range. Default is false.
type: boolean
- id: transpose
description: True if to transpose the cells in the destination range. Default is false.
type: boolean
return:
type: void
description: ''
- name: delete(shift)
uid: 'excel!Excel.Range#delete:member(1)'
package: excel!
fullName: delete(shift)
summary: Deletes the cells associated with the range.
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 = "D:F";
const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
range.delete("Left");
await context.sync();
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'delete(shift: Excel.DeleteShiftDirection): void;'
parameters:
- id: shift
description: Specifies which way to shift the cells. See `Excel.DeleteShiftDirection` for details.
type: '<xref uid="excel!Excel.DeleteShiftDirection:enum" />'
return:
type: void
description: ''
- name: delete(shiftString)