-
Notifications
You must be signed in to change notification settings - Fork 62
/
excel.functions.yml
10618 lines (10588 loc) · 563 KB
/
excel.functions.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.Functions
uid: 'excel!Excel.Functions:class'
package: excel!
fullName: Excel.Functions
summary: An object for evaluating Excel functions.
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/50-workbook/workbook-built-in-functions.yaml
await Excel.run(async (context) => {
// This function uses VLOOKUP to find data in the "Wrench" row on the worksheet.
let range = context.workbook.worksheets.getItem("Sample").getRange("A1:D4");
// Get the value in the second column in the "Wrench" row.
let unitSoldInNov = context.workbook.functions.vlookup("Wrench", range, 2, false);
unitSoldInNov.load("value");
await context.sync();
console.log(" Number of wrenches sold in November = " + unitSoldInNov.value);
});
```
isPreview: false
isDeprecated: false
type: class
properties:
- name: context
uid: 'excel!Excel.Functions#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" />'
methods:
- name: abs(number)
uid: 'excel!Excel.Functions#abs:member(1)'
package: excel!
fullName: abs(number)
summary: 'Returns the absolute value of a number, a number without its sign.'
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'abs(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;'
parameters:
- id: number
description: Is the real number for which you want the absolute value.
type: >-
number | <xref uid="excel!Excel.Range:class" /> | <xref uid="excel!Excel.RangeReference:interface" /> |
<xref uid="excel!Excel.FunctionResult:class" /><any>
return:
type: '<xref uid="excel!Excel.FunctionResult:class" /><number>'
description: ''
- name: 'accrInt(issue, firstInterest, settlement, rate, par, frequency, basis, calcMethod)'
uid: 'excel!Excel.Functions#accrInt:member(1)'
package: excel!
fullName: 'accrInt(issue, firstInterest, settlement, rate, par, frequency, basis, calcMethod)'
summary: Returns the accrued interest for a security that pays periodic interest.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: >-
accrInt(issue: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>,
firstInterest: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>,
settlement: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, rate:
number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, par: number | string
| boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, frequency: number | string | boolean
| Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, basis?: number | string | boolean |
Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, calcMethod?: number | string | boolean |
Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;
parameters:
- id: issue
description: 'Is the security''s issue date, expressed as a serial date number.'
type: >-
number | string | boolean | <xref uid="excel!Excel.Range:class" /> | <xref
uid="excel!Excel.RangeReference:interface" /> | <xref uid="excel!Excel.FunctionResult:class" /><any>
- id: firstInterest
description: 'Is the security''s first interest date, expressed as a serial date number.'
type: >-
number | string | boolean | <xref uid="excel!Excel.Range:class" /> | <xref
uid="excel!Excel.RangeReference:interface" /> | <xref uid="excel!Excel.FunctionResult:class" /><any>
- id: settlement
description: 'Is the security''s settlement date, expressed as a serial date number.'
type: >-
number | string | boolean | <xref uid="excel!Excel.Range:class" /> | <xref
uid="excel!Excel.RangeReference:interface" /> | <xref uid="excel!Excel.FunctionResult:class" /><any>
- id: rate
description: Is the security's annual coupon rate.
type: >-
number | string | boolean | <xref uid="excel!Excel.Range:class" /> | <xref
uid="excel!Excel.RangeReference:interface" /> | <xref uid="excel!Excel.FunctionResult:class" /><any>
- id: par
description: Is the security's par value.
type: >-
number | string | boolean | <xref uid="excel!Excel.Range:class" /> | <xref
uid="excel!Excel.RangeReference:interface" /> | <xref uid="excel!Excel.FunctionResult:class" /><any>
- id: frequency
description: Is the number of coupon payments per year.
type: >-
number | string | boolean | <xref uid="excel!Excel.Range:class" /> | <xref
uid="excel!Excel.RangeReference:interface" /> | <xref uid="excel!Excel.FunctionResult:class" /><any>
- id: basis
description: Is the type of day count basis to use.
type: >-
number | string | boolean | <xref uid="excel!Excel.Range:class" /> | <xref
uid="excel!Excel.RangeReference:interface" /> | <xref uid="excel!Excel.FunctionResult:class" /><any>
- id: calcMethod
description: >-
Is a logical value: to accrued interest from issue date = TRUE or omitted; to calculate from last coupon
payment date = FALSE.
type: >-
number | string | boolean | <xref uid="excel!Excel.Range:class" /> | <xref
uid="excel!Excel.RangeReference:interface" /> | <xref uid="excel!Excel.FunctionResult:class" /><any>
return:
type: '<xref uid="excel!Excel.FunctionResult:class" /><number>'
description: ''
- name: 'accrIntM(issue, settlement, rate, par, basis)'
uid: 'excel!Excel.Functions#accrIntM:member(1)'
package: excel!
fullName: 'accrIntM(issue, settlement, rate, par, basis)'
summary: Returns the accrued interest for a security that pays interest at maturity.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: >-
accrIntM(issue: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>,
settlement: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, rate:
number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, par: number | string
| boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, basis?: number | string | boolean |
Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;
parameters:
- id: issue
description: 'Is the security''s issue date, expressed as a serial date number.'
type: >-
number | string | boolean | <xref uid="excel!Excel.Range:class" /> | <xref
uid="excel!Excel.RangeReference:interface" /> | <xref uid="excel!Excel.FunctionResult:class" /><any>
- id: settlement
description: 'Is the security''s maturity date, expressed as a serial date number.'
type: >-
number | string | boolean | <xref uid="excel!Excel.Range:class" /> | <xref
uid="excel!Excel.RangeReference:interface" /> | <xref uid="excel!Excel.FunctionResult:class" /><any>
- id: rate
description: Is the security's annual coupon rate.
type: >-
number | string | boolean | <xref uid="excel!Excel.Range:class" /> | <xref
uid="excel!Excel.RangeReference:interface" /> | <xref uid="excel!Excel.FunctionResult:class" /><any>
- id: par
description: Is the security's par value.
type: >-
number | string | boolean | <xref uid="excel!Excel.Range:class" /> | <xref
uid="excel!Excel.RangeReference:interface" /> | <xref uid="excel!Excel.FunctionResult:class" /><any>
- id: basis
description: Is the type of day count basis to use.
type: >-
number | string | boolean | <xref uid="excel!Excel.Range:class" /> | <xref
uid="excel!Excel.RangeReference:interface" /> | <xref uid="excel!Excel.FunctionResult:class" /><any>
return:
type: '<xref uid="excel!Excel.FunctionResult:class" /><number>'
description: ''
- name: acos(number)
uid: 'excel!Excel.Functions#acos:member(1)'
package: excel!
fullName: acos(number)
summary: >-
Returns the arccosine of a number, in radians in the range 0 to Pi. The arccosine is the angle whose cosine is
Number.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'acos(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;'
parameters:
- id: number
description: Is the cosine of the angle you want and must be from -1 to 1.
type: >-
number | <xref uid="excel!Excel.Range:class" /> | <xref uid="excel!Excel.RangeReference:interface" /> |
<xref uid="excel!Excel.FunctionResult:class" /><any>
return:
type: '<xref uid="excel!Excel.FunctionResult:class" /><number>'
description: ''
- name: acosh(number)
uid: 'excel!Excel.Functions#acosh:member(1)'
package: excel!
fullName: acosh(number)
summary: Returns the inverse hyperbolic cosine of a number.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'acosh(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;'
parameters:
- id: number
description: Is any real number equal to or greater than 1.
type: >-
number | <xref uid="excel!Excel.Range:class" /> | <xref uid="excel!Excel.RangeReference:interface" /> |
<xref uid="excel!Excel.FunctionResult:class" /><any>
return:
type: '<xref uid="excel!Excel.FunctionResult:class" /><number>'
description: ''
- name: acot(number)
uid: 'excel!Excel.Functions#acot:member(1)'
package: excel!
fullName: acot(number)
summary: 'Returns the arccotangent of a number, in radians in the range 0 to Pi.'
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'acot(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;'
parameters:
- id: number
description: Is the cotangent of the angle you want.
type: >-
number | <xref uid="excel!Excel.Range:class" /> | <xref uid="excel!Excel.RangeReference:interface" /> |
<xref uid="excel!Excel.FunctionResult:class" /><any>
return:
type: '<xref uid="excel!Excel.FunctionResult:class" /><number>'
description: ''
- name: acoth(number)
uid: 'excel!Excel.Functions#acoth:member(1)'
package: excel!
fullName: acoth(number)
summary: Returns the inverse hyperbolic cotangent of a number.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'acoth(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;'
parameters:
- id: number
description: Is the hyperbolic cotangent of the angle that you want.
type: >-
number | <xref uid="excel!Excel.Range:class" /> | <xref uid="excel!Excel.RangeReference:interface" /> |
<xref uid="excel!Excel.FunctionResult:class" /><any>
return:
type: '<xref uid="excel!Excel.FunctionResult:class" /><number>'
description: ''
- name: 'amorDegrc(cost, datePurchased, firstPeriod, salvage, period, rate, basis)'
uid: 'excel!Excel.Functions#amorDegrc:member(1)'
package: excel!
fullName: 'amorDegrc(cost, datePurchased, firstPeriod, salvage, period, rate, basis)'
summary: Returns the prorated linear depreciation of an asset for each accounting period.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: >-
amorDegrc(cost: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>,
datePurchased: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>,
firstPeriod: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>,
salvage: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, period:
number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, rate: number |
string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, basis?: number | string |
boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;
parameters:
- id: cost
description: Is the cost of the asset.
type: >-
number | string | boolean | <xref uid="excel!Excel.Range:class" /> | <xref
uid="excel!Excel.RangeReference:interface" /> | <xref uid="excel!Excel.FunctionResult:class" /><any>
- id: datePurchased
description: Is the date the asset is purchased.
type: >-
number | string | boolean | <xref uid="excel!Excel.Range:class" /> | <xref
uid="excel!Excel.RangeReference:interface" /> | <xref uid="excel!Excel.FunctionResult:class" /><any>
- id: firstPeriod
description: Is the date of the end of the first period.
type: >-
number | string | boolean | <xref uid="excel!Excel.Range:class" /> | <xref
uid="excel!Excel.RangeReference:interface" /> | <xref uid="excel!Excel.FunctionResult:class" /><any>
- id: salvage
description: Is the salvage value at the end of life of the asset.
type: >-
number | string | boolean | <xref uid="excel!Excel.Range:class" /> | <xref
uid="excel!Excel.RangeReference:interface" /> | <xref uid="excel!Excel.FunctionResult:class" /><any>
- id: period
description: Is the period.
type: >-
number | string | boolean | <xref uid="excel!Excel.Range:class" /> | <xref
uid="excel!Excel.RangeReference:interface" /> | <xref uid="excel!Excel.FunctionResult:class" /><any>
- id: rate
description: Is the rate of depreciation.
type: >-
number | string | boolean | <xref uid="excel!Excel.Range:class" /> | <xref
uid="excel!Excel.RangeReference:interface" /> | <xref uid="excel!Excel.FunctionResult:class" /><any>
- id: basis
description: 'Year\_basis : 0 for year of 360 days, 1 for actual, 3 for year of 365 days.'
type: >-
number | string | boolean | <xref uid="excel!Excel.Range:class" /> | <xref
uid="excel!Excel.RangeReference:interface" /> | <xref uid="excel!Excel.FunctionResult:class" /><any>
return:
type: '<xref uid="excel!Excel.FunctionResult:class" /><number>'
description: ''
- name: 'amorLinc(cost, datePurchased, firstPeriod, salvage, period, rate, basis)'
uid: 'excel!Excel.Functions#amorLinc:member(1)'
package: excel!
fullName: 'amorLinc(cost, datePurchased, firstPeriod, salvage, period, rate, basis)'
summary: Returns the prorated linear depreciation of an asset for each accounting period.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: >-
amorLinc(cost: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>,
datePurchased: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>,
firstPeriod: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>,
salvage: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, period:
number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, rate: number |
string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, basis?: number | string |
boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;
parameters:
- id: cost
description: Is the cost of the asset.
type: >-
number | string | boolean | <xref uid="excel!Excel.Range:class" /> | <xref
uid="excel!Excel.RangeReference:interface" /> | <xref uid="excel!Excel.FunctionResult:class" /><any>
- id: datePurchased
description: Is the date the asset is purchased.
type: >-
number | string | boolean | <xref uid="excel!Excel.Range:class" /> | <xref
uid="excel!Excel.RangeReference:interface" /> | <xref uid="excel!Excel.FunctionResult:class" /><any>
- id: firstPeriod
description: Is the date of the end of the first period.
type: >-
number | string | boolean | <xref uid="excel!Excel.Range:class" /> | <xref
uid="excel!Excel.RangeReference:interface" /> | <xref uid="excel!Excel.FunctionResult:class" /><any>
- id: salvage
description: Is the salvage value at the end of life of the asset.
type: >-
number | string | boolean | <xref uid="excel!Excel.Range:class" /> | <xref
uid="excel!Excel.RangeReference:interface" /> | <xref uid="excel!Excel.FunctionResult:class" /><any>
- id: period
description: Is the period.
type: >-
number | string | boolean | <xref uid="excel!Excel.Range:class" /> | <xref
uid="excel!Excel.RangeReference:interface" /> | <xref uid="excel!Excel.FunctionResult:class" /><any>
- id: rate
description: Is the rate of depreciation.
type: >-
number | string | boolean | <xref uid="excel!Excel.Range:class" /> | <xref
uid="excel!Excel.RangeReference:interface" /> | <xref uid="excel!Excel.FunctionResult:class" /><any>
- id: basis
description: 'Year\_basis : 0 for year of 360 days, 1 for actual, 3 for year of 365 days.'
type: >-
number | string | boolean | <xref uid="excel!Excel.Range:class" /> | <xref
uid="excel!Excel.RangeReference:interface" /> | <xref uid="excel!Excel.FunctionResult:class" /><any>
return:
type: '<xref uid="excel!Excel.FunctionResult:class" /><number>'
description: ''
- name: and(values)
uid: 'excel!Excel.Functions#and:member(1)'
package: excel!
fullName: and(values)
summary: 'Checks whether all arguments are TRUE, and returns TRUE if all arguments are TRUE.'
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: >-
and(...values: Array<boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>):
FunctionResult<boolean>;
parameters:
- id: values
description: >-
List of parameters, whose elements are 1 to 255 conditions you want to test that can be either TRUE or FALSE
and can be logical values, arrays, or references.
type: >-
Array<boolean | <xref uid="excel!Excel.Range:class" /> | <xref uid="excel!Excel.RangeReference:interface"
/> | <xref uid="excel!Excel.FunctionResult:class" /><any>>
return:
type: '<xref uid="excel!Excel.FunctionResult:class" /><boolean>'
description: ''
- name: arabic(text)
uid: 'excel!Excel.Functions#arabic:member(1)'
package: excel!
fullName: arabic(text)
summary: Converts a Roman numeral to Arabic.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'arabic(text: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;'
parameters:
- id: text
description: Is the Roman numeral you want to convert.
type: >-
string | <xref uid="excel!Excel.Range:class" /> | <xref uid="excel!Excel.RangeReference:interface" /> |
<xref uid="excel!Excel.FunctionResult:class" /><any>
return:
type: '<xref uid="excel!Excel.FunctionResult:class" /><number>'
description: ''
- name: areas(reference)
uid: 'excel!Excel.Functions#areas:member(1)'
package: excel!
fullName: areas(reference)
summary: Returns the number of areas in a reference. An area is a range of contiguous cells or a single cell.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'areas(reference: Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;'
parameters:
- id: reference
description: Is a reference to a cell or range of cells and can refer to multiple areas.
type: >-
<xref uid="excel!Excel.Range:class" /> | <xref uid="excel!Excel.RangeReference:interface" /> | <xref
uid="excel!Excel.FunctionResult:class" /><any>
return:
type: '<xref uid="excel!Excel.FunctionResult:class" /><number>'
description: ''
- name: asc(text)
uid: 'excel!Excel.Functions#asc:member(1)'
package: excel!
fullName: asc(text)
summary: >-
Changes full-width (double-byte) characters to half-width (single-byte) characters. Use with double-byte character
sets (DBCS).
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'asc(text: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<string>;'
parameters:
- id: text
description: 'Is a text, or a reference to a cell containing a text.'
type: >-
string | <xref uid="excel!Excel.Range:class" /> | <xref uid="excel!Excel.RangeReference:interface" /> |
<xref uid="excel!Excel.FunctionResult:class" /><any>
return:
type: '<xref uid="excel!Excel.FunctionResult:class" /><string>'
description: ''
- name: asin(number)
uid: 'excel!Excel.Functions#asin:member(1)'
package: excel!
fullName: asin(number)
summary: 'Returns the arcsine of a number in radians, in the range -Pi/2 to Pi/2.'
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'asin(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;'
parameters:
- id: number
description: Is the sine of the angle you want and must be from -1 to 1.
type: >-
number | <xref uid="excel!Excel.Range:class" /> | <xref uid="excel!Excel.RangeReference:interface" /> |
<xref uid="excel!Excel.FunctionResult:class" /><any>
return:
type: '<xref uid="excel!Excel.FunctionResult:class" /><number>'
description: ''
- name: asinh(number)
uid: 'excel!Excel.Functions#asinh:member(1)'
package: excel!
fullName: asinh(number)
summary: Returns the inverse hyperbolic sine of a number.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'asinh(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;'
parameters:
- id: number
description: Is any real number equal to or greater than 1.
type: >-
number | <xref uid="excel!Excel.Range:class" /> | <xref uid="excel!Excel.RangeReference:interface" /> |
<xref uid="excel!Excel.FunctionResult:class" /><any>
return:
type: '<xref uid="excel!Excel.FunctionResult:class" /><number>'
description: ''
- name: atan(number)
uid: 'excel!Excel.Functions#atan:member(1)'
package: excel!
fullName: atan(number)
summary: 'Returns the arctangent of a number in radians, in the range -Pi/2 to Pi/2.'
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'atan(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;'
parameters:
- id: number
description: Is the tangent of the angle you want.
type: >-
number | <xref uid="excel!Excel.Range:class" /> | <xref uid="excel!Excel.RangeReference:interface" /> |
<xref uid="excel!Excel.FunctionResult:class" /><any>
return:
type: '<xref uid="excel!Excel.FunctionResult:class" /><number>'
description: ''
- name: 'atan2(xNum, yNum)'
uid: 'excel!Excel.Functions#atan2:member(1)'
package: excel!
fullName: 'atan2(xNum, yNum)'
summary: 'Returns the arctangent of the specified x- and y- coordinates, in radians between -Pi and Pi, excluding -Pi.'
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: >-
atan2(xNum: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, yNum: number | Excel.Range
| Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;
parameters:
- id: xNum
description: Is the x-coordinate of the point.
type: >-
number | <xref uid="excel!Excel.Range:class" /> | <xref uid="excel!Excel.RangeReference:interface" /> |
<xref uid="excel!Excel.FunctionResult:class" /><any>
- id: yNum
description: Is the y-coordinate of the point.
type: >-
number | <xref uid="excel!Excel.Range:class" /> | <xref uid="excel!Excel.RangeReference:interface" /> |
<xref uid="excel!Excel.FunctionResult:class" /><any>
return:
type: '<xref uid="excel!Excel.FunctionResult:class" /><number>'
description: ''
- name: atanh(number)
uid: 'excel!Excel.Functions#atanh:member(1)'
package: excel!
fullName: atanh(number)
summary: Returns the inverse hyperbolic tangent of a number.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'atanh(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;'
parameters:
- id: number
description: Is any real number between -1 and 1 excluding -1 and 1.
type: >-
number | <xref uid="excel!Excel.Range:class" /> | <xref uid="excel!Excel.RangeReference:interface" /> |
<xref uid="excel!Excel.FunctionResult:class" /><any>
return:
type: '<xref uid="excel!Excel.FunctionResult:class" /><number>'
description: ''
- name: aveDev(values)
uid: 'excel!Excel.Functions#aveDev:member(1)'
package: excel!
fullName: aveDev(values)
summary: >-
Returns the average of the absolute deviations of data points from their mean. Arguments can be numbers or names,
arrays, or references that contain numbers.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: >-
aveDev(...values: Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>):
FunctionResult<number>;
parameters:
- id: values
description: >-
List of parameters, whose elements are 1 to 255 arguments for which you want the average of the absolute
deviations.
type: >-
Array<number | <xref uid="excel!Excel.Range:class" /> | <xref uid="excel!Excel.RangeReference:interface"
/> | <xref uid="excel!Excel.FunctionResult:class" /><any>>
return:
type: '<xref uid="excel!Excel.FunctionResult:class" /><number>'
description: ''
- name: average(values)
uid: 'excel!Excel.Functions#average:member(1)'
package: excel!
fullName: average(values)
summary: >-
Returns the average (arithmetic mean) of its arguments, which can be numbers or names, arrays, or references that
contain numbers.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: >-
average(...values: Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>):
FunctionResult<number>;
parameters:
- id: values
description: 'List of parameters, whose elements are 1 to 255 numeric arguments for which you want the average.'
type: >-
Array<number | <xref uid="excel!Excel.Range:class" /> | <xref uid="excel!Excel.RangeReference:interface"
/> | <xref uid="excel!Excel.FunctionResult:class" /><any>>
return:
type: '<xref uid="excel!Excel.FunctionResult:class" /><number>'
description: ''
- name: averageA(values)
uid: 'excel!Excel.Functions#averageA:member(1)'
package: excel!
fullName: averageA(values)
summary: >-
Returns the average (arithmetic mean) of its arguments, evaluating text and FALSE in arguments as 0; TRUE
evaluates as 1. Arguments can be numbers, names, arrays, or references.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: >-
averageA(...values: Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>):
FunctionResult<number>;
parameters:
- id: values
description: 'List of parameters, whose elements are 1 to 255 arguments for which you want the average.'
type: >-
Array<number | <xref uid="excel!Excel.Range:class" /> | <xref uid="excel!Excel.RangeReference:interface"
/> | <xref uid="excel!Excel.FunctionResult:class" /><any>>
return:
type: '<xref uid="excel!Excel.FunctionResult:class" /><number>'
description: ''
- name: 'averageIf(range, criteria, averageRange)'
uid: 'excel!Excel.Functions#averageIf:member(1)'
package: excel!
fullName: 'averageIf(range, criteria, averageRange)'
summary: Finds average(arithmetic mean) for the cells specified by a given condition or criteria.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: >-
averageIf(range: Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, criteria: number | string |
boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, averageRange?: Excel.Range |
Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;
parameters:
- id: range
description: Is the range of cells you want evaluated.
type: >-
<xref uid="excel!Excel.Range:class" /> | <xref uid="excel!Excel.RangeReference:interface" /> | <xref
uid="excel!Excel.FunctionResult:class" /><any>
- id: criteria
description: >-
Is the condition or criteria in the form of a number, expression, or text that defines which cells will be
used to find the average.
type: >-
number | string | boolean | <xref uid="excel!Excel.Range:class" /> | <xref
uid="excel!Excel.RangeReference:interface" /> | <xref uid="excel!Excel.FunctionResult:class" /><any>
- id: averageRange
description: 'Are the actual cells to be used to find the average. If omitted, the cells in range are used.'
type: >-
<xref uid="excel!Excel.Range:class" /> | <xref uid="excel!Excel.RangeReference:interface" /> | <xref
uid="excel!Excel.FunctionResult:class" /><any>
return:
type: '<xref uid="excel!Excel.FunctionResult:class" /><number>'
description: ''
- name: 'averageIfs(averageRange, values)'
uid: 'excel!Excel.Functions#averageIfs:member(1)'
package: excel!
fullName: 'averageIfs(averageRange, values)'
summary: Finds average(arithmetic mean) for the cells specified by a given set of conditions or criteria.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: >-
averageIfs(averageRange: Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, ...values:
Array<Excel.Range | Excel.RangeReference | Excel.FunctionResult<any> | number | string | boolean>):
FunctionResult<number>;
parameters:
- id: averageRange
description: Are the actual cells to be used to find the average.
type: >-
<xref uid="excel!Excel.Range:class" /> | <xref uid="excel!Excel.RangeReference:interface" /> | <xref
uid="excel!Excel.FunctionResult:class" /><any>
- id: values
description: >-
List of parameters, where the first element of each pair is the Is the range of cells you want evaluated for
the particular condition , and the second element is is the condition or criteria in the form of a number,
expression, or text that defines which cells will be used to find the average.
type: >-
Array<<xref uid="excel!Excel.Range:class" /> | <xref uid="excel!Excel.RangeReference:interface" /> |
<xref uid="excel!Excel.FunctionResult:class" /><any> | number | string | boolean>
return:
type: '<xref uid="excel!Excel.FunctionResult:class" /><number>'
description: ''
- name: bahtText(number)
uid: 'excel!Excel.Functions#bahtText:member(1)'
package: excel!
fullName: bahtText(number)
summary: Converts a number to text (baht).
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: >-
bahtText(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>):
FunctionResult<string>;
parameters:
- id: number
description: Is a number that you want to convert.
type: >-
number | <xref uid="excel!Excel.Range:class" /> | <xref uid="excel!Excel.RangeReference:interface" /> |
<xref uid="excel!Excel.FunctionResult:class" /><any>
return:
type: '<xref uid="excel!Excel.FunctionResult:class" /><string>'
description: ''
- name: 'base(number, radix, minLength)'
uid: 'excel!Excel.Functions#base:member(1)'
package: excel!
fullName: 'base(number, radix, minLength)'
summary: Converts a number into a text representation with the given radix (base).
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: >-
base(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, radix: number |
Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, minLength?: number | Excel.Range |
Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<string>;
parameters:
- id: number
description: Is the number that you want to convert.
type: >-
number | <xref uid="excel!Excel.Range:class" /> | <xref uid="excel!Excel.RangeReference:interface" /> |
<xref uid="excel!Excel.FunctionResult:class" /><any>
- id: radix
description: Is the base Radix that you want to convert the number into.
type: >-
number | <xref uid="excel!Excel.Range:class" /> | <xref uid="excel!Excel.RangeReference:interface" /> |
<xref uid="excel!Excel.FunctionResult:class" /><any>
- id: minLength
description: Is the minimum length of the returned string. If omitted leading zeros are not added.
type: >-
number | <xref uid="excel!Excel.Range:class" /> | <xref uid="excel!Excel.RangeReference:interface" /> |
<xref uid="excel!Excel.FunctionResult:class" /><any>
return:
type: '<xref uid="excel!Excel.FunctionResult:class" /><string>'
description: ''
- name: 'besselI(x, n)'
uid: 'excel!Excel.Functions#besselI:member(1)'
package: excel!
fullName: 'besselI(x, n)'
summary: Returns the modified Bessel function In(x).
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: >-
besselI(x: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, n: number
| string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;
parameters:
- id: x
description: Is the value at which to evaluate the function.
type: >-
number | string | boolean | <xref uid="excel!Excel.Range:class" /> | <xref
uid="excel!Excel.RangeReference:interface" /> | <xref uid="excel!Excel.FunctionResult:class" /><any>
- id: 'n'
description: Is the order of the Bessel function.
type: >-
number | string | boolean | <xref uid="excel!Excel.Range:class" /> | <xref
uid="excel!Excel.RangeReference:interface" /> | <xref uid="excel!Excel.FunctionResult:class" /><any>
return:
type: '<xref uid="excel!Excel.FunctionResult:class" /><number>'
description: ''
- name: 'besselJ(x, n)'
uid: 'excel!Excel.Functions#besselJ:member(1)'
package: excel!
fullName: 'besselJ(x, n)'
summary: Returns the Bessel function Jn(x).
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: >-
besselJ(x: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, n: number
| string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;
parameters:
- id: x
description: Is the value at which to evaluate the function.
type: >-
number | string | boolean | <xref uid="excel!Excel.Range:class" /> | <xref
uid="excel!Excel.RangeReference:interface" /> | <xref uid="excel!Excel.FunctionResult:class" /><any>
- id: 'n'
description: Is the order of the Bessel function.
type: >-
number | string | boolean | <xref uid="excel!Excel.Range:class" /> | <xref
uid="excel!Excel.RangeReference:interface" /> | <xref uid="excel!Excel.FunctionResult:class" /><any>
return:
type: '<xref uid="excel!Excel.FunctionResult:class" /><number>'
description: ''
- name: 'besselK(x, n)'
uid: 'excel!Excel.Functions#besselK:member(1)'
package: excel!
fullName: 'besselK(x, n)'
summary: Returns the modified Bessel function Kn(x).
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: >-
besselK(x: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, n: number
| string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;
parameters:
- id: x
description: Is the value at which to evaluate the function.
type: >-
number | string | boolean | <xref uid="excel!Excel.Range:class" /> | <xref
uid="excel!Excel.RangeReference:interface" /> | <xref uid="excel!Excel.FunctionResult:class" /><any>
- id: 'n'
description: Is the order of the function.
type: >-
number | string | boolean | <xref uid="excel!Excel.Range:class" /> | <xref
uid="excel!Excel.RangeReference:interface" /> | <xref uid="excel!Excel.FunctionResult:class" /><any>
return:
type: '<xref uid="excel!Excel.FunctionResult:class" /><number>'
description: ''
- name: 'besselY(x, n)'
uid: 'excel!Excel.Functions#besselY:member(1)'
package: excel!
fullName: 'besselY(x, n)'
summary: Returns the Bessel function Yn(x).
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: >-
besselY(x: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, n: number
| string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;
parameters:
- id: x
description: Is the value at which to evaluate the function.
type: >-
number | string | boolean | <xref uid="excel!Excel.Range:class" /> | <xref
uid="excel!Excel.RangeReference:interface" /> | <xref uid="excel!Excel.FunctionResult:class" /><any>
- id: 'n'
description: Is the order of the function.
type: >-
number | string | boolean | <xref uid="excel!Excel.Range:class" /> | <xref
uid="excel!Excel.RangeReference:interface" /> | <xref uid="excel!Excel.FunctionResult:class" /><any>
return:
type: '<xref uid="excel!Excel.FunctionResult:class" /><number>'
description: ''
- name: 'beta_Dist(x, alpha, beta, cumulative, A, B)'
uid: 'excel!Excel.Functions#beta_Dist:member(1)'
package: excel!
fullName: 'beta_Dist(x, alpha, beta, cumulative, A, B)'
summary: Returns the beta probability distribution function.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: >-
beta_Dist(x: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, alpha: number |
Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, beta: number | Excel.Range |
Excel.RangeReference | Excel.FunctionResult<any>, cumulative: boolean | Excel.Range | Excel.RangeReference |
Excel.FunctionResult<any>, A?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, B?:
number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;
parameters:
- id: x
description: Is the value between A and B at which to evaluate the function.
type: >-
number | <xref uid="excel!Excel.Range:class" /> | <xref uid="excel!Excel.RangeReference:interface" /> |
<xref uid="excel!Excel.FunctionResult:class" /><any>
- id: alpha
description: Is a parameter to the distribution and must be greater than 0.
type: >-
number | <xref uid="excel!Excel.Range:class" /> | <xref uid="excel!Excel.RangeReference:interface" /> |
<xref uid="excel!Excel.FunctionResult:class" /><any>
- id: beta
description: Is a parameter to the distribution and must be greater than 0.
type: >-
number | <xref uid="excel!Excel.Range:class" /> | <xref uid="excel!Excel.RangeReference:interface" /> |
<xref uid="excel!Excel.FunctionResult:class" /><any>
- id: cumulative
description: >-
Is a logical value: for the cumulative distribution function, use TRUE; for the probability density
function, use FALSE.
type: >-
boolean | <xref uid="excel!Excel.Range:class" /> | <xref uid="excel!Excel.RangeReference:interface" /> |
<xref uid="excel!Excel.FunctionResult:class" /><any>
- id: A
description: 'Is an optional lower bound to the interval of x. If omitted, A = 0.'
type: >-
number | <xref uid="excel!Excel.Range:class" /> | <xref uid="excel!Excel.RangeReference:interface" /> |
<xref uid="excel!Excel.FunctionResult:class" /><any>
- id: B
description: 'Is an optional upper bound to the interval of x. If omitted, B = 1.'
type: >-
number | <xref uid="excel!Excel.Range:class" /> | <xref uid="excel!Excel.RangeReference:interface" /> |
<xref uid="excel!Excel.FunctionResult:class" /><any>
return:
type: '<xref uid="excel!Excel.FunctionResult:class" /><number>'
description: ''
- name: 'beta_Inv(probability, alpha, beta, A, B)'
uid: 'excel!Excel.Functions#beta_Inv:member(1)'
package: excel!
fullName: 'beta_Inv(probability, alpha, beta, A, B)'
summary: Returns the inverse of the cumulative beta probability density function (BETA.DIST).
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: >-
beta_Inv(probability: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, alpha: number |
Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, beta: number | Excel.Range |
Excel.RangeReference | Excel.FunctionResult<any>, A?: number | Excel.Range | Excel.RangeReference |
Excel.FunctionResult<any>, B?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>):
FunctionResult<number>;
parameters:
- id: probability
description: Is a probability associated with the beta distribution.
type: >-
number | <xref uid="excel!Excel.Range:class" /> | <xref uid="excel!Excel.RangeReference:interface" /> |
<xref uid="excel!Excel.FunctionResult:class" /><any>
- id: alpha
description: Is a parameter to the distribution and must be greater than 0.
type: >-
number | <xref uid="excel!Excel.Range:class" /> | <xref uid="excel!Excel.RangeReference:interface" /> |
<xref uid="excel!Excel.FunctionResult:class" /><any>
- id: beta
description: Is a parameter to the distribution and must be greater than 0.
type: >-
number | <xref uid="excel!Excel.Range:class" /> | <xref uid="excel!Excel.RangeReference:interface" /> |
<xref uid="excel!Excel.FunctionResult:class" /><any>
- id: A
description: 'Is an optional lower bound to the interval of x. If omitted, A = 0.'
type: >-
number | <xref uid="excel!Excel.Range:class" /> | <xref uid="excel!Excel.RangeReference:interface" /> |
<xref uid="excel!Excel.FunctionResult:class" /><any>
- id: B
description: 'Is an optional upper bound to the interval of x. If omitted, B = 1.'
type: >-
number | <xref uid="excel!Excel.Range:class" /> | <xref uid="excel!Excel.RangeReference:interface" /> |
<xref uid="excel!Excel.FunctionResult:class" /><any>
return:
type: '<xref uid="excel!Excel.FunctionResult:class" /><number>'
description: ''
- name: bin2Dec(number)
uid: 'excel!Excel.Functions#bin2Dec:member(1)'
package: excel!
fullName: bin2Dec(number)
summary: Converts a binary number to decimal.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: >-
bin2Dec(number: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>):
FunctionResult<number>;
parameters:
- id: number
description: Is the binary number you want to convert.
type: >-
number | string | boolean | <xref uid="excel!Excel.Range:class" /> | <xref
uid="excel!Excel.RangeReference:interface" /> | <xref uid="excel!Excel.FunctionResult:class" /><any>
return:
type: '<xref uid="excel!Excel.FunctionResult:class" /><number>'
description: ''
- name: 'bin2Hex(number, places)'
uid: 'excel!Excel.Functions#bin2Hex:member(1)'
package: excel!
fullName: 'bin2Hex(number, places)'
summary: Converts a binary number to hexadecimal.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: >-
bin2Hex(number: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>,
places?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>):
FunctionResult<number>;
parameters:
- id: number
description: Is the binary number you want to convert.
type: >-
number | string | boolean | <xref uid="excel!Excel.Range:class" /> | <xref
uid="excel!Excel.RangeReference:interface" /> | <xref uid="excel!Excel.FunctionResult:class" /><any>
- id: places
description: Is the number of characters to use.
type: >-
number | string | boolean | <xref uid="excel!Excel.Range:class" /> | <xref
uid="excel!Excel.RangeReference:interface" /> | <xref uid="excel!Excel.FunctionResult:class" /><any>
return:
type: '<xref uid="excel!Excel.FunctionResult:class" /><number>'
description: ''
- name: 'bin2Oct(number, places)'
uid: 'excel!Excel.Functions#bin2Oct:member(1)'
package: excel!
fullName: 'bin2Oct(number, places)'
summary: Converts a binary number to octal.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: >-
bin2Oct(number: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>,
places?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>):
FunctionResult<number>;