@fileverse-dev/formulajs 4.4.30 → 4.4.31-circles-patch-2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,4730 +0,0 @@
1
- export function AAVE(...args: any[]): Promise<any>;
2
- /**
3
- * Returns the absolute value of a number.
4
- *
5
- * Category: Math and trigonometry
6
- *
7
- * @param {*} number The real number of which you want the absolute value.
8
- * @returns
9
- */
10
- export function ABS(number: any): number | Error;
11
- /**
12
- * Returns the accrued interest for a security that pays periodic interest.
13
- *
14
- * Category: Financial
15
- *
16
- * @param {*} issue The security's issue date.
17
- * @param {*} first_interest The security's first interest date.
18
- * @param {*} settlement The security's settlement date. The security settlement date is the date after the issue date when the security is traded to the buyer.
19
- * @param {*} rate The security's annual coupon rate.
20
- * @param {*} par The security's par value. If you omit par, ACCRINT uses $1,000.
21
- * @param {*} frequency The number of coupon payments per year. For annual payments, frequency = 1; for semiannual, frequency = 2; for quarterly, frequency = 4.
22
- * @param {*} basis Optional. The type of day count basis to use.
23
- * @param {*} calc_method Optional. Not implemented in formulajs. A logical value that specifies the way to calculate the total accrued interest when the date of settlement is later than the date of first_interest. A value of TRUE (1) returns the total accrued interest from issue to settlement. A value of FALSE (0) returns the accrued interest from first_interest to settlement. If you do not enter the argument, it defaults to TRUE.
24
- * @returns
25
- */
26
- export function ACCRINT(issue: any, first_interest: any, settlement: any, rate: any, par: any, frequency: any, basis: any): number | Error;
27
- /**
28
- * Returns the arccosine of a number.
29
- *
30
- * Category: Math and trigonometry
31
- *
32
- * @param {*} number The cosine of the angle you want and must be from -1 to 1.
33
- * @returns
34
- */
35
- export function ACOS(number: any): number | Error;
36
- /**
37
- * Returns the inverse hyperbolic cosine of a number.
38
- *
39
- * Category: Math and trigonometry
40
- *
41
- * @param {*} number Any real number equal to or greater than 1.
42
- * @returns
43
- */
44
- export function ACOSH(number: any): number | Error;
45
- /**
46
- * Returns the arccotangent of a number.
47
- *
48
- * Category: Math and trigonometry
49
- *
50
- * @param {*} number Number is the cotangent of the angle you want. This must be a real number.
51
- * @returns
52
- */
53
- export function ACOT(number: any): number | Error;
54
- /**
55
- * Returns the hyperbolic arccotangent of a number.
56
- *
57
- * Category: Math and trigonometry
58
- *
59
- * @param {*} number The absolute value of Number must be greater than 1.
60
- * @returns
61
- */
62
- export function ACOTH(number: any): number | Error;
63
- /**
64
- * Returns an aggregate in a list or database.
65
- *
66
- * Category: Math and trigonometry
67
- *
68
- * @param {*} function_num A number 1 to 19 that specifies which function to use.
69
- * @param {*} options A numerical value that determines which values to ignore in the evaluation range for the function. Note: The function will not ignore hidden rows, nested subtotals or nested aggregates if the array argument includes a calculation, for example: =AGGREGATE(14,3,A1:A100*(A1:A100>0),1)
70
- * @param {*} ref1 The first numeric argument for functions that take multiple numeric arguments for which you want the aggregate value.
71
- * @param {*} ref2 Optional. Numeric arguments 2 to 253 for which you want the aggregate value. For functions that take an array, ref1 is an array, an array formula, or a reference to a range of values for which you want the aggregate value. Ref2 is a second argument that is required for certain functions.
72
- * @returns
73
- */
74
- export function AGGREGATE(function_num: any, options: any, ref1: any, ref2: any): any;
75
- /**
76
- * Returns TRUE if all of its arguments are TRUE.
77
- *
78
- * Category: Logical
79
- *
80
- * @returns
81
- */
82
- export function AND(...args: any[]): any;
83
- /**
84
- * Converts a Roman number to Arabic, as a number.
85
- *
86
- * Category: Math and trigonometry
87
- *
88
- * @param {*} text A string enclosed in quotation marks, an empty string (""), or a reference to a value containing text.
89
- * @returns
90
- */
91
- export function ARABIC(text: any): number | Error;
92
- export function ARTEMIS(): string;
93
- /**
94
- * Returns the arcsine of a number.
95
- *
96
- * Category: Math and trigonometry
97
- *
98
- * @param {*} number The sine of the angle you want and must be from -1 to 1.
99
- * @returns
100
- */
101
- export function ASIN(number: any): number | Error;
102
- /**
103
- * Returns the inverse hyperbolic sine of a number.
104
- *
105
- * Category: Math and trigonometry
106
- *
107
- * @param {*} number Any real number.
108
- * @returns
109
- */
110
- export function ASINH(number: any): number | Error;
111
- /**
112
- * Returns the arctangent of a number.
113
- *
114
- * Category: Math and trigonometry
115
- *
116
- * @param {*} number The tangent of the angle you want.
117
- * @returns
118
- */
119
- export function ATAN(number: any): number | Error;
120
- /**
121
- * Returns the arctangent from x- and y-coordinates.
122
- *
123
- * Category: Math and trigonometry
124
- *
125
- * @param {*} x_num The x-coordinate of the point.
126
- * @param {*} y_num The y-coordinate of the point.
127
- * @returns
128
- */
129
- export function ATAN2(x_num: any, y_num: any): any;
130
- /**
131
- * Returns the inverse hyperbolic tangent of a number.
132
- *
133
- * Category: Math and trigonometry
134
- *
135
- * @param {*} number Any real number between 1 and -1.
136
- * @returns
137
- */
138
- export function ATANH(number: any): number | Error;
139
- /**
140
- * Returns the average of the absolute deviations of data points from their mean.
141
- *
142
- * Category: Statistical
143
- *
144
- * @param {*} args number1, number2, ... Number1 is required, subsequent numbers are optional. 1 to 255 arguments for which you want the average of the absolute deviations. You can also use a single array or a reference to an array instead of arguments separated by commas.
145
- * @returns
146
- */
147
- export function AVEDEV(...args: any[]): number | Error;
148
- /**
149
- * Returns the average of its arguments.
150
- *
151
- * Category: Statistical
152
- *
153
- * @param {*} args number1, number2, ...Numbers, value references or ranges for which you want the average.
154
- * @returns
155
- */
156
- export function AVERAGE(...args: any[]): any;
157
- /**
158
- * Returns the average of its arguments, including numbers, text, and logical values.
159
- *
160
- * Category: Statistical
161
- *
162
- * @param {*} args value1, value2, ... Value1 is required, subsequent values are optional. 1 to 255 values, ranges of values, or values for which you want the average.
163
- * @returns
164
- */
165
- export function AVERAGEA(...args: any[]): any;
166
- /**
167
- * Returns the average (arithmetic mean) of all the values in a range that meet a given criteria.
168
- *
169
- * Category: Statistical
170
- *
171
- * @param {*} range One or more values to average, including numbers or names, arrays, or references that contain numbers.
172
- * @param {*} criteria The criteria in the form of a number, expression, value reference, or text that defines which values are averaged.
173
- * @param {*} average_range Optional. The actual set of values to average. If omitted, range is used.
174
- * @returns
175
- */
176
- export function AVERAGEIF(range: any, criteria: any, average_range: any, ...args: any[]): number | Error;
177
- /**
178
- * Returns the average (arithmetic mean) of all values that meet multiple criteria.
179
- *
180
- * Category: Statistical
181
- *
182
- * @param {*} args One or more values to average, including numbers or names, arrays, or references that contain numbers.
183
- * @returns
184
- */
185
- export function AVERAGEIFS(...args: any[]): number;
186
- export function BASE(...args: any[]): Promise<any>;
187
- /**
188
- * Returns the modified Bessel function In(x).
189
- *
190
- * Category: Engineering
191
- *
192
- * @param {*} x The value at which to evaluate the function.
193
- * @param {*} n The order of the Bessel function. If n is not an integer, it is truncated.
194
- * @returns
195
- */
196
- export function BESSELI(x: any, n: any): any;
197
- /**
198
- * Returns the Bessel function Jn(x).
199
- *
200
- * Category: Engineering
201
- *
202
- * @param {*} x The value at which to evaluate the function.
203
- * @param {*} n The order of the Bessel function. If n is not an integer, it is truncated.
204
- * @returns
205
- */
206
- export function BESSELJ(x: any, n: any): any;
207
- /**
208
- * Returns the modified Bessel function Kn(x).
209
- *
210
- * Category: Engineering
211
- *
212
- * @param {*} x The value at which to evaluate the function.
213
- * @param {*} n The order of the function. If n is not an integer, it is truncated.
214
- * @returns
215
- */
216
- export function BESSELK(x: any, n: any): any;
217
- /**
218
- * Returns the Bessel function Yn(x).
219
- *
220
- * Category: Engineering
221
- *
222
- * @param {*} x The value at which to evaluate the function.
223
- * @param {*} n The order of the function. If n is not an integer, it is truncated.
224
- * @returns
225
- */
226
- export function BESSELY(x: any, n: any): any;
227
- export namespace BETA {
228
- /**
229
- * Returns the beta cumulative distribution function.
230
- *
231
- * Category: Statistical
232
- *
233
- * @param {*} x The value between A and B at which to evaluate the function
234
- * @param {*} alpha A parameter of the distribution.
235
- * @param {*} beta A parameter of the distribution.
236
- * @param {*} cumulative A logical value that determines the form of the function. If cumulative is TRUE, BETA.DIST returns the cumulative distribution function; if FALSE, it returns the probability density function.
237
- * @param {*} a Optional. A lower bound to the interval of x.
238
- * @param {*} b Optional. An upper bound to the interval of x.
239
- * @returns
240
- */
241
- function DIST(x: any, alpha: any, beta: any, cumulative: any, a: any, b: any, ...args: any[]): any;
242
- /**
243
- * Returns the inverse of the cumulative distribution function for a specified beta distribution.
244
- *
245
- * Category: Statistical
246
- *
247
- * @param {*} probability A probability associated with the beta distribution.
248
- * @param {*} alpha A parameter of the distribution.
249
- * @param {*} beta A parameter the distribution.
250
- * @param {*} a Optional. A lower bound to the interval of x.
251
- * @param {*} b Optional. An upper bound to the interval of x.
252
- * @returns
253
- */
254
- function INV(probability: any, alpha: any, beta: any, a: any, b: any): any;
255
- }
256
- /**
257
- * Returns the beta cumulative distribution function.
258
- *
259
- * Category: Statistical
260
- *
261
- * @param {*} x The value between A and B at which to evaluate the function
262
- * @param {*} alpha A parameter of the distribution.
263
- * @param {*} beta A parameter of the distribution.
264
- * @param {*} cumulative A logical value that determines the form of the function. If cumulative is TRUE, BETA.DIST returns the cumulative distribution function; if FALSE, it returns the probability density function.
265
- * @param {*} a Optional. A lower bound to the interval of x.
266
- * @param {*} b Optional. An upper bound to the interval of x.
267
- * @returns
268
- */
269
- export function BETADIST(x: any, alpha: any, beta: any, cumulative: any, a: any, b: any, ...args: any[]): any;
270
- /**
271
- * Returns the inverse of the cumulative distribution function for a specified beta distribution.
272
- *
273
- * Category: Statistical
274
- *
275
- * @param {*} probability A probability associated with the beta distribution.
276
- * @param {*} alpha A parameter of the distribution.
277
- * @param {*} beta A parameter the distribution.
278
- * @param {*} a Optional. A lower bound to the interval of x.
279
- * @param {*} b Optional. An upper bound to the interval of x.
280
- * @returns
281
- */
282
- export function BETAINV(probability: any, alpha: any, beta: any, a: any, b: any): any;
283
- /**
284
- * Converts a binary number to decimal.
285
- *
286
- * Category: Engineering
287
- *
288
- * @param {*} number The binary number you want to convert. Number cannot contain more than 10 characters (10 bits). The most significant bit of number is the sign bit. The remaining 9 bits are magnitude bits. Negative numbers are represented using two's-complement notation.
289
- * @returns
290
- */
291
- export function BIN2DEC(number: any): number | Error;
292
- /**
293
- * Converts a binary number to hexadecimal.
294
- *
295
- * Category: Engineering
296
- *
297
- * @param {*} number The binary number you want to convert. Number cannot contain more than 10 characters (10 bits). The most significant bit of number is the sign bit. The remaining 9 bits are magnitude bits. Negative numbers are represented using two's-complement notation.
298
- * @param {*} places Optional. The number of characters to use. If places is omitted, BIN2HEX uses the minimum number of characters necessary. Places is useful for padding the return value with leading 0s (zeros).
299
- * @returns
300
- */
301
- export function BIN2HEX(number: any, places: any): string | Error;
302
- /**
303
- * Converts a binary number to octal.
304
- *
305
- * Category: Engineering
306
- *
307
- * @param {*} number The binary number you want to convert. Number cannot contain more than 10 characters (10 bits). The most significant bit of number is the sign bit. The remaining 9 bits are magnitude bits. Negative numbers are represented using two's-complement notation.
308
- * @param {*} places Optional. The number of characters to use. If places is omitted, BIN2OCT uses the minimum number of characters necessary. Places is useful for padding the return value with leading 0s (zeros).
309
- * @returns
310
- */
311
- export function BIN2OCT(number: any, places: any): string | Error;
312
- export namespace BINOM {
313
- /**
314
- * Returns the individual term binomial distribution probability.
315
- *
316
- * Category: Statistical
317
- *
318
- * @param {*} number_s The number of successes in trials.
319
- * @param {*} trials The number of independent trials.
320
- * @param {*} probability_s The probability of success on each trial.
321
- * @param {*} cumulative A logical value that determines the form of the function. If cumulative is TRUE, then BINOM.DIST returns the cumulative distribution function, which is the probability that there are at most number_s successes; if FALSE, it returns the probability mass function, which is the probability that there are number_s successes.
322
- * @returns
323
- */
324
- function DIST(number_s: any, trials: any, probability_s: any, cumulative: any): any;
325
- namespace DIST {
326
- /**
327
- * Returns the probability of a trial result using a binomial distribution.
328
- *
329
- * Category: Statistical
330
- *
331
- * @param {*} trials The number of independent trials. Must be greater than or equal to 0.
332
- * @param {*} probability_s The probability of success in each trial. Must be greater than or equal to 0 and less than or equal to 1.
333
- * @param {*} number_s The number of successes in trials. Must be greater than or equal to 0 and less than or equal to Trials.
334
- * @param {*} number_s2 Optional. If provided, returns the probability that the number of successful trials will fall between Number_s and number_s2. Must be greater than or equal to Number_s and less than or equal to Trials.
335
- * @returns
336
- */
337
- function RANGE(trials: any, probability_s: any, number_s: any, number_s2: any): number | Error;
338
- }
339
- /**
340
- * Returns the smallest value for which the cumulative binomial distribution is less than or equal to a criterion value.
341
- *
342
- * Category: Statistical
343
- *
344
- * @param {*} trials The number of Bernoulli trials.
345
- * @param {*} probability_s The probability of a success on each trial.
346
- * @param {*} alpha The criterion value.
347
- * @returns
348
- */
349
- function INV(trials: any, probability_s: any, alpha: any): number | Error;
350
- }
351
- /**
352
- * Returns the individual term binomial distribution probability.
353
- *
354
- * Category: Statistical
355
- *
356
- * @param {*} number_s The number of successes in trials.
357
- * @param {*} trials The number of independent trials.
358
- * @param {*} probability_s The probability of success on each trial.
359
- * @param {*} cumulative A logical value that determines the form of the function. If cumulative is TRUE, then BINOM.DIST returns the cumulative distribution function, which is the probability that there are at most number_s successes; if FALSE, it returns the probability mass function, which is the probability that there are number_s successes.
360
- * @returns
361
- */
362
- export function BINOMDIST(number_s: any, trials: any, probability_s: any, cumulative: any): any;
363
- export namespace BINOMDIST { }
364
- /**
365
- * Returns a 'Bitwise And' of two numbers.
366
- *
367
- * Category: Engineering
368
- *
369
- * @param {*} number1 Must be in decimal form and greater than or equal to 0.
370
- * @param {*} number2 Must be in decimal form and greater than or equal to 0.
371
- * @returns
372
- */
373
- export function BITAND(number1: any, number2: any): number | Error;
374
- /**
375
- * Returns a value number shifted left by shift_amount bits.
376
- *
377
- * Category: Engineering
378
- *
379
- * @param {*} number Number must be an integer greater than or equal to 0.
380
- * @param {*} shift_amount Shift_amount must be an integer.
381
- * @returns
382
- */
383
- export function BITLSHIFT(number: any, shift_amount: any): number | Error;
384
- /**
385
- * Returns a bitwise OR of 2 numbers.
386
- *
387
- * Category: Engineering
388
- *
389
- * @param {*} number1 Must be in decimal form and greater than or equal to 0.
390
- * @param {*} number2 Must be in decimal form and greater than or equal to 0.
391
- * @returns
392
- */
393
- export function BITOR(number1: any, number2: any): number | Error;
394
- /**
395
- * Returns a value number shifted right by shift_amount bits.
396
- *
397
- * Category: Engineering
398
- *
399
- * @param {*} number Must be an integer greater than or equal to 0.
400
- * @param {*} shift_amount Must be an integer.
401
- * @returns
402
- */
403
- export function BITRSHIFT(number: any, shift_amount: any): number | Error;
404
- /**
405
- * Returns a bitwise 'Exclusive Or' of two numbers.
406
- *
407
- * Category: Engineering
408
- *
409
- * @param {*} number1 Must be greater than or equal to 0.
410
- * @param {*} number2 Must be greater than or equal to 0.
411
- * @returns
412
- */
413
- export function BITXOR(number1: any, number2: any): number | Error;
414
- export function BLOCKSCOUT(...args: any[]): Promise<any>;
415
- /**
416
- * Converts a number into a text representation with the given radix (base).
417
- *
418
- * Category: Math and trigonometry
419
- *
420
- * @param {*} number The number that you want to convert. Must be an integer greater than or equal to 0 and less than 2^53.
421
- * @param {*} radix The base radix that you want to convert the number into. Must be an integer greater than or equal to 2 and less than or equal to 36.
422
- * @param {*} min_length Optional. The minimum length of the returned string. Must be an integer greater than or equal to 0.
423
- * @returns
424
- */
425
- /**
426
- * Rounds a number to the nearest integer or to the nearest multiple of significance.
427
- *
428
- * Category: Math and trigonometry
429
- *
430
- * @param {*} number The value you want to round.
431
- * @param {*} significance The multiple to which you want to round.
432
- * @param {*} mode Optional. For negative numbers, controls whether Number is rounded toward or away from zero.
433
- * @returns
434
- */
435
- export function CEILING(number: any, significance: any): any;
436
- export namespace CEILING {
437
- /**
438
- * Rounds a number up, to the nearest integer or to the nearest multiple of significance.
439
- *
440
- * Category: Math and trigonometry
441
- *
442
- * @param {*} number The value you want to round.
443
- * @param {*} significance Optional. This is the number of significant digits after the decimal point to which number is to be rounded.
444
- * @param {*} mode Optional. For negative numbers, controls whether Number is rounded toward or away from zero.
445
- * @returns
446
- */
447
- function MATH(number: any, significance: any, mode?: any): any;
448
- /**
449
- * Rounds a number up, to the nearest integer or to the nearest multiple of significance.
450
- *
451
- * Category: Math and trigonometry
452
- *
453
- * @param {*} number The value you want to round.
454
- * @param {*} significance Optional. This is the number of significant digits after the decimal point to which number is to be rounded.
455
- * @returns
456
- */
457
- function PRECISE(number: any, significance: any): any;
458
- }
459
- /**
460
- * Rounds a number up, to the nearest integer or to the nearest multiple of significance.
461
- *
462
- * Category: Math and trigonometry
463
- *
464
- * @param {*} number The value you want to round.
465
- * @param {*} significance Optional. This is the number of significant digits after the decimal point to which number is to be rounded.
466
- * @param {*} mode Optional. For negative numbers, controls whether Number is rounded toward or away from zero.
467
- * @returns
468
- */
469
- export function CEILINGMATH(number: any, significance: any, mode?: any): any;
470
- /**
471
- * Rounds a number up, to the nearest integer or to the nearest multiple of significance.
472
- *
473
- * Category: Math and trigonometry
474
- *
475
- * @param {*} number The value you want to round.
476
- * @param {*} significance Optional. This is the number of significant digits after the decimal point to which number is to be rounded.
477
- * @returns
478
- */
479
- export function CEILINGPRECISE(number: any, significance: any): any;
480
- /**
481
- * Returns the character specified by the code number.
482
- *
483
- * Category: Text
484
- *
485
- * @param {*} number A number between 1 and 255 specifying which character you want. The character is from the character set used by your computer. Note: Excel for the web supports only CHAR(9), CHAR(10), CHAR(13), and CHAR(32) and above.
486
- * @returns
487
- */
488
- export function CHAR(number: any): string | Error;
489
- /**
490
- * Returns the cumulative beta probability density function.
491
- *
492
- * Category: Statistical
493
- *
494
- * @param {*} x The value at which you want to evaluate the distribution.
495
- * @param {*} deg_freedom The number of degrees of freedom.
496
- * @param {*} cumulative A logical value that determines the form of the function. If cumulative is TRUE, CHISQ.DIST returns the cumulative distribution function; if FALSE, it returns the probability density function.
497
- * @returns
498
- */
499
- export function CHIDIST(x: any, deg_freedom: any, cumulative: any): any;
500
- export namespace CHIDIST {
501
- /**
502
- * Returns the one-tailed probability of the chi-squared distribution.
503
- *
504
- * Category: Statistical
505
- *
506
- * @param {*} x The value at which you want to evaluate the distribution.
507
- * @param {*} deg_freedom The number of degrees of freedom.
508
- * @returns
509
- */
510
- function RT(x: any, deg_freedom: any): number | Error;
511
- }
512
- /**
513
- * Returns the one-tailed probability of the chi-squared distribution.
514
- *
515
- * Category: Statistical
516
- *
517
- * @param {*} x The value at which you want to evaluate the distribution.
518
- * @param {*} deg_freedom The number of degrees of freedom.
519
- * @returns
520
- */
521
- export function CHIDISTRT(x: any, deg_freedom: any): number | Error;
522
- /**
523
- * Returns the cumulative beta probability density function.
524
- *
525
- * Category: Statistical
526
- *
527
- * @param {*} probability A probability associated with the chi-squared distribution.
528
- * @param {*} deg_freedom The number of degrees of freedom.
529
- * @returns
530
- */
531
- export function CHIINV(probability: any, deg_freedom: any): any;
532
- export namespace CHIINV {
533
- /**
534
- * Returns the inverse of the one-tailed probability of the chi-squared distribution.
535
- *
536
- * Category: Statistical
537
- *
538
- * @param {*} probability A probability associated with the chi-squared distribution.
539
- * @param {*} deg_freedom The number of degrees of freedom.
540
- * @returns
541
- */
542
- function RT(probability: any, deg_freedom: any): any;
543
- }
544
- /**
545
- * Returns the inverse of the one-tailed probability of the chi-squared distribution.
546
- *
547
- * Category: Statistical
548
- *
549
- * @param {*} probability A probability associated with the chi-squared distribution.
550
- * @param {*} deg_freedom The number of degrees of freedom.
551
- * @returns
552
- */
553
- export function CHIINVRT(probability: any, deg_freedom: any): any;
554
- export namespace CHISQ {
555
- /**
556
- * Returns the cumulative beta probability density function.
557
- *
558
- * Category: Statistical
559
- *
560
- * @param {*} x The value at which you want to evaluate the distribution.
561
- * @param {*} deg_freedom The number of degrees of freedom.
562
- * @param {*} cumulative A logical value that determines the form of the function. If cumulative is TRUE, CHISQ.DIST returns the cumulative distribution function; if FALSE, it returns the probability density function.
563
- * @returns
564
- */
565
- function DIST(x: any, deg_freedom: any, cumulative: any): any;
566
- namespace DIST { }
567
- /**
568
- * Returns the cumulative beta probability density function.
569
- *
570
- * Category: Statistical
571
- *
572
- * @param {*} probability A probability associated with the chi-squared distribution.
573
- * @param {*} deg_freedom The number of degrees of freedom.
574
- * @returns
575
- */
576
- function INV(probability: any, deg_freedom: any): any;
577
- namespace INV { }
578
- /**
579
- * Returns the test for independence.
580
- *
581
- * Category: Statistical
582
- *
583
- * @param {*} actual_range The range of data that contains observations to test against expected values.
584
- * @param {*} expected_range The range of data that contains the ratio of the product of row totals and column totals to the grand total.
585
- * @returns
586
- */
587
- function TEST(actual_range: any, expected_range: any, ...args: any[]): number | Error;
588
- }
589
- /**
590
- * Returns the test for independence.
591
- *
592
- * Category: Statistical
593
- *
594
- * @param {*} actual_range The range of data that contains observations to test against expected values.
595
- * @param {*} expected_range The range of data that contains the ratio of the product of row totals and column totals to the grand total.
596
- * @returns
597
- */
598
- export function CHITEST(actual_range: any, expected_range: any, ...args: any[]): number | Error;
599
- /**
600
- * Chooses a value from a list of values.
601
- *
602
- * Category: Lookup and reference
603
- *
604
- * @param {*} index_num Specifies which value argument is selected. Index_num must be a number between 1 and 254, or a formula or reference to a value containing a number between 1 and 254. If index_num is 1, CHOOSE returns value1; if it is 2, CHOOSE returns value2; and so on. If index_num is less than 1 or greater than the number of the last value in the list, CHOOSE returns the #VALUE! error value. If index_num is a fraction, it is truncated to the lowest integer before being used.
605
- - If index_num is 1, CHOOSE returns value1; if it is 2, CHOOSE returns value2; and so on.
606
- - If index_num is less than 1 or greater than the number of the last value in the list, CHOOSE returns the #VALUE! error value.
607
- - If index_num is a fraction, it is truncated to the lowest integer before being used.
608
- * @param {*} args value1, value2, ... Value 1 is required, subsequent values are optional. 1 to 254 value arguments from which CHOOSE selects a value or an action to perform based on index_num. The arguments can be numbers, value references, defined names, formulas, functions, or text.
609
- * @returns
610
- */
611
- export function CHOOSE(...args: any[]): any;
612
- /**
613
- * Removes all nonprintable characters from text.
614
- *
615
- * Category: Text
616
- *
617
- * @param {*} text Any worksheet information from which you want to remove nonprintable characters.
618
- * @returns
619
- */
620
- export function CLEAN(text: any): any;
621
- /**
622
- * Returns a numeric code for the first character in a text string.
623
- *
624
- * Category: Text
625
- *
626
- * @param {*} text The text for which you want the code of the first character.
627
- * @returns
628
- */
629
- export function CODE(text: any): any;
630
- export function COINGECKO(...args: any[]): Promise<{
631
- message: string;
632
- functionName: any;
633
- type: string;
634
- apiKeyName?: undefined;
635
- reason?: undefined;
636
- } | {
637
- message: string;
638
- functionName: any;
639
- type: string;
640
- apiKeyName: any;
641
- reason?: undefined;
642
- } | {
643
- message: string;
644
- functionName: any;
645
- type: string;
646
- reason: any;
647
- apiKeyName?: undefined;
648
- } | {}[]>;
649
- /**
650
- * Returns the column number of a reference.
651
- *
652
- * Category: Lookup and reference
653
- *
654
- * @param {*} reference the value or range of values for which you want to return the column number.
655
- * @param {*} index
656
- * @returns
657
- */
658
- export function COLUMN(reference: any, index: any, ...args: any[]): any;
659
- /**
660
- * Returns the number of columns in a reference.
661
- *
662
- * Category: Lookup and reference
663
- *
664
- * @param {*} array An array or array formula, or a reference to a range of values for which you want the number of columns.
665
- * @returns
666
- */
667
- export function COLUMNS(array: any, ...args: any[]): any;
668
- /**
669
- * Returns the number of combinations for a given number of objects.
670
- *
671
- * Category: Math and trigonometry
672
- *
673
- * @param {*} number The number of items.
674
- * @param {*} number_chosen The number of items in each combination.
675
- * @returns
676
- */
677
- export function COMBIN(number: any, number_chosen: any): any;
678
- /**
679
- * Returns the number of combinations with repetitions for a given number of items.
680
- *
681
- * Category: Math and trigonometry
682
- *
683
- * @param {*} number Must be greater than or equal to 0, and greater than or equal to Number_chosen. Non-integer values are truncated.
684
- * @param {*} number_chosen Must be greater than or equal to 0. Non-integer values are truncated.
685
- * @returns
686
- */
687
- export function COMBINA(number: any, number_chosen: any): any;
688
- /**
689
- * Converts real and imaginary coefficients into a complex number.
690
- *
691
- * Category: Engineering
692
- *
693
- * @param {*} real_num The real coefficient of the complex number.
694
- * @param {*} i_num The imaginary coefficient of the complex number.
695
- * @param {*} suffix Optional. The suffix for the imaginary component of the complex number. If omitted, suffix is assumed to be "i".
696
- * @returns
697
- */
698
- export function COMPLEX(real_num: any, i_num: any, suffix: any): any;
699
- /**
700
- * Joins several text items into one text item.
701
- *
702
- * Category: Text
703
- *
704
- * @returns
705
- */
706
- export function CONCAT(...args: any[]): any;
707
- /**
708
- * Joins several text items into one text item.
709
- *
710
- * Category: Text
711
- *
712
- * @returns
713
- */
714
- export function CONCATENATE(...args: any[]): any;
715
- export namespace CONFIDENCE {
716
- /**
717
- * Returns the confidence interval for a population mean.
718
- *
719
- * Category: Statistical
720
- *
721
- * @param {*} alpha The significance level used to compute the confidence level. The confidence level equals 100*(1 - alpha)%, or in other words, an alpha of 0.05 indicates a 95 percent confidence level.
722
- * @param {*} standard_dev The population standard deviation for the data range and is assumed to be known.
723
- * @param {*} size The sample size.
724
- * @returns
725
- */
726
- function NORM(alpha: any, standard_dev: any, size: any): number | Error;
727
- /**
728
- * Returns the confidence interval for a population mean, using a Student's t distribution.
729
- *
730
- * Category: Statistical
731
- *
732
- * @param {*} alpha The significance level used to compute the confidence level. The confidence level equals 100*(1 - alpha)%, or in other words, an alpha of 0.05 indicates a 95 percent confidence level.
733
- * @param {*} standard_dev The population standard deviation for the data range and is assumed to be known.
734
- * @param {*} size The sample size.
735
- * @returns
736
- */
737
- function T(alpha: any, standard_dev: any, size: any): number | Error;
738
- }
739
- /**
740
- * Converts a number from one measurement system to another.
741
- *
742
- * Category: Engineering
743
- *
744
- * @param {*} number is the value in from_units to convert.
745
- * @param {*} from_unit is the units for number.
746
- * @param {*} to_unit is the units for the result. CONVERT accepts the following text values (in quotation marks) for from_unit and to_unit.
747
- * @returns
748
- */
749
- export function CONVERT(number: any, from_unit: any, to_unit: any): number | Error;
750
- /**
751
- * Returns the correlation coefficient between two data sets.
752
- *
753
- * Category: Statistical
754
- *
755
- * @param {*} array1 A range of value values.
756
- * @param {*} array2 A second range of value values.
757
- * @returns
758
- */
759
- export function CORREL(array1: any, array2: any): any;
760
- /**
761
- * Returns the cosine of a number.
762
- *
763
- * Category: Math and trigonometry
764
- *
765
- * @param {*} number The angle in radians for which you want the cosine.
766
- * @returns
767
- */
768
- export function COS(number: any): number | Error;
769
- /**
770
- * Returns the hyperbolic cosine of a number.
771
- *
772
- * Category: Math and trigonometry
773
- *
774
- * @param {*} number Any real number for which you want to find the hyperbolic cosine.
775
- * @returns
776
- */
777
- export function COSH(number: any): number | Error;
778
- /**
779
- * Returns the hyperbolic cosine of a number.
780
- *
781
- * Category: Math and trigonometry
782
- *
783
- * @param {*} number The angle in radians for which you want the cotangent.
784
- * @returns
785
- */
786
- export function COT(number: any): number | Error;
787
- /**
788
- * Returns the cotangent of an angle.
789
- *
790
- * Category: Math and trigonometry
791
- *
792
- * @param {*} number
793
- * @returns
794
- */
795
- export function COTH(number: any): number | Error;
796
- /**
797
- * Counts how many numbers are in the list of arguments.
798
- *
799
- * Category: Statistical
800
- *
801
- * @param {*} args Cell reference, or range within which you want to count numbers.count numbers.
802
- * @returns
803
- */
804
- export function COUNT(...args: any[]): any;
805
- /**
806
- * Counts how many values are in the list of arguments.
807
- *
808
- * Category: Statistical
809
- *
810
- * @param {*} args Arguments representing the values that you want to count.
811
- * @returns
812
- */
813
- export function COUNTA(...args: any[]): number;
814
- /**
815
- * Counts the number of blank values within a range.
816
- *
817
- * Category: Statistical
818
- *
819
- * @param {*} args The range from which you want to count the blank values.
820
- * @returns
821
- */
822
- export function COUNTBLANK(...args: any[]): number;
823
- /**
824
- * Counts the number of values within a range that meet the given criteria.
825
- *
826
- * Category: Statistical
827
- *
828
- * @returns
829
- */
830
- export function COUNTIF(range: any, criteria: any): any;
831
- /**
832
- * Counts the number of values within a range that meet multiple criteria.
833
- *
834
- * Category: Statistical
835
- *
836
- * @param {*} args Range in which to evaluate the associated criteria.
837
- * @returns
838
- */
839
- export function COUNTIFS(...args: any[]): number;
840
- /**
841
- *
842
- * Returns the number of days in the coupon period that contains the settlement date.
843
- *
844
- * Category: Financial
845
- *
846
- * @param {*} settlement The security's settlement date. The security settlement date is the date after the issue date when the security is traded to the buyer.
847
- * @param {*} maturity The security's maturity date. The maturity date is the date when the security expires.
848
- * @param {*} frequency The number of coupon payments per year. For annual payments, frequency = 1; for semiannual, frequency = 2; for quarterly, frequency = 4.
849
- * @param {*} basis Optional. The type of day count basis to use.
850
- * @returns
851
- */
852
- export function COUPDAYS(settlement: any, maturity: any, frequency: any, basis: any): number | Error;
853
- /**
854
- * Returns covariance, the average of the products of paired deviations.
855
- *
856
- * Category: Statistical
857
- *
858
- * @param {*} array1 The first value range of integers.
859
- * @param {*} array2 The second value range of integers.
860
- * @returns
861
- */
862
- export function COVAR(array1: any, array2: any): number | Error;
863
- export namespace COVARIANCE {
864
- /**
865
- * Returns covariance, the average of the products of paired deviations.
866
- *
867
- * Category: Statistical
868
- *
869
- * @param {*} array1 The first value range of integers.
870
- * @param {*} array2 The second value range of integers.
871
- * @returns
872
- */
873
- function P(array1: any, array2: any): number | Error;
874
- /**
875
- * Returns the sample covariance, the average of the products deviations for each data point pair in two data sets.
876
- *
877
- * Category: Statistical
878
- *
879
- * @param {*} array1 The first value range of integers.
880
- * @param {*} array2 The second value range of integers.
881
- * @returns
882
- */
883
- function S(array1: any, array2: any): any;
884
- }
885
- /**
886
- * Returns covariance, the average of the products of paired deviations.
887
- *
888
- * Category: Statistical
889
- *
890
- * @param {*} array1 The first value range of integers.
891
- * @param {*} array2 The second value range of integers.
892
- * @returns
893
- */
894
- export function COVARIANCEP(array1: any, array2: any): number | Error;
895
- /**
896
- * Returns the sample covariance, the average of the products deviations for each data point pair in two data sets.
897
- *
898
- * Category: Statistical
899
- *
900
- * @param {*} array1 The first value range of integers.
901
- * @param {*} array2 The second value range of integers.
902
- * @returns
903
- */
904
- export function COVARIANCES(array1: any, array2: any): any;
905
- /**
906
- * Returns the smallest value for which the cumulative binomial distribution is less than or equal to a criterion value.
907
- *
908
- * Category: Statistical
909
- *
910
- * @param {*} trials The number of Bernoulli trials.
911
- * @param {*} probability_s The probability of a success on each trial.
912
- * @param {*} alpha The criterion value.
913
- * @returns
914
- */
915
- export function CRITBINOM(trials: any, probability_s: any, alpha: any): number | Error;
916
- /**
917
- * Returns the cosecant of an angle.
918
- *
919
- * Category: Math and trigonometry
920
- *
921
- * @param {*} number
922
- * @returns
923
- */
924
- export function CSC(number: any): number | Error;
925
- /**
926
- * Returns the hyperbolic cosecant of an angle.
927
- *
928
- * Category: Math and trigonometry
929
- *
930
- * @param {*} number
931
- * @returns
932
- */
933
- export function CSCH(number: any): number | Error;
934
- /**
935
- * Returns the cumulative interest paid between two periods.
936
- *
937
- * Category: Financial
938
- *
939
- * @param {*} rate The interest rate.
940
- * @param {*} nper The total number of payment periods.
941
- * @param {*} pv The present value.
942
- * @param {*} start_period The first period in the calculation. Payment periods are numbered beginning with 1.
943
- * @param {*} end_period The last period in the calculation.
944
- * @param {*} type The timing of the payment.
945
- * @returns
946
- */
947
- export function CUMIPMT(rate: any, nper: any, pv: any, start_period: any, end_period: any, type: any): number | Error;
948
- /**
949
- * Returns the cumulative principal paid on a loan between two periods.
950
- *
951
- * Category: Financial
952
- *
953
- * @param {*} rate The interest rate.
954
- * @param {*} nper The total number of payment periods.
955
- * @param {*} pv The present value.
956
- * @param {*} start_period The first period in the calculation. Payment periods are numbered beginning with 1.
957
- * @param {*} end_period The last period in the calculation.
958
- * @param {*} type The timing of the payment.
959
- * @returns
960
- */
961
- export function CUMPRINC(rate: any, nper: any, pv: any, start_period: any, end: any, type: any): number | Error;
962
- /**
963
- * Returns the serial number of a particular date.
964
- *
965
- * Category: Date and time
966
- *
967
- * @param {*} year Year
968
- * @param {*} month Month
969
- * @param {*} day Day
970
- * @returns
971
- */
972
- export function DATE(year: any, month: any, day: any): number | Date | Error;
973
- /**
974
- * Calculates the number of days, months, or years between two dates. This function is useful in formulas where you need to calculate an age.
975
- *
976
- * Category: Date and time
977
- *
978
- * @param {*} start_date A date that represents the first, or starting date of a given period.
979
- * @param {*} end_date A date that represents the last, or ending, date of the period.
980
- * @param {*} unit The type of information that you want returned, where:
981
- - "Y": The number of complete years in the period.
982
- - "M": The number of complete months in the period.
983
- - "D": The number of days in the period.
984
- - "MD": The difference between the days in start_date and end_date. The months and years of the dates are ignored.
985
- - "YM": The difference between the months in start_date and end_date. The days and years of the dates are ignored
986
- - "YD": The difference between the days of start_date and end_date. The years of the dates are ignored.
987
- * @returns
988
- */
989
- export function DATEDIF(start_date: any, end_date: any, unit: any): number | Error;
990
- /**
991
- * Converts a date in the form of text to a serial number.
992
- *
993
- * Category: Date and time
994
- *
995
- * @param {*} date_text Text that represents a date in an Excel date format, or a reference to a value that contains text that represents a date in an Excel date format.
996
- * @returns
997
- */
998
- export function DATEVALUE(date_text: any): number | Date | Error;
999
- /**
1000
- * Returns the average of selected database entries.
1001
- *
1002
- * Category: Database
1003
- *
1004
- * @param {*} database Range of values that makes up the list or database. A database is a list of related data in which rows of related information are records, and columns of data are fields. The first row of the list contains labels for each column.
1005
- * @param {*} field Indicates which column is used in the function. Enter the column label enclosed between double quotation marks, such as "Age" or "Yield," or a number (without quotation marks) that represents the position of the column within the list: 1 for the first column, 2 for the second column, and so on.
1006
- * @param {*} criteria Range of values that contains the conditions you specify. You can use any range for the criteria argument, as long as it includes at least one column label and at least one value below the column label in which you specify a condition for the column.
1007
- * @returns
1008
- */
1009
- export function DAVERAGE(database: any, field: any, criteria: any): number | Error;
1010
- /**
1011
- * Converts a serial number to a day of the month.
1012
- *
1013
- * Category: Date and time
1014
- *
1015
- * @param {*} serial_number The date of the day you are trying to find.
1016
- * @returns
1017
- */
1018
- export function DAY(serial_number: any): number | Error;
1019
- /**
1020
- * Returns the number of days between two dates.
1021
- *
1022
- * Category: Date and time
1023
- *
1024
- * @param {*} end_date Start_date and End_date are the two dates between which you want to know the number of days.
1025
- * @param {*} start_date Start_date and End_date are the two dates between which you want to know the number of days.
1026
- * @returns
1027
- */
1028
- export function DAYS(end_date: any, start_date: any): number | Error;
1029
- /**
1030
- * Calculates the number of days between two dates based on a 360-day year.
1031
- *
1032
- * Category: Date and time
1033
- *
1034
- * @param {*} start_date A date that represents the start date. If start_date occurs after end_date, the DAYS360 function returns a negative number.
1035
- * @param {*} end_date A date that represents the end date.
1036
- * @param {*} method Optional. A logical value that specifies whether to use the U.S. or European method in the calculation.
1037
- * @returns
1038
- */
1039
- export function DAYS360(start_date: any, end_date: any, method: any): number | Error;
1040
- /**
1041
- * Returns the depreciation of an asset for a specified period by using the fixed-declining balance method.
1042
- *
1043
- * Category: Financial
1044
- *
1045
- * @param {*} cost The initial cost of the asset.
1046
- * @param {*} salvage The value at the end of the depreciation (sometimes called the salvage value of the asset).
1047
- * @param {*} life The number of periods over which the asset is being depreciated (sometimes called the useful life of the asset).
1048
- * @param {*} period The period for which you want to calculate the depreciation. Period must use the same units as life.
1049
- * @param {*} month Optional. The number of months in the first year. If month is omitted, it is assumed to be 12.
1050
- * @returns
1051
- */
1052
- export function DB(cost: any, salvage: any, life: any, period: any, month: any): number | Error;
1053
- /**
1054
- * Counts the values that contain numbers in a database.
1055
- *
1056
- * Category: Database
1057
- *
1058
- * @param {*} database The range of values that makes up the list or database. A database is a list of related data in which rows of related information are records, and columns of data are fields. The first row of the list contains labels for each column.
1059
- * @param {*} field Indicates which column is used in the function. Enter the column label enclosed between double quotation marks, such as "Age" or "Yield," or a number (without quotation marks) that represents the position of the column within the list: 1 for the first column, 2 for the second column, and so on.
1060
- * @param {*} criteria The range of values that contains the conditions that you specify. You can use any range for the criteria argument, as long as the argument includes at least one column label and at least one value below the column label in which you specify a condition for the column.
1061
- * @returns
1062
- */
1063
- export function DCOUNT(database: any, field: any, criteria: any): any;
1064
- /**
1065
- * Counts nonblank values in a database.
1066
- *
1067
- * Category: Database
1068
- *
1069
- * @param {*} database The range of values that makes up the list or database. A database is a list of related data in which rows of related information are records, and columns of data are fields. The first row of the list contains labels for each column.
1070
- * @param {*} field Optional. Indicates which column is used in the function. Enter the column label enclosed between double quotation marks, such as "Age" or "Yield," or a number (without quotation marks) that represents the position of the column within the list: 1 for the first column, 2 for the second column, and so on.
1071
- * @param {*} criteria The range of values that contains the conditions that you specify. You can use any range for the criteria argument, as long as it includes at least one column label and at least one value below the column label in which you specify a condition for the column.
1072
- * @returns
1073
- */
1074
- export function DCOUNTA(database: any, field: any, criteria: any): number | Error;
1075
- /**
1076
- * Returns the depreciation of an asset for a specified period by using the double-declining balance method or some other method that you specify.
1077
- *
1078
- * Category: Financial
1079
- *
1080
- * @param {*} cost The initial cost of the asset.
1081
- * @param {*} salvage The value at the end of the depreciation (sometimes called the salvage value of the asset). This value can be 0.
1082
- * @param {*} life The number of periods over which the asset is being depreciated (sometimes called the useful life of the asset).
1083
- * @param {*} period The period for which you want to calculate the depreciation. Period must use the same units as life.
1084
- * @param {*} factor Optional. The rate at which the balance declines. If factor is omitted, it is assumed to be 2 (the double-declining balance method).
1085
- * @returns
1086
- */
1087
- export function DDB(cost: any, salvage: any, life: any, period: any, factor: any): number | Error;
1088
- /**
1089
- * Converts a decimal number to binary.
1090
- *
1091
- * Category: Engineering
1092
- *
1093
- * @param {*} number The decimal integer you want to convert. If number is negative, valid place values are ignored and DEC2BIN returns a 10-character (10-bit) binary number in which the most significant bit is the sign bit. The remaining 9 bits are magnitude bits. Negative numbers are represented using two's-complement notation.
1094
- * @param {*} places Optional. The number of characters to use. If places is omitted, DEC2BIN uses the minimum number of characters necessary. Places is useful for padding the return value with leading 0s (zeros).
1095
- * @returns
1096
- */
1097
- export function DEC2BIN(number: any, places: any): string | Error;
1098
- /**
1099
- * Converts a decimal number to hexadecimal.
1100
- *
1101
- * Category: Engineering
1102
- *
1103
- * @param {*} number The decimal integer you want to convert. If number is negative, places is ignored and DEC2HEX returns a 10-character (40-bit) hexadecimal number in which the most significant bit is the sign bit. The remaining 39 bits are magnitude bits. Negative numbers are represented using two's-complement notation.
1104
- * @param {*} places Optional. The number of characters to use. If places is omitted, DEC2HEX uses the minimum number of characters necessary. Places is useful for padding the return value with leading 0s (zeros).
1105
- * @returns
1106
- */
1107
- export function DEC2HEX(number: any, places: any): any;
1108
- /**
1109
- * Converts a decimal number to octal.
1110
- *
1111
- * Category: Engineering
1112
- *
1113
- * @param {*} number The decimal integer you want to convert. If number is negative, places is ignored and DEC2OCT returns a 10-character (30-bit) octal number in which the most significant bit is the sign bit. The remaining 29 bits are magnitude bits. Negative numbers are represented using two's-complement notation.
1114
- * @param {*} places Optional. The number of characters to use. If places is omitted, DEC2OCT uses the minimum number of characters necessary. Places is useful for padding the return value with leading 0s (zeros).
1115
- * @returns
1116
- */
1117
- export function DEC2OCT(number: any, places: any): any;
1118
- /**
1119
- * Converts a text representation of a number in a given base into a decimal number.
1120
- *
1121
- * Category: Math and trigonometry
1122
- *
1123
- * @param {*} text
1124
- * @param {*} radix Radix must be an integer.
1125
- * @returns
1126
- */
1127
- export function DECIMAL(text: any, radix: any, ...args: any[]): any;
1128
- export function DEFILLAMA(...args: any[]): Promise<{
1129
- message: string;
1130
- functionName: any;
1131
- type: string;
1132
- apiKeyName?: undefined;
1133
- reason?: undefined;
1134
- } | {
1135
- message: string;
1136
- functionName: any;
1137
- type: string;
1138
- apiKeyName: any;
1139
- reason?: undefined;
1140
- } | {
1141
- message: string;
1142
- functionName: any;
1143
- type: string;
1144
- reason: any;
1145
- apiKeyName?: undefined;
1146
- } | {}[]>;
1147
- /**
1148
- * Converts radians to degrees.
1149
- *
1150
- * Category: Math and trigonometry
1151
- *
1152
- * @param {*} angle The angle in radians that you want to convert.
1153
- * @returns
1154
- */
1155
- export function DEGREES(angle: any): number | Error;
1156
- /**
1157
- * Tests whether two values are equal.
1158
- *
1159
- * Category: Engineering
1160
- *
1161
- * @param {*} number1 The first number.
1162
- * @param {*} number2 Optional. The second number. If omitted, number2 is assumed to be zero.
1163
- * @returns
1164
- */
1165
- export function DELTA(number1: any, number2: any): 0 | Error | 1;
1166
- /**
1167
- * Returns the sum of squares of deviations.
1168
- *
1169
- * Category: Statistical
1170
- *
1171
- * @param {*} args number1, number2, ... Number1 is required, subsequent numbers are optional. 1 to 255 arguments for which you want to calculate the sum of squared deviations. You can also use a single array or a reference to an array instead of arguments separated by commas.
1172
- * @returns
1173
- */
1174
- export function DEVSQ(...args: any[]): number | Error;
1175
- /**
1176
- * Extracts from a database a single record that matches the specified criteria.
1177
- *
1178
- * Category: Database
1179
- *
1180
- * @param {*} database The range of values that makes up the list or database. A database is a list of related data in which rows of related information are records, and columns of data are fields. The first row of the list contains labels for each column.
1181
- * @param {*} field Indicates which column is used in the function. Enter the column label enclosed between double quotation marks, such as "Age" or "Yield," or a number (without quotation marks) that represents the position of the column within the list: 1 for the first column, 2 for the second column, and so on.
1182
- * @param {*} criteria The range of values that contains the conditions that you specify. You can use any range for the criteria argument, as long as it includes at least one column label and at least one value below the column label in which you specify a condition for the column.
1183
- * @returns
1184
- */
1185
- export function DGET(database: any, field: any, criteria: any): any;
1186
- /**
1187
- * Returns the discount rate for a security.
1188
- *
1189
- * Category: Financial
1190
- *
1191
- * @param {*} settlement The security's settlement date. The security settlement date is the date after the issue date when the security is traded to the buyer.
1192
- * @param {*} maturity The security's maturity date. The maturity date is the date when the security expires.
1193
- * @param {*} pr The security's price per $100 face value.
1194
- * @param {*} redemption The security's redemption value per $100 face value.
1195
- * @param {*} basis Optional. The type of day count basis to use.
1196
- * @returns
1197
- */
1198
- export function DISC(settlement: any, maturity: any, pr: any, redemption: any, basis: any): number | Error;
1199
- /**
1200
- * Returns the maximum value from selected database entries.
1201
- *
1202
- * Category: Database
1203
- *
1204
- * @param {*} database The range of values that makes up the list or database. A database is a list of related data in which rows of related information are records, and columns of data are fields. The first row of the list contains labels for each column.
1205
- * @param {*} field Indicates which column is used in the function. Enter the column label enclosed between double quotation marks, such as "Age" or "Yield," or a number (without quotation marks) that represents the position of the column within the list: 1 for the first column, 2 for the second column, and so on.
1206
- * @param {*} criteria The range of values that contains the conditions that you specify. You can use any range for the criteria argument, as long as it includes at least one column label and at least one value below the column label in which you specify a condition for the column.
1207
- * @returns
1208
- */
1209
- export function DMAX(database: any, field: any, criteria: any): any;
1210
- /**
1211
- * Returns the minimum value from selected database entries.
1212
- *
1213
- * Category: Database
1214
- *
1215
- * @param {*} database The range of values that makes up the list or database. A database is a list of related data in which rows of related information are records, and columns of data are fields. The first row of the list contains labels for each column.
1216
- * @param {*} field Indicates which column is used in the function. Enter the column label enclosed between double quotation marks, such as "Age" or "Yield," or a number (without quotation marks) that represents the position of the column within the list: 1 for the first column, 2 for the second column, and so on.
1217
- * @param {*} criteria The range of values that contains the conditions that you specify. You can use any range for the criteria argument, as long as it includes at least one column label and at least one value below the column label in which you specify a condition for the column.
1218
- * @returns
1219
- */
1220
- export function DMIN(database: any, field: any, criteria: any): any;
1221
- /**
1222
- * Converts a number to text, using the $ (dollar) currency format.
1223
- *
1224
- * Category: Text
1225
- *
1226
- * @param {*} number A number, a reference to a value containing a number, or a formula that evaluates to a number.
1227
- * @param {*} decimals Optional. The number of digits to the right of the decimal point. If this is negative, the number is rounded to the left of the decimal point. If you omit decimals, it is assumed to be 2.
1228
- * @returns
1229
- */
1230
- export function DOLLAR(number: any, decimals?: any): any;
1231
- /**
1232
- * Converts a dollar price, expressed as a fraction, into a dollar price, expressed as a decimal number.
1233
- *
1234
- * Category: Financial
1235
- *
1236
- * @param {*} fractional_dollar A number expressed as an integer part and a fraction part, separated by a decimal symbol.
1237
- * @param {*} fraction The integer to use in the denominator of the fraction.
1238
- * @returns
1239
- */
1240
- export function DOLLARDE(fractional_dollar: any, fraction: any): number | Error;
1241
- /**
1242
- * Converts a dollar price, expressed as a decimal number, into a dollar price, expressed as a fraction.
1243
- *
1244
- * Category: Financial
1245
- *
1246
- * @param {*} decimal_dollar A decimal number.
1247
- * @param {*} fraction The integer to use in the denominator of a fraction.
1248
- * @returns
1249
- */
1250
- export function DOLLARFR(decimal_dollar: any, fraction: any): number | Error;
1251
- /**
1252
- * Multiplies the values in a particular field of records that match the criteria in a database.
1253
- *
1254
- * Category: Database
1255
- *
1256
- * @param {*} database The range of values that makes up the list or database. A database is a list of related data in which rows of related information are records, and columns of data are fields. The first row of the list contains labels for each column.
1257
- * @param {*} field Indicates which column is used in the function. Enter the column label enclosed between double quotation marks, such as "Age" or "Yield," or a number (without quotation marks) that represents the position of the column within the list: 1 for the first column, 2 for the second column, and so on.
1258
- * @param {*} criteria The range of values that contains the conditions that you specify. You can use any range for the criteria argument, as long as it includes at least one column label and at least one value below the column label in which you specify a condition for the column.
1259
- * @returns
1260
- */
1261
- export function DPRODUCT(database: any, field: any, criteria: any): number | Error;
1262
- /**
1263
- * Estimates the standard deviation based on a sample of selected database entries.
1264
- *
1265
- * Category: Database
1266
- *
1267
- * @param {*} database The range of values that makes up the list or database. A database is a list of related data in which rows of related information are records, and columns of data are fields. The first row of the list contains labels for each column.
1268
- * @param {*} field Indicates which column is used in the function. Enter the column label enclosed between double quotation marks, such as "Age" or "Yield," or a number (without quotation marks) that represents the position of the column within the list: 1 for the first column, 2 for the second column, and so on.
1269
- * @param {*} criteria The range of values that contains the conditions that you specify. You can use any range for the criteria argument, as long as it includes at least one column label and at least one value below the column label in which you specify a condition for the column.
1270
- * @returns
1271
- */
1272
- export function DSTDEV(database: any, field: any, criteria: any): number | Error;
1273
- /**
1274
- * Calculates the standard deviation based on the entire population of selected database entries.
1275
- *
1276
- * Category: Database
1277
- *
1278
- * @param {*} database The range of values that makes up the list or database. A database is a list of related data in which rows of related information are records, and columns of data are fields. The first row of the list contains labels for each column.
1279
- * @param {*} field Indicates which column is used in the function. Enter the column label enclosed between double quotation marks, such as "Age" or "Yield," or a number (without quotation marks) that represents the position of the column within the list: 1 for the first column, 2 for the second column, and so on.
1280
- * @param {*} criteria The range of values that contains the conditions that you specify. You can use any range for the criteria argument, as long as it includes at least one column label and at least one value below the column label in which you specify a condition for the column.
1281
- * @returns
1282
- */
1283
- export function DSTDEVP(database: any, field: any, criteria: any): number | Error;
1284
- /**
1285
- * Adds the numbers in the field column of records in the database that match the criteria.
1286
- *
1287
- * Category: Database
1288
- *
1289
- * @param {*} database The range of values that makes up the list or database. A database is a list of related data in which rows of related information are records, and columns of data are fields. The first row of the list contains labels for each column.
1290
- * @param {*} field Indicates which column is used in the function. Enter the column label enclosed between double quotation marks, such as "Age" or "Yield," or a number (without quotation marks) that represents the position of the column within the list: 1 for the first column, 2 for the second column, and so on.
1291
- * @param {*} criteria Is the range of values that contains the conditions that you specify. You can use any range for the criteria argument, as long as it includes at least one column label and at least one value below the column label in which you specify a condition for the column.
1292
- * @returns
1293
- */
1294
- export function DSUM(database: any, field: any, criteria: any): number | Error;
1295
- export function DUNE(...args: any[]): Promise<{
1296
- message: string;
1297
- functionName: any;
1298
- type: string;
1299
- apiKeyName?: undefined;
1300
- reason?: undefined;
1301
- } | {
1302
- message: string;
1303
- functionName: any;
1304
- type: string;
1305
- apiKeyName: any;
1306
- reason?: undefined;
1307
- } | {
1308
- message: string;
1309
- functionName: any;
1310
- type: string;
1311
- reason: any;
1312
- apiKeyName?: undefined;
1313
- } | {}[]>;
1314
- /**
1315
- * Estimates variance based on a sample from selected database entries.
1316
- *
1317
- * Category: Database
1318
- *
1319
- * @param {*} database The range of values that makes up the list or database. A database is a list of related data in which rows of related information are records, and columns of data are fields. The first row of the list contains labels for each column.
1320
- * @param {*} field Indicates which column is used in the function. Enter the column label enclosed between double quotation marks, such as "Age" or "Yield," or a number (without quotation marks) that represents the position of the column within the list: 1 for the first column, 2 for the second column, and so on.
1321
- * @param {*} criteria The range of values that contains the conditions that you specify. You can use any range for the criteria argument, as long as it includes at least one column label and at least one value below the column label in which you specify a condition for the column.
1322
- * @returns
1323
- */
1324
- export function DVAR(database: any, field: any, criteria: any): number | Error;
1325
- /**
1326
- * Calculates variance based on the entire population of selected database entries.
1327
- *
1328
- * Category: Database
1329
- *
1330
- * @param {*} database The range of values that makes up the list or database. A database is a list of related data in which rows of related information are records, and columns of data are fields. The first row of the list contains labels for each column.
1331
- * @param {*} field Indicates which column is used in the function. Enter the column label enclosed between double quotation marks, such as "Age" or "Yield," or a number (without quotation marks) that represents the position of the column within the list: 1 for the first column, 2 for the second column, and so on.
1332
- * @param {*} criteria The range of values that contains the conditions that you specify. You can use any range for the criteria argument, as long as it includes at least one column label and at least one value below the column label in which you specify a condition for the column.
1333
- * @returns
1334
- */
1335
- export function DVARP(database: any, field: any, criteria: any): number | Error;
1336
- /**
1337
- * Returns the serial number of the date that is the indicated number of months before or after the start date.
1338
- *
1339
- * Category: Date and time
1340
- *
1341
- * @param {*} start_date A date that represents the start date.
1342
- * @param {*} months The number of months before or after start_date. A positive value for months yields a future date; a negative value yields a past date.
1343
- * @returns
1344
- */
1345
- export function EDATE(start_date: any, months: any): any;
1346
- /**
1347
- * Returns the effective annual interest rate.
1348
- *
1349
- * Category: Financial
1350
- *
1351
- * @param {*} nominal_rate The nominal interest rate.
1352
- * @param {*} npery The number of compounding periods per year.
1353
- * @returns
1354
- */
1355
- export function EFFECT(nominal_rate: any, npery: any): number | Error;
1356
- export function EOA(...args: any[]): Promise<any>;
1357
- /**
1358
- * Returns the serial number of the last day of the month before or after a specified number of months.
1359
- *
1360
- * Category: Date and time
1361
- *
1362
- * @param {*} start_date A date that represents the starting date.
1363
- * @param {*} months The number of months before or after start_date. A positive value for months yields a future date; a negative value yields a past date.
1364
- * @returns
1365
- */
1366
- export function EOMONTH(start_date: any, months: any): number | Date | Error;
1367
- /**
1368
- * Returns the error function.
1369
- *
1370
- * Category: Engineering
1371
- *
1372
- * @param {*} lower_limit The lower bound for integrating ERF.
1373
- * @param {*} upper_limit Optional. The upper bound for integrating ERF. If omitted, ERF integrates between zero and lower_limit.
1374
- * @returns
1375
- */
1376
- export function ERF(lower_limit: any, upper_limit: any): any;
1377
- /**
1378
- * Returns the complementary error function.
1379
- *
1380
- * Category: Engineering
1381
- *
1382
- * @param {*} x The lower bound for integrating ERFC.
1383
- * @returns
1384
- */
1385
- export function ERFC(x: any): any;
1386
- export const ERFCPRECISE: any;
1387
- export const ERFPRECISE: any;
1388
- export namespace ERROR {
1389
- function TYPE(error_val: any): Error | 1 | 2 | 3 | 4 | 8 | 5 | 6 | 7;
1390
- }
1391
- export function ETHERSCAN(...args: any[]): Promise<any>;
1392
- /**
1393
- * Rounds a number up to the nearest even integer.
1394
- *
1395
- * Category: Math and trigonometry
1396
- *
1397
- * @param {*} number The value to round.
1398
- * @returns
1399
- */
1400
- export function EVEN(number: any): any;
1401
- /**
1402
- * Checks to see if two text values are identical.
1403
- *
1404
- * Category: Text
1405
- *
1406
- * @param {*} text1 The first text string.
1407
- * @param {*} text2 The second text string.
1408
- * @returns
1409
- */
1410
- export function EXACT(text1: any, text2: any, ...args: any[]): any;
1411
- /**
1412
- * Returns e raised to the power of a given number.
1413
- *
1414
- * Category: Math and trigonometry
1415
- *
1416
- * @param {*} number The exponent applied to the base e.
1417
- * @returns
1418
- */
1419
- export function EXP(number: any, ...args: any[]): any;
1420
- export namespace EXPON {
1421
- /**
1422
- * Returns the exponential distribution.
1423
- *
1424
- * Category: Statistical
1425
- *
1426
- * @param {*} x The value of the function.
1427
- * @param {*} lambda The parameter value.
1428
- * @param {*} cumulative A logical value that indicates which form of the exponential function to provide. If cumulative is TRUE, EXPON.DIST returns the cumulative distribution function; if FALSE, it returns the probability density function.
1429
- * @returns
1430
- */
1431
- function DIST(x: any, lambda: any, cumulative: any): any;
1432
- }
1433
- /**
1434
- * Returns the exponential distribution.
1435
- *
1436
- * Category: Statistical
1437
- *
1438
- * @param {*} x The value of the function.
1439
- * @param {*} lambda The parameter value.
1440
- * @param {*} cumulative A logical value that indicates which form of the exponential function to provide. If cumulative is TRUE, EXPON.DIST returns the cumulative distribution function; if FALSE, it returns the probability density function.
1441
- * @returns
1442
- */
1443
- export function EXPONDIST(x: any, lambda: any, cumulative: any): any;
1444
- export namespace F {
1445
- /**
1446
- * Returns the F probability distribution.
1447
- *
1448
- * Category: Statistical
1449
- *
1450
- * @param {*} x The value at which to evaluate the function.
1451
- * @param {*} deg_freedom1 The numerator degrees of freedom.
1452
- * @param {*} deg_freedom2 The denominator degrees of freedom.
1453
- * @param {*} cumulative A logical value that determines the form of the function. If cumulative is TRUE, F.DIST returns the cumulative distribution function; if FALSE, it returns the probability density function.
1454
- * @returns
1455
- */
1456
- function DIST(x: any, deg_freedom1: any, deg_freedom2: any, cumulative: any): any;
1457
- namespace DIST {
1458
- /**
1459
- * Returns the F probability distribution.
1460
- *
1461
- * Category: Statistical
1462
- *
1463
- * @param {*} x The value at which to evaluate the function.
1464
- * @param {*} deg_freedom1 The numerator degrees of freedom.
1465
- * @param {*} deg_freedom2 The denominator degrees of freedom.
1466
- * @returns
1467
- */
1468
- function RT(x: any, deg_freedom1: any, deg_freedom2: any, ...args: any[]): number | Error;
1469
- }
1470
- /**
1471
- * Returns the inverse of the F probability distribution.
1472
- *
1473
- * Category: Statistical
1474
- *
1475
- * @param {*} probability A probability associated with the F cumulative distribution.
1476
- * @param {*} deg_freedom1 The numerator degrees of freedom.
1477
- * @param {*} deg_freedom2 The denominator degrees of freedom.
1478
- * @returns
1479
- */
1480
- function INV(probability: any, deg_freedom1: any, deg_freedom2: any): any;
1481
- namespace INV {
1482
- /**
1483
- * Returns the inverse of the F probability distribution.
1484
- *
1485
- * Category: Statistical
1486
- *
1487
- * @param {*} probability A probability associated with the F cumulative distribution.
1488
- * @param {*} deg_freedom1 The numerator degrees of freedom.
1489
- * @param {*} deg_freedom2 The denominator degrees of freedom.
1490
- * @returns
1491
- */
1492
- function RT(probability: any, deg_freedom1: any, deg_freedom2: any, ...args: any[]): any;
1493
- }
1494
- /**
1495
- * Returns the result of an F-test.
1496
- *
1497
- * Category: Statistical
1498
- *
1499
- * @param {*} array1 The first array or range of data.
1500
- * @param {*} array2 The second array or range of data.
1501
- * @returns
1502
- */
1503
- function TEST(array1: any, array2: any): number | Error;
1504
- }
1505
- /**
1506
- * Returns the factorial of a number.
1507
- *
1508
- * Category: Math and trigonometry
1509
- *
1510
- * @param {*} number The nonnegative number for which you want the factorial. If number is not an integer, it is truncated.
1511
- * @returns
1512
- */
1513
- export function FACT(number: any): any;
1514
- /**
1515
- * Returns the double factorial of a number.
1516
- *
1517
- * Category: Math and trigonometry
1518
- *
1519
- * @param {*} number The value for which to return the double factorial. If number is not an integer, it is truncated.
1520
- * @returns
1521
- */
1522
- export function FACTDOUBLE(number: any): any;
1523
- /**
1524
- * Returns the logical value FALSE.
1525
- *
1526
- * Category: Logical
1527
- *
1528
- * @returns
1529
- */
1530
- export function FALSE(): boolean;
1531
- export function FARCASTER(...args: any[]): Promise<{
1532
- message: string;
1533
- functionName: any;
1534
- type: string;
1535
- apiKeyName?: undefined;
1536
- reason?: undefined;
1537
- } | {
1538
- message: string;
1539
- functionName: any;
1540
- type: string;
1541
- apiKeyName: any;
1542
- reason?: undefined;
1543
- } | {
1544
- message: string;
1545
- functionName: any;
1546
- type: string;
1547
- reason: any;
1548
- apiKeyName?: undefined;
1549
- } | {
1550
- platform: string;
1551
- }[]>;
1552
- /**
1553
- * Returns the F probability distribution.
1554
- *
1555
- * Category: Statistical
1556
- *
1557
- * @param {*} x The value at which to evaluate the function.
1558
- * @param {*} deg_freedom1 The numerator degrees of freedom.
1559
- * @param {*} deg_freedom2 The denominator degrees of freedom.
1560
- * @param {*} cumulative A logical value that determines the form of the function. If cumulative is TRUE, F.DIST returns the cumulative distribution function; if FALSE, it returns the probability density function.
1561
- * @returns
1562
- */
1563
- export function FDIST(x: any, deg_freedom1: any, deg_freedom2: any, cumulative: any): any;
1564
- export namespace FDIST { }
1565
- /**
1566
- * Returns the F probability distribution.
1567
- *
1568
- * Category: Statistical
1569
- *
1570
- * @param {*} x The value at which to evaluate the function.
1571
- * @param {*} deg_freedom1 The numerator degrees of freedom.
1572
- * @param {*} deg_freedom2 The denominator degrees of freedom.
1573
- * @returns
1574
- */
1575
- export function FDISTRT(x: any, deg_freedom1: any, deg_freedom2: any, ...args: any[]): number | Error;
1576
- /**
1577
- * Locate one text string within a second text string, and return the number of the starting position of the first text string from the first character of the second text string.
1578
- *
1579
- * Category: Text
1580
- *
1581
- * @param {*} find_text The text you want to find.
1582
- * @param {*} within_text The text containing the text you want to find.
1583
- * @param {*} start_num Optional. Specifies the character at which to start the search. The first character in within_text is character number 1. If you omit start_num, it is assumed to be 1.
1584
- * @returns
1585
- */
1586
- export function FIND(find_text: any, within_text: any, start_num: any, ...args: any[]): any;
1587
- /**
1588
- * Returns the inverse of the F probability distribution.
1589
- *
1590
- * Category: Statistical
1591
- *
1592
- * @param {*} probability A probability associated with the F cumulative distribution.
1593
- * @param {*} deg_freedom1 The numerator degrees of freedom.
1594
- * @param {*} deg_freedom2 The denominator degrees of freedom.
1595
- * @returns
1596
- */
1597
- export function FINV(probability: any, deg_freedom1: any, deg_freedom2: any): any;
1598
- export namespace FINV { }
1599
- /**
1600
- * Returns the inverse of the F probability distribution.
1601
- *
1602
- * Category: Statistical
1603
- *
1604
- * @param {*} probability A probability associated with the F cumulative distribution.
1605
- * @param {*} deg_freedom1 The numerator degrees of freedom.
1606
- * @param {*} deg_freedom2 The denominator degrees of freedom.
1607
- * @returns
1608
- */
1609
- export function FINVRT(probability: any, deg_freedom1: any, deg_freedom2: any, ...args: any[]): any;
1610
- export function FIREFLY(...args: any[]): Promise<{
1611
- message: string;
1612
- functionName: any;
1613
- type: string;
1614
- apiKeyName?: undefined;
1615
- reason?: undefined;
1616
- } | {
1617
- message: string;
1618
- functionName: any;
1619
- type: string;
1620
- apiKeyName: any;
1621
- reason?: undefined;
1622
- } | {
1623
- message: string;
1624
- functionName: any;
1625
- type: string;
1626
- reason: any;
1627
- apiKeyName?: undefined;
1628
- } | {
1629
- platform: any;
1630
- }[]>;
1631
- /**
1632
- * Returns the Fisher transformation.
1633
- *
1634
- * Category: Statistical
1635
- *
1636
- * @param {*} x A numeric value for which you want the transformation.
1637
- * @returns
1638
- */
1639
- export function FISHER(x: any): number | Error;
1640
- /**
1641
- * Returns the inverse of the Fisher transformation.
1642
- *
1643
- * Category: Statistical
1644
- *
1645
- * @param {*} y The value for which you want to perform the inverse of the transformation.
1646
- * @returns
1647
- */
1648
- export function FISHERINV(y: any): number | Error;
1649
- /**
1650
- * Formats a number as text with a fixed number of decimals.
1651
- *
1652
- * Category: Text
1653
- *
1654
- * @param {*} number The number you want to round and convert to text.
1655
- * @param {*} decimals Optional. The number of digits to the right of the decimal point.
1656
- * @param {*} no_commas Optional. A logical value that, if TRUE, prevents FIXED from including commas in the returned text.
1657
- * @returns
1658
- */
1659
- export function FIXED(number: any, decimals?: any, no_commas?: any): any;
1660
- /**
1661
- * Rounds a number down, toward zero.
1662
- *
1663
- * Category: Math and trigonometry
1664
- *
1665
- * @param {*} number The numeric value you want to round.
1666
- * @param {*} significance The multiple to which you want to round.
1667
- * @returns
1668
- */
1669
- export function FLOOR(number: any, significance: any): any;
1670
- export namespace FLOOR {
1671
- /**
1672
- * Rounds a number down, to the nearest integer or to the nearest multiple of significance.
1673
- *
1674
- * Category: Math and trigonometry
1675
- *
1676
- * @param {*} number The number to be rounded down.
1677
- * @param {*} significance Optional. The multiple to which you want to round.
1678
- * @param {*} mode Optional. The direction (toward or away from 0) to round negative numbers.
1679
- * @returns
1680
- */
1681
- function MATH(number: any, significance?: any, mode?: any): any;
1682
- /**
1683
- * Rounds a number the nearest integer or to the nearest multiple of significance. Regardless of the sign of the number, the number is rounded up.
1684
- *
1685
- * Category: Math and trigonometry
1686
- *
1687
- * @param {*} number The value to be rounded.
1688
- * @param {*} significance Optional. The multiple to which number is to be rounded. If significance is omitted, its default value is 1.
1689
- * @returns
1690
- */
1691
- function PRECISE(number: any, significance: any): any;
1692
- }
1693
- /**
1694
- * Rounds a number down, to the nearest integer or to the nearest multiple of significance.
1695
- *
1696
- * Category: Math and trigonometry
1697
- *
1698
- * @param {*} number The number to be rounded down.
1699
- * @param {*} significance Optional. The multiple to which you want to round.
1700
- * @param {*} mode Optional. The direction (toward or away from 0) to round negative numbers.
1701
- * @returns
1702
- */
1703
- export function FLOORMATH(number: any, significance?: any, mode?: any): any;
1704
- /**
1705
- * Rounds a number the nearest integer or to the nearest multiple of significance. Regardless of the sign of the number, the number is rounded up.
1706
- *
1707
- * Category: Math and trigonometry
1708
- *
1709
- * @param {*} number The value to be rounded.
1710
- * @param {*} significance Optional. The multiple to which number is to be rounded. If significance is omitted, its default value is 1.
1711
- * @returns
1712
- */
1713
- export function FLOORPRECISE(number: any, significance: any): any;
1714
- export function FLVURL(): Promise<any>;
1715
- /**
1716
- * Returns a value along a linear trend.
1717
- *
1718
- * Category: Statistical
1719
- *
1720
- * @param {*} x The data point for which you want to predict a value.
1721
- * @param {*} known_ys The dependent array or range of data.
1722
- * @param {*} known_xs The independent array or range of data.
1723
- * @returns
1724
- */
1725
- export function FORECAST(x: any, known_ys: any, known_xs: any): number | Error;
1726
- /**
1727
- * Returns a frequency distribution as a vertical array.
1728
- *
1729
- * Category: Statistical
1730
- *
1731
- * @param {*} data_array An array of or reference to a set of values for which you want to count frequencies. If data_array contains no values, FREQUENCY returns an array of zeros.
1732
- * @param {*} bins_array An array of or reference to intervals into which you want to group the values in data_array. If bins_array contains no values, FREQUENCY returns the number of elements in data_array.
1733
- * @returns
1734
- */
1735
- export function FREQUENCY(data_array: any, bins_array: any): number[] | Error;
1736
- /**
1737
- * Returns the result of an F-test.
1738
- *
1739
- * Category: Statistical
1740
- *
1741
- * @param {*} array1 The first array or range of data.
1742
- * @param {*} array2 The second array or range of data.
1743
- * @returns
1744
- */
1745
- export function FTEST(array1: any, array2: any): number | Error;
1746
- /**
1747
- * Returns the future value of an investment.
1748
- *
1749
- * Category: Financial
1750
- *
1751
- * @param {*} rate The interest rate per period.
1752
- * @param {*} nper The total number of payment periods in an annuity.
1753
- * @param {*} pmt The payment made each period; it cannot change over the life of the annuity. Typically, pmt contains principal and interest but no other fees or taxes. If pmt is omitted, you must include the pv argument.
1754
- * @param {*} pv Optional. The present value, or the lump-sum amount that a series of future payments is worth right now. If pv is omitted, it is assumed to be 0 (zero), and you must include the pmt argument.
1755
- * @param {*} type Optional. The number 0 or 1 and indicates when payments are due. If type is omitted, it is assumed to be 0.
1756
- * @returns
1757
- */
1758
- export function FV(rate: any, nper: any, payment: any, value$1: any, type: any): number | Error;
1759
- /**
1760
- * Returns the future value of an initial principal after applying a series of compound interest rates.
1761
- *
1762
- * Category: Financial
1763
- *
1764
- * @param {*} principal The present value.
1765
- * @param {*} schedule An array of interest rates to apply.
1766
- * @returns
1767
- */
1768
- export function FVSCHEDULE(principal: any, schedule: any): any;
1769
- /**
1770
- * Returns the Gamma function value.
1771
- *
1772
- * Category: Statistical
1773
- *
1774
- * @param {*} number Returns a number.
1775
- * @returns
1776
- */
1777
- export function GAMMA(number: any): any;
1778
- export namespace GAMMA {
1779
- /**
1780
- * Returns the gamma distribution.
1781
- *
1782
- * Category: Statistical
1783
- *
1784
- * @param {*} x The value at which you want to evaluate the distribution.
1785
- * @param {*} alpha A parameter to the distribution.
1786
- * @param {*} beta A parameter to the distribution. If beta = 1, GAMMA.DIST returns the standard gamma distribution.
1787
- * @param {*} cumulative A logical value that determines the form of the function. If cumulative is TRUE, GAMMA.DIST returns the cumulative distribution function; if FALSE, it returns the probability density function.
1788
- * @returns
1789
- */
1790
- function DIST(value$1: any, alpha: any, beta: any, cumulative: any, ...args: any[]): any;
1791
- /**
1792
- * Returns the inverse of the gamma cumulative distribution.
1793
- *
1794
- * Category: Statistical
1795
- *
1796
- * @param {*} probability The probability associated with the gamma distribution.
1797
- * @param {*} alpha A parameter to the distribution.
1798
- * @param {*} beta A parameter to the distribution. If beta = 1, GAMMA.INV returns the standard gamma distribution.
1799
- * @returns
1800
- */
1801
- function INV(probability: any, alpha: any, beta: any, ...args: any[]): any;
1802
- }
1803
- /**
1804
- * Returns the gamma distribution.
1805
- *
1806
- * Category: Statistical
1807
- *
1808
- * @param {*} x The value at which you want to evaluate the distribution.
1809
- * @param {*} alpha A parameter to the distribution.
1810
- * @param {*} beta A parameter to the distribution. If beta = 1, GAMMA.DIST returns the standard gamma distribution.
1811
- * @param {*} cumulative A logical value that determines the form of the function. If cumulative is TRUE, GAMMA.DIST returns the cumulative distribution function; if FALSE, it returns the probability density function.
1812
- * @returns
1813
- */
1814
- export function GAMMADIST(value$1: any, alpha: any, beta: any, cumulative: any, ...args: any[]): any;
1815
- /**
1816
- * Returns the inverse of the gamma cumulative distribution.
1817
- *
1818
- * Category: Statistical
1819
- *
1820
- * @param {*} probability The probability associated with the gamma distribution.
1821
- * @param {*} alpha A parameter to the distribution.
1822
- * @param {*} beta A parameter to the distribution. If beta = 1, GAMMA.INV returns the standard gamma distribution.
1823
- * @returns
1824
- */
1825
- export function GAMMAINV(probability: any, alpha: any, beta: any, ...args: any[]): any;
1826
- /**
1827
- * Returns the natural logarithm of the gamma function, Γ(x).
1828
- *
1829
- * Category: Statistical
1830
- *
1831
- * @param {*} x The value for which you want to calculate GAMMALN.
1832
- * @returns
1833
- */
1834
- export function GAMMALN(x: any): any;
1835
- export namespace GAMMALN {
1836
- /**
1837
- * Returns the natural logarithm of the gamma function, Γ(x).
1838
- *
1839
- * Category: Statistical
1840
- *
1841
- * @param {*} x The value for which you want to calculate GAMMALN.PRECISE.
1842
- * @returns
1843
- */
1844
- function PRECISE(x: any, ...args: any[]): any;
1845
- }
1846
- /**
1847
- * Returns the natural logarithm of the gamma function, Γ(x).
1848
- *
1849
- * Category: Statistical
1850
- *
1851
- * @param {*} x The value for which you want to calculate GAMMALN.PRECISE.
1852
- * @returns
1853
- */
1854
- export function GAMMALNPRECISE(x: any, ...args: any[]): any;
1855
- /**
1856
- * Returns 0.5 less than the standard normal cumulative distribution.
1857
- *
1858
- * Category: Statistical
1859
- *
1860
- * @param {*} z Returns a number.
1861
- * @returns
1862
- */
1863
- export function GAUSS(z: any): number | Error;
1864
- /**
1865
- * Returns the greatest common divisor.
1866
- *
1867
- * Category: Math and trigonometry
1868
- *
1869
- * @param {*} args number1, number2, ... Number1 is required, subsequent numbers are optional. 1 to 255 values. If any value is not an integer, it is truncated.
1870
- * @returns
1871
- */
1872
- export function GCD(...args: any[]): any;
1873
- /**
1874
- * Returns the geometric mean.
1875
- *
1876
- * Category: Statistical
1877
- *
1878
- * @param {*} args number1, number2, ... Number1 is required, subsequent numbers are optional. 1 to 255 arguments for which you want to calculate the mean. You can also use a single array or a reference to an array instead of arguments separated by commas.
1879
- * @returns
1880
- */
1881
- export function GEOMEAN(...args: any[]): any;
1882
- /**
1883
- * Tests whether a number is greater than a threshold value.
1884
- *
1885
- * Category: Engineering
1886
- *
1887
- * @param {*} number The value to test against step.
1888
- * @param {*} step Optional. The threshold value. If you omit a value for step, GESTEP uses zero.
1889
- * @returns
1890
- */
1891
- export function GESTEP(number: any, step: any): any;
1892
- export function GNOSIS(...args: any[]): Promise<any>;
1893
- /**
1894
- * Returns values along an exponential trend.
1895
- *
1896
- * Category: Statistical
1897
- *
1898
- * @param {*} known_y The set of y-values you already know in the relationship y = b*m^x.
1899
- - If the array known_y's is in a single column, then each column of known_x's is interpreted as a separate variable.
1900
- - If the array known_y's is in a single row, then each row of known_x's is interpreted as a separate variable.
1901
- - If any of the numbers in known_y's is 0 or negative, GROWTH returns the #NUM! error value.
1902
- * @param {*} known_x Optional. An optional set of x-values that you may already know in the relationship y = b*m^x.
1903
- - The array known_x's can include one or more sets of variables. If only one variable is used, known_y's and known_x's can be ranges of any shape, as long as they have equal dimensions. If more than one variable is used, known_y's must be a vector (that is, a range with a height of one row or a width of one column).
1904
- - If known_x's is omitted, it is assumed to be the array {1,2,3,...} that is the same size as known_y's.
1905
- * @param {*} new_x Optional. Are new x-values for which you want GROWTH to return corresponding y-values.
1906
- - new_x's must include a column (or row) for each independent variable, just as known_x's does. So, if known_y's is in a single column, known_x's and new_x's must have the same number of columns. If known_y's is in a single row, known_x's and new_x's must have the same number of rows.
1907
- - If new_x's is omitted, it is assumed to be the same as known_x's.
1908
- - If both known_x's and new_x's are omitted, they are assumed to be the array {1,2,3,...} that is the same size as known_y's.
1909
- * @param {*} use_const Optional. A logical value specifying whether to force the constant b to equal 1. If const is TRUE or omitted, b is calculated normally. If const is FALSE, b is set equal to 1 and the m-values are adjusted so that y = m^x.
1910
- - If const is TRUE or omitted, b is calculated normally.
1911
- - If const is FALSE, b is set equal to 1 and the m-values are adjusted so that y = m^x.
1912
- * @returns
1913
- */
1914
- export function GROWTH(known_y: any, known_x: any, new_x: any, use_const: any): number[] | Error;
1915
- /**
1916
- * Returns the harmonic mean.
1917
- *
1918
- * Category: Statistical
1919
- *
1920
- * @param {*} args number1, number2, ... Number1 is required, subsequent numbers are optional. 1 to 255 arguments for which you want to calculate the mean. You can also use a single array or a reference to an array instead of arguments separated by commas.
1921
- * @returns
1922
- */
1923
- export function HARMEAN(...args: any[]): number | Error;
1924
- /**
1925
- * Converts a hexadecimal number to binary.
1926
- *
1927
- * Category: Engineering
1928
- *
1929
- * @param {*} number The hexadecimal number you want to convert. Number cannot contain more than 10 characters. The most significant bit of number is the sign bit (40th bit from the right). The remaining 9 bits are magnitude bits. Negative numbers are represented using two's-complement notation.
1930
- * @param {*} places Optional. The number of characters to use. If places is omitted, HEX2BIN uses the minimum number of characters necessary. Places is useful for padding the return value with leading 0s (zeros).
1931
- * @returns
1932
- */
1933
- export function HEX2BIN(number: any, places: any): string | Error;
1934
- /**
1935
- * Converts a hexadecimal number to decimal.
1936
- *
1937
- * Category: Engineering
1938
- *
1939
- * @param {*} number The hexadecimal number you want to convert. Number cannot contain more than 10 characters (40 bits). The most significant bit of number is the sign bit. The remaining 39 bits are magnitude bits. Negative numbers are represented using two's-complement notation.
1940
- * @returns
1941
- */
1942
- export function HEX2DEC(number: any): number | Error;
1943
- /**
1944
- * Converts a hexadecimal number to octal.
1945
- *
1946
- * Category: Engineering
1947
- *
1948
- * @param {*} number The hexadecimal number you want to convert. Number cannot contain more than 10 characters. The most significant bit of number is the sign bit. The remaining 39 bits are magnitude bits. Negative numbers are represented using two's-complement notation.
1949
- * @param {*} places Optional. The number of characters to use. If places is omitted, HEX2OCT uses the minimum number of characters necessary. Places is useful for padding the return value with leading 0s (zeros).
1950
- * @returns
1951
- */
1952
- export function HEX2OCT(number: any, places: any): string | Error;
1953
- /**
1954
- * Looks in the top row of an array and returns the value of the indicated value.
1955
- *
1956
- * Category: Lookup and reference
1957
- *
1958
- * @param {*} lookup_value The value to be found in the first row of the table. Lookup_value can be a value, a reference, or a text string.
1959
- * @param {*} table_array A table of information in which data is looked up. Use a reference to a range or a range name.
1960
- * @param {*} row_index_num The row number in table_array from which the matching value will be returned. A row_index_num of 1 returns the first row value in table_array, a row_index_num of 2 returns the second row value in table_array, and so on. If row_index_num is less than 1, HLOOKUP returns the #VALUE! error value; if row_index_num is greater than the number of rows on table_array, HLOOKUP returns the #REF! error value.
1961
- * @param {*} range_lookup Optional. A logical value that specifies whether you want HLOOKUP to find an exact match or an approximate match. If TRUE or omitted, an approximate match is returned. In other words, if an exact match is not found, the next largest value that is less than lookup_value is returned. If FALSE, HLOOKUP will find an exact match. If one is not found, the error value #N/A is returned.
1962
- * @returns
1963
- */
1964
- export function HLOOKUP(lookup_value: any, table_array: any, row_index_num: any, range_lookup: any): Error;
1965
- /**
1966
- * Converts a serial number to an hour.
1967
- *
1968
- * Category: Date and time
1969
- *
1970
- * @param {*} serial_number The time that contains the hour you want to find. Times may be entered as text strings within quotation marks (for example, "6:45 PM"), as decimal numbers (for example, 0.78125, which represents 6:45 PM), or as results of other formulas or functions (for example, TIMEVALUE("6:45 PM")).
1971
- * @returns
1972
- */
1973
- export function HOUR(serial_number: any): any;
1974
- export namespace HYPGEOM {
1975
- /**
1976
- * Returns the hypergeometric distribution.
1977
- *
1978
- * Category: Statistical
1979
- *
1980
- * @param {*} sample_s The number of successes in the sample.
1981
- * @param {*} number_sample The size of the sample.
1982
- * @param {*} population_s The number of successes in the population.
1983
- * @param {*} number_pop The population size.
1984
- * @param {*} cumulative A logical value that determines the form of the function. If cumulative is TRUE, then HYPGEOM.DIST returns the cumulative distribution function; if FALSE, it returns the probability mass function.
1985
- * @returns
1986
- */
1987
- function DIST(sample_s: any, number_sample: any, population_s: any, number_pop: any, cumulative: any): number | Error;
1988
- }
1989
- /**
1990
- * Returns the hypergeometric distribution.
1991
- *
1992
- * Category: Statistical
1993
- *
1994
- * @param {*} sample_s The number of successes in the sample.
1995
- * @param {*} number_sample The size of the sample.
1996
- * @param {*} population_s The number of successes in the population.
1997
- * @param {*} number_pop The population size.
1998
- * @param {*} cumulative A logical value that determines the form of the function. If cumulative is TRUE, then HYPGEOM.DIST returns the cumulative distribution function; if FALSE, it returns the probability mass function.
1999
- * @returns
2000
- */
2001
- export function HYPGEOMDIST(sample_s: any, number_sample: any, population_s: any, number_pop: any, cumulative: any): number | Error;
2002
- /**
2003
- * Specifies a logical test to perform.
2004
- *
2005
- * Category: Logical
2006
- *
2007
- * @param {*} logical_test
2008
- * @param {*} value_if_true
2009
- * @param {*} value_if_false
2010
- *
2011
- * @returns
2012
- */
2013
- export function IF(logical_test: any, value_if_true: any, value_if_false: any, ...args: any[]): any;
2014
- /**
2015
- * Returns a value you specify if a formula evaluates to an error; otherwise, returns the result of the formula.
2016
- *
2017
- * Category: Logical
2018
- *
2019
- * @param {*} value The argument that is checked for an error.
2020
- * @param {*} value_if_error The value to return if the formula evaluates to an error. The following error types are evaluated: #N/A, #VALUE!, #REF!, #DIV/0!, #NUM!, #NAME?, or #NULL!.
2021
- * @returns
2022
- */
2023
- export function IFERROR(value: any, value_if_error: any): any;
2024
- /**
2025
- * Returns the value you specify if the expression resolves to #N/A, otherwise returns the result of the expression.
2026
- *
2027
- * Category: Logical
2028
- *
2029
- * @returns
2030
- */
2031
- export function IFNA(value: any, value_if_na: any): any;
2032
- /**
2033
- * Checks whether one or more conditions are met and returns a value that corresponds to the first TRUE condition.
2034
- *
2035
- * Category: Logical
2036
- *
2037
- * @returns
2038
- */
2039
- export function IFS(...args: any[]): any;
2040
- /**
2041
- * Returns the absolute value (modulus) of a complex number.
2042
- *
2043
- * Category: Engineering
2044
- *
2045
- * @param {*} inumber A complex number for which you want the absolute value.
2046
- * @returns
2047
- */
2048
- export function IMABS(inumber: any): number | Error;
2049
- /**
2050
- * Returns the imaginary coefficient of a complex number.
2051
- *
2052
- * Category: Engineering
2053
- *
2054
- * @param {*} inumber A complex number for which you want the imaginary coefficient.
2055
- * @returns
2056
- */
2057
- export function IMAGINARY(inumber: any): any;
2058
- /**
2059
- * Returns the argument theta, an angle expressed in radians.
2060
- *
2061
- * Category: Engineering
2062
- *
2063
- * @param {*} inumber A complex number for which you want the argument .
2064
- * @returns
2065
- */
2066
- export function IMARGUMENT(inumber: any): number | Error;
2067
- /**
2068
- * Returns the complex conjugate of a complex number.
2069
- *
2070
- * Category: Engineering
2071
- *
2072
- * @param {*} inumber A complex number for which you want the conjugate.
2073
- * @returns
2074
- */
2075
- export function IMCONJUGATE(inumber: any): any;
2076
- /**
2077
- * Returns the cosine of a complex number.
2078
- *
2079
- * Category: Engineering
2080
- *
2081
- * @param {*} inumber A complex number for which you want the cosine.
2082
- * @returns
2083
- */
2084
- export function IMCOS(inumber: any): any;
2085
- /**
2086
- * Returns the hyperbolic cosine of a complex number.
2087
- *
2088
- * Category: Engineering
2089
- *
2090
- * @param {*} inumber A complex number for which you want the hyperbolic cosine.
2091
- * @returns
2092
- */
2093
- export function IMCOSH(inumber: any): any;
2094
- /**
2095
- * Returns the cotangent of a complex number.
2096
- *
2097
- * Category: Engineering
2098
- *
2099
- * @param {*} inumber A complex number for which you want the cotangent.
2100
- * @returns
2101
- */
2102
- export function IMCOT(inumber: any): any;
2103
- /**
2104
- * Returns the cosecant of a complex number.
2105
- *
2106
- * Category: Engineering
2107
- *
2108
- * @param {*} inumber A complex number for which you want the cosecant.
2109
- * @returns
2110
- */
2111
- export function IMCSC(inumber: any): any;
2112
- /**
2113
- * Returns the hyperbolic cosecant of a complex number.
2114
- *
2115
- * Category: Engineering
2116
- *
2117
- * @param {*} inumber A complex number for which you want the hyperbolic cosecant.
2118
- * @returns
2119
- */
2120
- export function IMCSCH(inumber: any): any;
2121
- /**
2122
- * Returns the quotient of two complex numbers.
2123
- *
2124
- * Category: Engineering
2125
- *
2126
- * @param {*} inumber1 The complex numerator or dividend.
2127
- * @param {*} inumber2 The complex denominator or divisor.
2128
- * @returns
2129
- */
2130
- export function IMDIV(inumber1: any, inumber2: any): any;
2131
- /**
2132
- * Returns the exponential of a complex number.
2133
- *
2134
- * Category: Engineering
2135
- *
2136
- * @param {*} inumber A complex number for which you want the exponential.
2137
- * @returns
2138
- */
2139
- export function IMEXP(inumber: any): any;
2140
- /**
2141
- * Returns the natural logarithm of a complex number.
2142
- *
2143
- * Category: Engineering
2144
- *
2145
- * @param {*} inumber A complex number for which you want the natural logarithm.
2146
- * @returns
2147
- */
2148
- export function IMLN(inumber: any): any;
2149
- /**
2150
- * Returns the base-10 logarithm of a complex number.
2151
- *
2152
- * Category: Engineering
2153
- *
2154
- * @param {*} inumber A complex number for which you want the common logarithm.
2155
- * @returns
2156
- */
2157
- export function IMLOG10(inumber: any): any;
2158
- /**
2159
- * Returns the base-2 logarithm of a complex number.
2160
- *
2161
- * Category: Engineering
2162
- *
2163
- * @param {*} inumber A complex number for which you want the base-2 logarithm.
2164
- * @returns
2165
- */
2166
- export function IMLOG2(inumber: any): any;
2167
- /**
2168
- * Returns a complex number raised to an integer power.
2169
- *
2170
- * Category: Engineering
2171
- *
2172
- * @param {*} inumber A complex number you want to raise to a power.
2173
- * @param {*} number The power to which you want to raise the complex number.
2174
- * @returns
2175
- */
2176
- export function IMPOWER(inumber: any, number: any): any;
2177
- /**
2178
- * Returns the product of complex numbers.
2179
- *
2180
- * Category: Engineering
2181
- *
2182
- * @param {*} args inumber1, [inumber2], … Inumber1 is required, subsequent inumbers are not. 1 to 255 complex numbers to multiply.
2183
- * @returns
2184
- */
2185
- export function IMPRODUCT(...args: any[]): any;
2186
- /**
2187
- * Returns the real coefficient of a complex number.
2188
- *
2189
- * Category: Engineering
2190
- *
2191
- * @param {*} inumber A complex number for which you want the real coefficient.
2192
- * @returns
2193
- */
2194
- export function IMREAL(inumber: any): any;
2195
- /**
2196
- * Returns the secant of a complex number.
2197
- *
2198
- * Category: Engineering
2199
- *
2200
- * @param {*} inumber A complex number for which you want the secant.
2201
- * @returns
2202
- */
2203
- export function IMSEC(inumber: any): any;
2204
- /**
2205
- * Returns the hyperbolic secant of a complex number.
2206
- *
2207
- * Category: Engineering
2208
- *
2209
- * @param {*} inumber A complex number for which you want the hyperbolic secant.
2210
- * @returns
2211
- */
2212
- export function IMSECH(inumber: any): any;
2213
- /**
2214
- * Returns the sine of a complex number.
2215
- *
2216
- * Category: Engineering
2217
- *
2218
- * @param {*} inumber A complex number for which you want the sine.
2219
- * @returns
2220
- */
2221
- export function IMSIN(inumber: any): any;
2222
- /**
2223
- * Returns the hyperbolic sine of a complex number.
2224
- *
2225
- * Category: Engineering
2226
- *
2227
- * @param {*} inumber A complex number for which you want the hyperbolic sine.
2228
- * @returns
2229
- */
2230
- export function IMSINH(inumber: any): any;
2231
- /**
2232
- * Returns the square root of a complex number.
2233
- *
2234
- * Category: Engineering
2235
- *
2236
- * @param {*} inumber A complex number for which you want the square root.
2237
- * @returns
2238
- */
2239
- export function IMSQRT(inumber: any): any;
2240
- /**
2241
- * Returns the difference between two complex numbers.
2242
- *
2243
- * Category: Engineering
2244
- *
2245
- * @param {*} inumber1 The complex number from which to subtract inumber2.
2246
- * @param {*} inumber2 The complex number to subtract from inumber1.
2247
- * @returns
2248
- */
2249
- export function IMSUB(inumber1: any, inumber2: any): any;
2250
- /**
2251
- * Returns the sum of complex numbers.
2252
- *
2253
- * Category: Engineering
2254
- *
2255
- * @param {*} args inumber1, [inumber2], ... Inumber1 is required, subsequent numbers are not. 1 to 255 complex numbers to add.
2256
- * @returns
2257
- */
2258
- export function IMSUM(...args: any[]): any;
2259
- /**
2260
- * Returns the tangent of a complex number.
2261
- *
2262
- * Category: Engineering
2263
- *
2264
- * @param {*} inumber A complex number for which you want the tangent.
2265
- * @returns
2266
- */
2267
- export function IMTAN(inumber: any): any;
2268
- /**
2269
- * Uses an index to choose a value from a reference or array.
2270
- *
2271
- * Category: Lookup and reference
2272
- *
2273
- * @param {*} array A range of values or an array constant.
2274
- - If array contains only one row or column, the corresponding row_num or column_num argument is optional.
2275
- - If array has more than one row and more than one column, and only row_num or column_num is used, INDEX returns an array of the entire row or column in array.
2276
- * @param {*} row_num Required, unless column_num is present. Selects the row in array from which to return a value. If row_num is omitted, column_num is required.
2277
- * @param {*} column_num Optional. Selects the column in array from which to return a value. If column_num is omitted, row_num is required.
2278
- * @returns
2279
- */
2280
- export function INDEX(array: any, row_num: any, column_num: any): any;
2281
- /**
2282
- * Rounds a number down to the nearest integer.
2283
- *
2284
- * Category: Math and trigonometry
2285
- *
2286
- * @param {*} number The real number you want to round down to an integer.
2287
- * @returns
2288
- */
2289
- export function INT(number: any): number | Error;
2290
- /**
2291
- * Returns the intercept of the linear regression line.
2292
- *
2293
- * Category: Statistical
2294
- *
2295
- * @param {*} known_y The dependent set of observations or data.
2296
- * @param {*} known_x The independent set of observations or data.
2297
- * @returns
2298
- */
2299
- export function INTERCEPT(known_y: any, known_x: any): number | Error;
2300
- /**
2301
- * Returns the interest payment for an investment for a given period.
2302
- *
2303
- * Category: Financial
2304
- *
2305
- * @param {*} rate The interest rate per period.
2306
- * @param {*} per The period for which you want to find the interest and must be in the range 1 to nper.
2307
- * @param {*} nper The total number of payment periods in an annuity.
2308
- * @param {*} pv The present value, or the lump-sum amount that a series of future payments is worth right now.
2309
- * @param {*} fv Optional. The future value, or a cash balance you want to attain after the last payment is made. If fv is omitted, it is assumed to be 0 (the future value of a loan, for example, is 0).
2310
- * @param {*} type Optional. The number 0 or 1 and indicates when payments are due. If type is omitted, it is assumed to be 0.
2311
- * @returns
2312
- */
2313
- export function IPMT(rate: any, per: any, nper: any, pv: any, fv: any, type: any): number | Error;
2314
- /**
2315
- * Returns the internal rate of return for a series of cash flows.
2316
- *
2317
- * Category: Financial
2318
- *
2319
- * @param {*} values An array or a reference to values that contain numbers for which you want to calculate the internal rate of return.
2320
- - Values must contain at least one positive value and one negative value to calculate the internal rate of return.
2321
- - IRR uses the order of values to interpret the order of cash flows. Be sure to enter your payment and income values in the sequence you want.
2322
- - If an array or reference argument contains text, logical values, or empty values, those values are ignored.
2323
- * @param {*} guess Optional. A number that you guess is close to the result of IRR.
2324
- - Microsoft Excel uses an iterative technique for calculating IRR. Starting with guess, IRR cycles through the calculation until the result is accurate within 0.00001 percent. If IRR can't find a result that works after 20 tries, the #NUM! error value is returned.
2325
- - In most cases you do not need to provide guess for the IRR calculation. If guess is omitted, it is assumed to be 0.1 (10 percent).
2326
- - If IRR gives the #NUM! error value, or if the result is not close to what you expected, try again with a different value for guess.
2327
- * @returns
2328
- */
2329
- export function IRR(values: any, guess: any): any;
2330
- /**
2331
- * Returns TRUE if the value is blank.
2332
- *
2333
- * Category: Information
2334
- *
2335
- * @param {*} value The value that you want tested. The value argument can be a blank (empty value), error, logical value, text, number, or reference value, or a name referring to any of these.
2336
- * @returns
2337
- */
2338
- export function ISBLANK(value: any): boolean;
2339
- export function ISDATE(value: any): boolean;
2340
- /**
2341
- * Returns TRUE if the value is any error value except #N/A.
2342
- *
2343
- * Category: Information
2344
- *
2345
- * @param {*} value The value that you want tested. The value argument can be a blank (empty value), error, logical value, text, number, or reference value, or a name referring to any of these.
2346
- * @returns
2347
- */
2348
- export function ISERR(value$1: any): boolean;
2349
- /**
2350
- * Returns TRUE if the value is any error value.
2351
- *
2352
- * Category: Information
2353
- *
2354
- * @param {*} value The value that you want tested. The value argument can be a blank (empty value), error, logical value, text, number, or reference value, or a name referring to any of these.
2355
- * @returns
2356
- */
2357
- export function ISERROR(value: any): boolean;
2358
- /**
2359
- * Returns TRUE if the number is even.
2360
- *
2361
- * Category: Information
2362
- *
2363
- * @param {*} number The value to test. If number is not an integer, it is truncated.
2364
- * @returns
2365
- */
2366
- export function ISEVEN(number: any): boolean;
2367
- /**
2368
- * Returns TRUE if the value is a logical value.
2369
- *
2370
- * Category: Information
2371
- *
2372
- * @param {*} value The value that you want tested. The value argument can be a blank (empty value), error, logical value, text, number, or reference value, or a name referring to any of these.
2373
- * @returns
2374
- */
2375
- export function ISLOGICAL(value: any): boolean;
2376
- /**
2377
- * Returns TRUE if the value is the #N/A error value.
2378
- *
2379
- * Category: Information
2380
- *
2381
- * @param {*} value The value that you want tested. The value argument can be a blank (empty value), error, logical value, text, number, or reference value, or a name referring to any of these.
2382
- * @returns
2383
- */
2384
- export function ISNA(value: any): boolean;
2385
- /**
2386
- * Returns TRUE if the value is not text.
2387
- *
2388
- * Category: Information
2389
- *
2390
- * @param {*} value The value that you want tested. The value argument can be a blank (empty value), error, logical value, text, number, or reference value, or a name referring to any of these.
2391
- * @returns
2392
- */
2393
- export function ISNONTEXT(value: any): boolean;
2394
- /**
2395
- * Returns TRUE if the value is a number.
2396
- *
2397
- * Category: Information
2398
- *
2399
- * @param {*} value The value that you want tested. The value argument can be a blank (empty value), error, logical value, text, number, or reference value, or a name referring to any of these.
2400
- * @returns
2401
- */
2402
- export function ISNUMBER(value: any): boolean;
2403
- export namespace ISO {
2404
- export { CEILING };
2405
- }
2406
- /**
2407
- * Returns TRUE if the number is odd.
2408
- *
2409
- * Category: Information
2410
- *
2411
- * @param {*} value The value that you want tested. The value argument can be a blank (empty value), error, logical value, text, number, or reference value, or a name referring to any of these.
2412
- * @returns
2413
- */
2414
- export function ISODD(value: any): boolean;
2415
- /**
2416
- * Returns the number of the ISO week number of the year for a given date.
2417
- *
2418
- * Category: Date and time
2419
- *
2420
- * @param {*} date Date is the date-time code used by Excel for date and time calculation.
2421
- * @returns
2422
- */
2423
- export function ISOWEEKNUM(date: any): number | Error;
2424
- /**
2425
- * Calculates the interest paid during a specific period of an investment.
2426
- *
2427
- * Category: Financial
2428
- *
2429
- * @param {*} rate The interest rate for the investment.
2430
- * @param {*} per The period for which you want to find the interest, and must be between 1 and Nper.
2431
- * @param {*} nper The total number of payment periods for the investment.
2432
- * @param {*} pv The present value of the investment. For a loan, Pv is the loan amount.
2433
- *
2434
- * @returns
2435
- */
2436
- export function ISPMT(rate: any, per: any, nper: any, pv: any): number | Error;
2437
- /**
2438
- * Returns TRUE if the value is text.
2439
- *
2440
- * Category: Information
2441
- *
2442
- * @param {*} value The value that you want tested. The value argument can be a blank (empty value), error, logical value, text, number, or reference value, or a name referring to any of these.
2443
- * @returns
2444
- */
2445
- export function ISTEXT(value: any): value is string;
2446
- /**
2447
- * Returns the kurtosis of a data set.
2448
- *
2449
- * Category: Statistical
2450
- *
2451
- * @param {*} args number1, number2, ... Number1 is required, subsequent numbers are optional. 1 to 255 arguments for which you want to calculate kurtosis. You can also use a single array or a reference to an array instead of arguments separated by commas.
2452
- * @returns
2453
- */
2454
- export function KURT(...args: any[]): number | Error;
2455
- /**
2456
- * Returns the k-th largest value in a data set.
2457
- *
2458
- * Category: Statistical
2459
- *
2460
- * @param {*} array The array or range of data for which you want to determine the k-th largest value.
2461
- * @param {*} k The position (from the largest) in the array or value range of data to return.
2462
- * @returns
2463
- */
2464
- export function LARGE(array: any, k: any): any;
2465
- /**
2466
- * Returns the least common multiple.
2467
- *
2468
- * Category: Math and trigonometry
2469
- *
2470
- * @param {*} args number1, number2,... Number1 is required, subsequent numbers are optional. 1 to 255 values for which you want the least common multiple. If value is not an integer, it is truncated.
2471
- * @returns
2472
- */
2473
- export function LCM(...args: any[]): number | Error;
2474
- /**
2475
- * Returns the leftmost characters from a text value.
2476
- *
2477
- * Category: Text
2478
- *
2479
- * @param {*} text The text string that contains the characters you want to extract.
2480
- * @param {*} num_chars Optional. Specifies the number of characters you want LEFT to extract.
2481
- * @returns
2482
- */
2483
- export function LEFT(text: any, num_chars: any): any;
2484
- /**
2485
- * Returns the number of characters in a text string
2486
- *
2487
- * Category: Text
2488
- *
2489
- * @param {*} text The text whose length you want to find. Spaces count as characters.
2490
- * @returns
2491
- */
2492
- export function LEN(text: any, ...args: any[]): any;
2493
- export function LENS(...args: any[]): Promise<{
2494
- message: string;
2495
- functionName: any;
2496
- type: string;
2497
- apiKeyName?: undefined;
2498
- reason?: undefined;
2499
- } | {
2500
- message: string;
2501
- functionName: any;
2502
- type: string;
2503
- apiKeyName: any;
2504
- reason?: undefined;
2505
- } | {
2506
- message: string;
2507
- functionName: any;
2508
- type: string;
2509
- reason: any;
2510
- apiKeyName?: undefined;
2511
- } | {
2512
- platform: string;
2513
- }[]>;
2514
- /**
2515
- * Returns the parameters of a linear trend.
2516
- *
2517
- * Category: Statistical
2518
- *
2519
- * @param {*} known_y The set of y-values that you already know in the relationship y = mx + b.
2520
- - If the range of known_y's is in a single column, each column of known_x's is interpreted as a separate variable.
2521
- - If the range of known_y's is contained in a single row, each row of known_x's is interpreted as a separate variable.
2522
- * @param {*} known_x Optional. A set of x-values that you may already know in the relationship y = mx + b.
2523
- - The range of known_x's can include one or more sets of variables. If only one variable is used, known_y's and known_x's can be ranges of any shape, as long as they have equal dimensions. If more than one variable is used, known_y's must be a vector (that is, a range with a height of one row or a width of one column).
2524
- - If known_x's is omitted, it is assumed to be the array {1,2,3,...} that is the same size as known_y's.
2525
- * @returns
2526
- */
2527
- export function LINEST(known_y: any, known_x: any): number[] | Error;
2528
- /**
2529
- * Returns the natural logarithm of a number.
2530
- *
2531
- * Category: Math and trigonometry
2532
- *
2533
- * @param {*} number The positive real number for which you want the natural logarithm.
2534
- * @returns
2535
- */
2536
- export function LN(number: any): number | Error;
2537
- /**
2538
- * Returns the logarithm of a number to a specified base.
2539
- *
2540
- * Category: Math and trigonometry
2541
- *
2542
- * @param {*} number The positive real number for which you want the logarithm.
2543
- * @param {*} base Optional. The base of the logarithm. If base is omitted, it is assumed to be 10.
2544
- * @returns
2545
- */
2546
- export function LOG(number: any, base: any): any;
2547
- /**
2548
- * Returns the base-10 logarithm of a number.
2549
- *
2550
- * Category: Math and trigonometry
2551
- *
2552
- * @param {*} number The positive real number for which you want the base-10 logarithm.
2553
- * @returns
2554
- */
2555
- export function LOG10(number: any): number | Error;
2556
- /**
2557
- * Returns the parameters of an exponential trend.
2558
- *
2559
- * Category: Statistical
2560
- *
2561
- * @param {*} known_y The set of y-values you already know in the relationship y = b*m^x.
2562
- - If the array known_y's is in a single column, then each column of known_x's is interpreted as a separate variable.
2563
- - If the array known_y's is in a single row, then each row of known_x's is interpreted as a separate variable.
2564
- * @param {*} known_x Optional. An optional set of x-values that you may already know in the relationship y = b*m^x.
2565
- - The array known_x's can include one or more sets of variables. If only one variable is used, known_y's and known_x's can be ranges of any shape, as long as they have equal dimensions. If more than one variable is used, known_y's must be a range of values with a height of one row or a width of one column (which is also known as a vector).
2566
- - If known_x's is omitted, it is assumed to be the array {1,2,3,...} that is the same size as known_y's.
2567
- * @returns
2568
- */
2569
- export function LOGEST(known_y: any, known_x: any): number[] | Error;
2570
- /**
2571
- * Returns the inverse of the lognormal cumulative distribution.
2572
- *
2573
- * Category: Statistical
2574
- *
2575
- * @param {*} probability A probability associated with the lognormal distribution.
2576
- * @param {*} mean The mean of ln(x).
2577
- * @param {*} standard_dev The standard deviation of ln(x).
2578
- * @returns
2579
- */
2580
- export function LOGINV(probability: any, mean: any, standard_dev: any): any;
2581
- export namespace LOGNORM {
2582
- /**
2583
- * Returns the cumulative lognormal distribution.
2584
- *
2585
- * Category: Statistical
2586
- *
2587
- * @param {*} x The value at which to evaluate the function.
2588
- * @param {*} mean The mean of ln(x).
2589
- * @param {*} standard_dev The standard deviation of ln(x).
2590
- * @param {*} cumulative A logical value that determines the form of the function. If cumulative is TRUE, LOGNORM.DIST returns the cumulative distribution function; if FALSE, it returns the probability density function.
2591
- * @returns
2592
- */
2593
- function DIST(x: any, mean: any, standard_dev: any, cumulative: any): any;
2594
- /**
2595
- * Returns the inverse of the lognormal cumulative distribution.
2596
- *
2597
- * Category: Statistical
2598
- *
2599
- * @param {*} probability A probability associated with the lognormal distribution.
2600
- * @param {*} mean The mean of ln(x).
2601
- * @param {*} standard_dev The standard deviation of ln(x).
2602
- * @returns
2603
- */
2604
- function INV(probability: any, mean: any, standard_dev: any): any;
2605
- }
2606
- /**
2607
- * Returns the cumulative lognormal distribution.
2608
- *
2609
- * Category: Statistical
2610
- *
2611
- * @param {*} x The value at which to evaluate the function.
2612
- * @param {*} mean The mean of ln(x).
2613
- * @param {*} standard_dev The standard deviation of ln(x).
2614
- * @param {*} cumulative A logical value that determines the form of the function. If cumulative is TRUE, LOGNORM.DIST returns the cumulative distribution function; if FALSE, it returns the probability density function.
2615
- * @returns
2616
- */
2617
- export function LOGNORMDIST(x: any, mean: any, standard_dev: any, cumulative: any): any;
2618
- /**
2619
- * Returns the inverse of the lognormal cumulative distribution.
2620
- *
2621
- * Category: Statistical
2622
- *
2623
- * @param {*} probability A probability associated with the lognormal distribution.
2624
- * @param {*} mean The mean of ln(x).
2625
- * @param {*} standard_dev The standard deviation of ln(x).
2626
- * @returns
2627
- */
2628
- export function LOGNORMINV(probability: any, mean: any, standard_dev: any): any;
2629
- /**
2630
- * Looks up values in a vector or array.
2631
- *
2632
- * Category: Lookup and reference
2633
- *
2634
- * @param {*} lookup_value A value that LOOKUP searches for in an array. The lookup_value argument can be a number, text, a logical value, or a name or reference that refers to a value.
2635
- - If LOOKUP can't find the value of lookup_value, it uses the largest value in the array that is less than or equal to lookup_value.
2636
- - If the value of lookup_value is smaller than the smallest value in the first row or column (depending on the array dimensions), LOOKUP returns the #N/A error value.
2637
- * @param {*} array A range of values that contains text, numbers, or logical values that you want to compare with lookup_value. The array form of LOOKUP is very similar to the HLOOKUP and VLOOKUP functions. The difference is that HLOOKUP searches for the value of lookup_value in the first row, VLOOKUP searches in the first column, and LOOKUP searches according to the dimensions of array.
2638
- * @param {*} result_array Optional. A range that contains only one row or column. The result_array argument must be the same size as lookup_value. It has to be the same size.
2639
- * @returns
2640
- */
2641
- export function LOOKUP(lookup_value: any, array: any, result_array: any): any;
2642
- /**
2643
- * Converts text to lowercase.
2644
- *
2645
- * Category: Text
2646
- *
2647
- * @param {*} text The text you want to convert to lowercase. LOWER does not change characters in text that are not letters.
2648
- * @returns
2649
- */
2650
- export function LOWER(text: any, ...args: any[]): any;
2651
- /**
2652
- * Looks up values in a reference or array.
2653
- *
2654
- * Category: Lookup and reference
2655
- *
2656
- * @param {*} lookup_value The value that you want to match in lookup_array. For example, when you look up someone's number in a telephone book, you are using the person's name as the lookup value, but the telephone number is the value you want.The lookup_value argument can be a value (number, text, or logical value) or a value reference to a number, text, or logical value.
2657
- * @param {*} lookup_array The range of values being searched.
2658
- * @param {*} match_type Optional. The number -1, 0, or 1. The match_type argument specifies how Excel matches lookup_value with values in lookup_array. The default value for this argument is 1.
2659
- * @returns
2660
- */
2661
- export function MATCH(lookup_value: any, lookup_array: any, match_type: any, ...args: any[]): number | Error;
2662
- /**
2663
- * Returns the maximum value in a list of arguments.
2664
- *
2665
- * Category: Statistical
2666
- *
2667
- * @param {*} args number1, number2, ... Number1 is required, subsequent numbers are optional. 1 to 255 numbers for which you want to find the maximum value.
2668
- * @returns
2669
- */
2670
- export function MAX(...args: any[]): any;
2671
- /**
2672
- * Returns the maximum value in a list of arguments, including numbers, text, and logical values.
2673
- *
2674
- * Category: Statistical
2675
- *
2676
- * @param {*} args value1, value2,... Number arguments 2 to 255 for which you want to find the largest value.
2677
- * @returns
2678
- */
2679
- export function MAXA(...args: any[]): any;
2680
- /**
2681
- * Returns the maximum of all values in a range that meet multiple criteria.
2682
- *
2683
- * Category: Statistical
2684
- *
2685
- * @returns
2686
- */
2687
- export function MAXIFS(...args: any[]): any;
2688
- /**
2689
- * Returns the median of the given numbers.
2690
- *
2691
- * Category: Statistical
2692
- *
2693
- * @param {*} args number1, number2, ... Number1 is required, subsequent numbers are optional. 1 to 255 numbers for which you want the median.
2694
- * @returns
2695
- */
2696
- export function MEDIAN(...args: any[]): any;
2697
- export function MEERKAT(): string;
2698
- /**
2699
- * Returns a specific number of characters from a text string starting at the position you specify
2700
- *
2701
- * Category: Text
2702
- *
2703
- * @param {*} text The text string containing the characters you want to extract.
2704
- * @param {*} start_num The position of the first character you want to extract in text. The first character in text has start_num 1, and so on.
2705
- * @param {*} num_chars Specifies the number of characters you want MID to return from text.
2706
- * @returns
2707
- */
2708
- export function MID(text: any, start_num: any, num_chars: any): any;
2709
- /**
2710
- * Returns the minimum value in a list of arguments.
2711
- *
2712
- * Category: Statistical
2713
- *
2714
- * @param {*} args number1, number2, ... Number1 is optional, subsequent numbers are optional. 1 to 255 numbers for which you want to find the minimum value.
2715
- * @returns
2716
- */
2717
- export function MIN(...args: any[]): any;
2718
- /**
2719
- * Returns the smallest value in a list of arguments, including numbers, text, and logical values.
2720
- *
2721
- * Category: Statistical
2722
- *
2723
- * @param {*} args value1, value2, ... Value1 is required, subsequent values are optional. 1 to 255 values for which you want to find the smallest value.
2724
- * @returns
2725
- */
2726
- export function MINA(...args: any[]): any;
2727
- /**
2728
- * Returns the minimum of all values in a range that meet multiple criteria.
2729
- *
2730
- * Category: Statistical
2731
- *
2732
- * @returns
2733
- */
2734
- export function MINIFS(...args: any[]): any;
2735
- declare function MINUS$1(...args: any[]): any;
2736
- /**
2737
- * Converts a serial number to a minute.
2738
- *
2739
- * Category: Date and time
2740
- *
2741
- * @param {*} serial_number The time that contains the minute you want to find. Times may be entered as text strings within quotation marks (for example, "6:45 PM"), as decimal numbers (for example, 0.78125, which represents 6:45 PM), or as results of other formulas or functions (for example, TIMEVALUE("6:45 PM")).
2742
- * @returns
2743
- */
2744
- export function MINUTE(serial_number: any): any;
2745
- /**
2746
- * Returns the internal rate of return where positive and negative cash flows are financed at different rates.
2747
- *
2748
- * Category: Financial
2749
- *
2750
- * @param {*} values An array or a reference to values that contain numbers. These numbers represent a series of payments (negative values) and income (positive values) occurring at regular periods.
2751
- - Values must contain at least one positive value and one negative value to calculate the modified internal rate of return. Otherwise, MIRR returns the #DIV/0! error value.
2752
- - If an array or reference argument contains text, logical values, or empty values, those values are ignored; however, values with the value zero are included.
2753
- * @param {*} finance_rate The interest rate you pay on the money used in the cash flows.
2754
- * @param {*} reinvest_rate The interest rate you receive on the cash flows as you reinvest them.
2755
- * @returns
2756
- */
2757
- export function MIRR(values: any, finance_rate: any, reinvest_rate: any): number | Error;
2758
- /**
2759
- * Returns the matrix product of two arrays. The result is an array with the same number of rows as array1 and the same number of columns as array2.
2760
- *
2761
- * Category: Math and trigonometry
2762
- *
2763
- * @param {*} array1 Required. 1st array you want to multiply.
2764
- * @param {*} array2 Required. 2nd array you want to multiply.
2765
- * @returns
2766
- */
2767
- export function MMULT(array1: any, array2: any): Error | any[][];
2768
- /**
2769
- * Returns the remainder from division.
2770
- *
2771
- * Category: Math and trigonometry
2772
- *
2773
- * @param {*} number The number for which you want to find the remainder.
2774
- * @param {*} divisor The number by which you want to divide number.
2775
- * @returns
2776
- */
2777
- export function MOD(number: any, divisor: any): any;
2778
- export namespace MODE {
2779
- /**
2780
- * Returns a vertical array of the most frequently occurring, or repetitive values in an array or range of data.
2781
- *
2782
- * Category: Statistical
2783
- *
2784
- * @param {*} args number1, number2, ... Number arguments 2 to 254 for which you want to calculate the mode. You can also use a single array or a reference to an array instead of arguments separated by commas.
2785
- * @returns
2786
- */
2787
- function MULT(...args: any[]): any[] | Error;
2788
- /**
2789
- * Returns the most common value in a data set.
2790
- *
2791
- * Category: Statistical
2792
- *
2793
- * @param {*} args number1, number2, ... Arguments 2 to 254 for which you want to calculate the mode. You can also use a single array or a reference to an array instead of arguments separated by commas.
2794
- * @returns
2795
- */
2796
- function SNGL(...args: any[]): any;
2797
- }
2798
- /**
2799
- * Returns a vertical array of the most frequently occurring, or repetitive values in an array or range of data.
2800
- *
2801
- * Category: Statistical
2802
- *
2803
- * @param {*} args number1, number2, ... Number arguments 2 to 254 for which you want to calculate the mode. You can also use a single array or a reference to an array instead of arguments separated by commas.
2804
- * @returns
2805
- */
2806
- export function MODEMULT(...args: any[]): any[] | Error;
2807
- /**
2808
- * Returns the most common value in a data set.
2809
- *
2810
- * Category: Statistical
2811
- *
2812
- * @param {*} args number1, number2, ... Arguments 2 to 254 for which you want to calculate the mode. You can also use a single array or a reference to an array instead of arguments separated by commas.
2813
- * @returns
2814
- */
2815
- export function MODESNGL(...args: any[]): any;
2816
- /**
2817
- * Converts a serial number to a month.
2818
- *
2819
- * Category: Date and time
2820
- *
2821
- * @param {*} serial_number The date of the month you are trying to find.
2822
- * @returns
2823
- */
2824
- export function MONTH(serial_number: any): any;
2825
- /**
2826
- * Returns a number rounded to the desired multiple.
2827
- *
2828
- * Category: Math and trigonometry
2829
- *
2830
- * @param {*} number The value to round.
2831
- * @param {*} multiple The multiple to which you want to round number.
2832
- * @returns
2833
- */
2834
- export function MROUND(number: any, multiple: any): any;
2835
- /**
2836
- * Returns the multinomial of a set of numbers.
2837
- *
2838
- * Category: Math and trigonometry
2839
- *
2840
- * @param {*} args number1, number2, ... Number1 is required, subsequent numbers are optional. 1 to 255 values for which you want the multinomial.
2841
- * @returns
2842
- */
2843
- export function MULTINOMIAL(...args: any[]): number | Error;
2844
- /**
2845
- * Returns the unit matrix for the specified dimension.
2846
- *
2847
- * Category: Math and trigonometry
2848
- *
2849
- * @param {*} dimension Required. Dimension is an integer specifying the dimension of the unit matrix that you want to return. It returns an array. The dimension has to be greater than zero.
2850
- * @returns
2851
- */
2852
- export function MUNIT(dimension: any, ...args: any[]): Error | any[][];
2853
- export function MYANIMELIST(): string;
2854
- /**
2855
- * Returns a value converted to a number.
2856
- *
2857
- * Category: Information
2858
- *
2859
- * @param {*} value The value you want converted. N converts values listed in the following table.
2860
- * @returns
2861
- */
2862
- export function N(value: any): any;
2863
- /**
2864
- * Returns the error value #N/A.
2865
- *
2866
- * Category: Information
2867
- *
2868
- * @returns
2869
- */
2870
- export function NA(): Error;
2871
- export namespace NEGBINOM {
2872
- /**
2873
- * Returns the negative binomial distribution.
2874
- *
2875
- * Category: Statistical
2876
- *
2877
- * @param {*} number_f The number of failures.
2878
- * @param {*} number_s The threshold number of successes.
2879
- * @param {*} probability_s The probability of a success.
2880
- * @param {*} cumulative A logical value that determines the form of the function. If cumulative is TRUE, NEGBINOM.DIST returns the cumulative distribution function; if FALSE, it returns the probability density function.
2881
- * @returns
2882
- */
2883
- function DIST(number_f: any, number_s: any, probability_s: any, cumulative: any): any;
2884
- }
2885
- /**
2886
- * Returns the negative binomial distribution.
2887
- *
2888
- * Category: Statistical
2889
- *
2890
- * @param {*} number_f The number of failures.
2891
- * @param {*} number_s The threshold number of successes.
2892
- * @param {*} probability_s The probability of a success.
2893
- * @param {*} cumulative A logical value that determines the form of the function. If cumulative is TRUE, NEGBINOM.DIST returns the cumulative distribution function; if FALSE, it returns the probability density function.
2894
- * @returns
2895
- */
2896
- export function NEGBINOMDIST(number_f: any, number_s: any, probability_s: any, cumulative: any): any;
2897
- /**
2898
- * Returns the number of whole workdays between two dates.
2899
- *
2900
- * Category: Date and time
2901
- *
2902
- * @param {*} start_date A date that represents the start date.
2903
- * @param {*} end_date A date that represents the end date.
2904
- * @param {*} holidays Optional. An optional range of one or more dates to exclude from the working calendar, such as state and federal holidays and floating holidays. The list can be either a range of values that contains the dates or an array constant of the serial numbers that represent the dates.
2905
- * @returns
2906
- */
2907
- export function NETWORKDAYS(start_date: any, end_date: any, holidays: any): number | Error;
2908
- export namespace NETWORKDAYS {
2909
- /**
2910
- * Returns the number of whole workdays between two dates using parameters to indicate which and how many days are weekend days.
2911
- *
2912
- * Category: Date and time
2913
- *
2914
- * @param {*} start_date The date for from which the difference is to be computed. The start_date can be earlier than, the same as, or later than the end_date.
2915
- * @param {*} end_date The date for to which the difference is to be computed.
2916
- * @param {*} weekend Optional. Indicates the days of the week that are weekend days and are not included in the number of whole working days between start_date and end_date. Weekend is a weekend number or string that specifies when weekends occur. Weekend number values indicate the following weekend days:
2917
- * @param {*} holidays Optional. An optional set of one or more dates that are to be excluded from the working day calendar. holidays shall be a range of values that contain the dates, or an array constant of the serial values that represent those dates. The ordering of dates or serial values in holidays can be arbitrary.
2918
- * @returns
2919
- */
2920
- function INTL(start_date: any, end_date: any, weekend: any, holidays: any): number | Error;
2921
- }
2922
- /**
2923
- * Returns the number of whole workdays between two dates using parameters to indicate which and how many days are weekend days.
2924
- *
2925
- * Category: Date and time
2926
- *
2927
- * @param {*} start_date The date for from which the difference is to be computed. The start_date can be earlier than, the same as, or later than the end_date.
2928
- * @param {*} end_date The date for to which the difference is to be computed.
2929
- * @param {*} weekend Optional. Indicates the days of the week that are weekend days and are not included in the number of whole working days between start_date and end_date. Weekend is a weekend number or string that specifies when weekends occur. Weekend number values indicate the following weekend days:
2930
- * @param {*} holidays Optional. An optional set of one or more dates that are to be excluded from the working day calendar. holidays shall be a range of values that contain the dates, or an array constant of the serial values that represent those dates. The ordering of dates or serial values in holidays can be arbitrary.
2931
- * @returns
2932
- */
2933
- export function NETWORKDAYSINTL(start_date: any, end_date: any, weekend: any, holidays: any): number | Error;
2934
- /**
2935
- * Returns the number of whole workdays between two dates using parameters to indicate which and how many days are weekend days.
2936
- *
2937
- * Category: Date and time
2938
- *
2939
- * @param {*} start_date The date for from which the difference is to be computed. The start_date can be earlier than, the same as, or later than the end_date.
2940
- * @param {*} end_date The date for to which the difference is to be computed.
2941
- * @param {*} weekend Optional. Indicates the days of the week that are weekend days and are not included in the number of whole working days between start_date and end_date. Weekend is a weekend number or string that specifies when weekends occur. Weekend number values indicate the following weekend days:
2942
- * @param {*} holidays Optional. An optional set of one or more dates that are to be excluded from the working day calendar. holidays shall be a range of values that contain the dates, or an array constant of the serial values that represent those dates. The ordering of dates or serial values in holidays can be arbitrary.
2943
- * @returns
2944
- */
2945
- export function NETWORKDAYS_INTL(start_date: any, end_date: any, weekend: any, holidays: any): number | Error;
2946
- export function NEYNAR(...args: any[]): Promise<any>;
2947
- /**
2948
- * Returns the annual nominal interest rate.
2949
- *
2950
- * Category: Financial
2951
- *
2952
- * @param {*} effect_rate The effective interest rate.
2953
- * @param {*} npery The number of compounding periods per year.
2954
- * @returns
2955
- */
2956
- export function NOMINAL(effect_rate: any, npery: any): number | Error;
2957
- export namespace NORM {
2958
- /**
2959
- * Returns the normal cumulative distribution.
2960
- *
2961
- * Category: Statistical
2962
- *
2963
- * @param {*} x The value for which you want the distribution.
2964
- * @param {*} mean The arithmetic mean of the distribution.
2965
- * @param {*} standard_dev The standard deviation of the distribution.
2966
- * @param {*} cumulative A logical value that determines the form of the function. If cumulative is TRUE, NORM.DIST returns the cumulative distribution function; if FALSE, it returns the probability density function.
2967
- * @returns
2968
- */
2969
- function DIST(x: any, mean: any, standard_dev: any, cumulative: any): any;
2970
- /**
2971
- * Returns the inverse of the normal cumulative distribution.
2972
- *
2973
- * Category: Statistical
2974
- *
2975
- * @param {*} probability A probability corresponding to the normal distribution.
2976
- * @param {*} mean The arithmetic mean of the distribution.
2977
- * @param {*} standard_dev The standard deviation of the distribution.
2978
- * @returns
2979
- */
2980
- function INV(probability: any, mean: any, standard_dev: any): any;
2981
- namespace S {
2982
- /**
2983
- * Returns the standard normal cumulative distribution.
2984
- *
2985
- * Category: Statistical
2986
- *
2987
- * @param {*} z The value for which you want the distribution.
2988
- * @param {*} cumulative Cumulative is a logical value that determines the form of the function. If cumulative is TRUE, NORMS.DIST returns the cumulative distribution function; if FALSE, it returns the probability mass function.
2989
- * @returns
2990
- */
2991
- function DIST(z: any, cumulative: any): any;
2992
- /**
2993
- * Returns the inverse of the standard normal cumulative distribution.
2994
- *
2995
- * Category: Statistical
2996
- *
2997
- * @param {*} probability A probability corresponding to the normal distribution.
2998
- * @returns
2999
- */
3000
- function INV(probability: any): any;
3001
- }
3002
- }
3003
- /**
3004
- * Returns the normal cumulative distribution.
3005
- *
3006
- * Category: Statistical
3007
- *
3008
- * @param {*} x The value for which you want the distribution.
3009
- * @param {*} mean The arithmetic mean of the distribution.
3010
- * @param {*} standard_dev The standard deviation of the distribution.
3011
- * @param {*} cumulative A logical value that determines the form of the function. If cumulative is TRUE, NORM.DIST returns the cumulative distribution function; if FALSE, it returns the probability density function.
3012
- * @returns
3013
- */
3014
- export function NORMDIST(x: any, mean: any, standard_dev: any, cumulative: any): any;
3015
- /**
3016
- * Returns the inverse of the normal cumulative distribution.
3017
- *
3018
- * Category: Statistical
3019
- *
3020
- * @param {*} probability A probability corresponding to the normal distribution.
3021
- * @param {*} mean The arithmetic mean of the distribution.
3022
- * @param {*} standard_dev The standard deviation of the distribution.
3023
- * @returns
3024
- */
3025
- export function NORMINV(probability: any, mean: any, standard_dev: any): any;
3026
- /**
3027
- * Returns the standard normal cumulative distribution.
3028
- *
3029
- * Category: Statistical
3030
- *
3031
- * @param {*} z The value for which you want the distribution.
3032
- * @param {*} cumulative Cumulative is a logical value that determines the form of the function. If cumulative is TRUE, NORMS.DIST returns the cumulative distribution function; if FALSE, it returns the probability mass function.
3033
- * @returns
3034
- */
3035
- export function NORMSDIST(z: any, cumulative: any): any;
3036
- /**
3037
- * Returns the inverse of the standard normal cumulative distribution.
3038
- *
3039
- * Category: Statistical
3040
- *
3041
- * @param {*} probability A probability corresponding to the normal distribution.
3042
- * @returns
3043
- */
3044
- export function NORMSINV(probability: any): any;
3045
- /**
3046
- * Reverses the logic of its argument.
3047
- *
3048
- * Category: Logical
3049
- *
3050
- * @returns
3051
- */
3052
- export function NOT(logical: any): boolean | Error;
3053
- /**
3054
- * Returns the serial number of the current date and time.
3055
- *
3056
- * Category: Date and time
3057
- *
3058
- * @returns
3059
- */
3060
- export function NOW(): number | Date;
3061
- /**
3062
- * Returns the number of periods for an investment.
3063
- *
3064
- * Category: Financial
3065
- *
3066
- * @param {*} rate The interest rate per period.
3067
- * @param {*} pmt The payment made each period; it cannot change over the life of the annuity. Typically, pmt contains principal and interest but no other fees or taxes.
3068
- * @param {*} pv The present value, or the lump-sum amount that a series of future payments is worth right now.
3069
- * @param {*} fv Optional. The future value, or a cash balance you want to attain after the last payment is made. If fv is omitted, it is assumed to be 0 (the future value of a loan, for example, is 0).
3070
- * @param {*} type Optional. The number 0 or 1 and indicates when payments are due.
3071
- * @returns
3072
- */
3073
- export function NPER(rate: any, pmt: any, pv: any, fv: any, type: any): number | Error;
3074
- /**
3075
- * Returns the net present value of an investment based on a series of periodic cash flows and a discount rate.
3076
- *
3077
- * Category: Financial
3078
- *
3079
- * @param {*} rate The rate of discount over the length of one period.
3080
- * @param {*} args value1, value2, ... Value1 is required, subsequent values are optional. 1 to 254 arguments representing the payments and income.
3081
- - value1, value2, ... must be equally spaced in time and occur at the end of each period.
3082
- - NPV uses the order of value1, value2, ... to interpret the order of cash flows. Be sure to enter your payment and income values in the correct sequence.
3083
- - Arguments that are empty values, logical values, or text representations of numbers, error values, or text that cannot be translated into numbers are ignored.
3084
- - If an argument is an array or reference, only numbers in that array or reference are counted. Empty values, logical values, text, or error values in the array or reference are ignored.
3085
- * @returns
3086
- */
3087
- export function NPV(...args: any[]): number | Error;
3088
- /**
3089
- * Converts text to number in a locale-independent manner.
3090
- *
3091
- * Category: Text
3092
- *
3093
- * @param {*} text The text to convert to a number.
3094
- * @param {*} decimal_separator Optional. The character used to separate the integer and fractional part of the result.
3095
- * @param {*} group_separator Optional. The character used to separate groupings of numbers, such as thousands from hundreds and millions from thousands.
3096
- * @returns
3097
- */
3098
- export function NUMBERVALUE(text: any, decimal_separator: any, group_separator: any): number | Error;
3099
- /**
3100
- * Converts an octal number to binary.
3101
- *
3102
- * Category: Engineering
3103
- *
3104
- * @param {*} number The octal number you want to convert. Number may not contain more than 10 characters. The most significant bit of number is the sign bit. The remaining 29 bits are magnitude bits. Negative numbers are represented using two's-complement notation.
3105
- * @param {*} places Optional. The number of characters to use. If places is omitted, OCT2BIN uses the minimum number of characters necessary. Places is useful for padding the return value with leading 0s (zeros).
3106
- * @returns
3107
- */
3108
- export function OCT2BIN(number: any, places: any): string | Error;
3109
- /**
3110
- * Converts an octal number to decimal.
3111
- *
3112
- * Category: Engineering
3113
- *
3114
- * @param {*} number The octal number you want to convert. Number may not contain more than 10 octal characters (30 bits). The most significant bit of number is the sign bit. The remaining 29 bits are magnitude bits. Negative numbers are represented using two's-complement notation.
3115
- * @returns
3116
- */
3117
- export function OCT2DEC(number: any): number | Error;
3118
- /**
3119
- * Converts an octal number to hexadecimal.
3120
- *
3121
- * Category: Engineering
3122
- *
3123
- * @param {*} number The octal number you want to convert. Number may not contain more than 10 octal characters (30 bits). The most significant bit of number is the sign bit. The remaining 29 bits are magnitude bits. Negative numbers are represented using two's-complement notation.
3124
- * @param {*} places Optional. The number of characters to use. If places is omitted, OCT2HEX uses the minimum number of characters necessary. Places is useful for padding the return value with leading 0s (zeros).
3125
- * @returns
3126
- */
3127
- export function OCT2HEX(number: any, places: any): string | Error;
3128
- /**
3129
- * Rounds a number up to the nearest odd integer.
3130
- *
3131
- * Category: Math and trigonometry
3132
- *
3133
- * @param {*} number: The value to round.
3134
- * @returns
3135
- */
3136
- export function ODD(number: any): number | Error;
3137
- /**
3138
- * Returns TRUE if any argument is TRUE.
3139
- *
3140
- * Category: Logical
3141
- *
3142
- * @returns
3143
- */
3144
- export function OR(...args: any[]): any;
3145
- /**
3146
- * Returns the number of periods required by an investment to reach a specified value.
3147
- *
3148
- * Category: Financial
3149
- *
3150
- * @param {*} rate Rate is the interest rate per period.
3151
- * @param {*} pv Pv is the present value of the investment.
3152
- * @param {*} fv Fv is the desired future value of the investment.
3153
- * @returns
3154
- */
3155
- export function PDURATION(rate: any, pv: any, fv: any): number | Error;
3156
- /**
3157
- * Returns the Pearson product moment correlation coefficient.
3158
- *
3159
- * Category: Statistical
3160
- *
3161
- * @param {*} array1 A set of independent values.
3162
- * @param {*} array2 A set of dependent values.
3163
- * @returns
3164
- */
3165
- export function PEARSON(array1: any, array2: any): number | Error;
3166
- export namespace PERCENTILE {
3167
- /**
3168
- * Returns the k-th percentile of values in a range, where k is in the range 0..1, exclusive.
3169
- *
3170
- * Category: Statistical
3171
- *
3172
- * @returns
3173
- */
3174
- function EXC(array: any, k: any): number | Error;
3175
- /**
3176
- * Returns the k-th percentile of values in a range.
3177
- *
3178
- * Category: Statistical
3179
- *
3180
- * @param {*} array The array or range of data that defines relative standing.
3181
- * @param {*} k The percentile value in the range 0..1, inclusive.
3182
- * @returns
3183
- */
3184
- function INC(array: any, k: any): number | Error;
3185
- }
3186
- /**
3187
- * Returns the k-th percentile of values in a range, where k is in the range 0..1, exclusive.
3188
- *
3189
- * Category: Statistical
3190
- *
3191
- * @returns
3192
- */
3193
- export function PERCENTILEEXC(array: any, k: any): number | Error;
3194
- /**
3195
- * Returns the k-th percentile of values in a range.
3196
- *
3197
- * Category: Statistical
3198
- *
3199
- * @param {*} array The array or range of data that defines relative standing.
3200
- * @param {*} k The percentile value in the range 0..1, inclusive.
3201
- * @returns
3202
- */
3203
- export function PERCENTILEINC(array: any, k: any): number | Error;
3204
- export namespace PERCENTRANK {
3205
- /**
3206
- * Returns the rank of a value in a data set as a percentage (0..1, exclusive) of the data set.
3207
- *
3208
- * Category: Statistical
3209
- *
3210
- * @param {*} array The array or range of data with numeric values that defines relative standing
3211
- * @param {*} x The value for which you want to know the rank.
3212
- * @param {*} significance Optional. A value that identifies the number of significant digits for the returned percentage value. If omitted, PERCENTRANK.EXC uses three digits (0.xxx).
3213
- * @returns
3214
- */
3215
- function EXC(array: any, x: any, significance: any): number | Error;
3216
- /**
3217
- * Returns the percentage rank of a value in a data set.
3218
- *
3219
- * Category: Statistical
3220
- *
3221
- * @param {*} array The array or range of data with numeric values that defines relative standing.
3222
- * @param {*} x The value for which you want to know the rank.
3223
- * @param {*} significance Optional. A value that identifies the number of significant digits for the returned percentage value. If omitted, PERCENTRANK.INC uses three digits (0.xxx).
3224
- * @returns
3225
- */
3226
- function INC(array: any, x: any, significance: any): number | Error;
3227
- }
3228
- /**
3229
- * Returns the rank of a value in a data set as a percentage (0..1, exclusive) of the data set.
3230
- *
3231
- * Category: Statistical
3232
- *
3233
- * @param {*} array The array or range of data with numeric values that defines relative standing
3234
- * @param {*} x The value for which you want to know the rank.
3235
- * @param {*} significance Optional. A value that identifies the number of significant digits for the returned percentage value. If omitted, PERCENTRANK.EXC uses three digits (0.xxx).
3236
- * @returns
3237
- */
3238
- export function PERCENTRANKEXC(array: any, x: any, significance: any): number | Error;
3239
- /**
3240
- * Returns the percentage rank of a value in a data set.
3241
- *
3242
- * Category: Statistical
3243
- *
3244
- * @param {*} array The array or range of data with numeric values that defines relative standing.
3245
- * @param {*} x The value for which you want to know the rank.
3246
- * @param {*} significance Optional. A value that identifies the number of significant digits for the returned percentage value. If omitted, PERCENTRANK.INC uses three digits (0.xxx).
3247
- * @returns
3248
- */
3249
- export function PERCENTRANKINC(array: any, x: any, significance: any): number | Error;
3250
- /**
3251
- * Returns the number of permutations for a given number of objects.
3252
- *
3253
- * Category: Statistical
3254
- *
3255
- * @param {*} number An integer that describes the number of objects.
3256
- * @param {*} number_chosen An integer that describes the number of objects in each permutation.
3257
- * @returns
3258
- */
3259
- export function PERMUT(number: any, number_chosen: any): number | Error;
3260
- /**
3261
- * Returns the number of permutations for a given number of objects (with repetitions) that can be selected from the total objects.
3262
- *
3263
- * Category: Statistical
3264
- *
3265
- * @param {*} number An integer that describes the total number of objects.
3266
- * @param {*} number_chosen An integer that describes the number of objects in each permutation.
3267
- * @returns
3268
- */
3269
- export function PERMUTATIONA(number: any, number_chosen: any): number | Error;
3270
- /**
3271
- * Returns the value of the density function for a standard normal distribution.
3272
- *
3273
- * Category: Statistical
3274
- *
3275
- * @param {*} x X is the number for which you want the density of the standard normal distribution.
3276
- * @returns
3277
- */
3278
- export function PHI(x: any): number | Error;
3279
- /**
3280
- * Returns the value of pi.
3281
- *
3282
- * Category: Math and trigonometry
3283
- *
3284
- * @returns
3285
- */
3286
- export function PI(): number;
3287
- /**
3288
- * Returns the periodic payment for an annuity.
3289
- *
3290
- * Category: Financial
3291
- *
3292
- * @param {*} rate The interest rate for the loan.
3293
- * @param {*} nper The total number of payments for the loan.
3294
- * @param {*} pv The present value, or the total amount that a series of future payments is worth now; also known as the principal.
3295
- * @param {*} fv Optional. The future value, or a cash balance you want to attain after the last payment is made. If fv is omitted, it is assumed to be 0 (zero), that is, the future value of a loan is 0.
3296
- * @param {*} type Optional. The number 0 (zero) or 1 and indicates when payments are due.
3297
- * @returns
3298
- */
3299
- export function PMT(rate: any, nper: any, pv: any, fv: any, type: any): number | Error;
3300
- export function PNL(...args: any[]): number;
3301
- export namespace POISSON {
3302
- /**
3303
- * Returns the Poisson distribution.
3304
- *
3305
- * Category: Statistical
3306
- *
3307
- * @param {*} x The number of events.
3308
- * @param {*} mean The expected numeric value.
3309
- * @param {*} cumulative A logical value that determines the form of the probability distribution returned. If cumulative is TRUE, POISSON.DIST returns the cumulative Poisson probability that the number of random events occurring will be between zero and x inclusive; if FALSE, it returns the Poisson probability mass function that the number of events occurring will be exactly x.
3310
- * @returns
3311
- */
3312
- function DIST(x: any, mean: any, cumulative: any): any;
3313
- }
3314
- /**
3315
- * Returns the Poisson distribution.
3316
- *
3317
- * Category: Statistical
3318
- *
3319
- * @param {*} x The number of events.
3320
- * @param {*} mean The expected numeric value.
3321
- * @param {*} cumulative A logical value that determines the form of the probability distribution returned. If cumulative is TRUE, POISSON.DIST returns the cumulative Poisson probability that the number of random events occurring will be between zero and x inclusive; if FALSE, it returns the Poisson probability mass function that the number of events occurring will be exactly x.
3322
- * @returns
3323
- */
3324
- export function POISSONDIST(x: any, mean: any, cumulative: any): any;
3325
- export function POLYMARKET(): string;
3326
- /**
3327
- * Returns the result of a number raised to a power.
3328
- *
3329
- * Category: Math and trigonometry
3330
- *
3331
- * @param {*} number The base number. It can be any real number.
3332
- * @param {*} power The exponent to which the base number is raised.
3333
- * @returns
3334
- */
3335
- export function POWER(number: any, power: any): any;
3336
- /**
3337
- * Returns the payment on the principal for an investment for a given period.
3338
- *
3339
- * Category: Financial
3340
- *
3341
- * @param {*} rate The interest rate per period.
3342
- * @param {*} per Specifies the period and must be in the range 1 to nper.
3343
- * @param {*} nper The total number of payment periods in an annuity.
3344
- * @param {*} pv The present value — the total amount that a series of future payments is worth now.
3345
- * @param {*} fv Optional. The future value, or a cash balance you want to attain after the last payment is made. If fv is omitted, it is assumed to be 0 (zero), that is, the future value of a loan is 0.
3346
- * @param {*} type Optional. The number 0 or 1 and indicates when payments are due.
3347
- * @returns
3348
- */
3349
- export function PPMT(rate: any, per: any, nper: any, pv: any, fv: any, type: any): number | Error;
3350
- export function PRICE(...args: any[]): Promise<any>;
3351
- /**
3352
- * Returns the price per $100 face value of a discounted security.
3353
- *
3354
- * Category: Financial
3355
- *
3356
- * @param {*} settlement The security's settlement date. The security settlement date is the date after the issue date when the security is traded to the buyer.
3357
- * @param {*} maturity The security's maturity date. The maturity date is the date when the security expires.
3358
- * @param {*} discount The security's discount rate.
3359
- * @param {*} redemption The security's redemption value per $100 face value.
3360
- * @param {*} basis Optional. The type of day count basis to use.
3361
- * @returns
3362
- */
3363
- export function PRICEDISC(settlement: any, maturity: any, discount: any, redemption: any, basis: any): number | Error;
3364
- export function PRIVACYPOOL(): string;
3365
- /**
3366
- * Returns the probability that values in a range are between two limits.
3367
- *
3368
- * Category: Statistical
3369
- *
3370
- * @param {*} x_range The range of numeric values of x with which there are associated probabilities.
3371
- * @param {*} prob_range A set of probabilities associated with values in x_range.
3372
- * @param {*} lower_limit Optional. The lower bound on the value for which you want a probability.
3373
- * @param {*} upper_limit Optional. The optional upper bound on the value for which you want a probability.
3374
- * @returns
3375
- */
3376
- export function PROB(x_range: any, prob_range: any, lower_limit: any, upper_limit: any): any;
3377
- /**
3378
- * Multiplies its arguments.
3379
- *
3380
- * Category: Math and trigonometry
3381
- *
3382
- * @param {*} number1 The first number or range that you want to multiply.
3383
- * @param {*} args number2, ... Optional. Additional numbers or ranges that you want to multiply, up to a maximum of 255 arguments.
3384
- * @returns
3385
- */
3386
- export function PRODUCT(...args: any[]): number | Error;
3387
- /**
3388
- * Capitalizes the first letter in each word of a text value.
3389
- *
3390
- * Category: Text
3391
- *
3392
- * @param {*} text Text enclosed in quotation marks, a formula that returns text, or a reference to a value containing the text you want to partially capitalize.
3393
- * @returns
3394
- */
3395
- export function PROPER(text: any): any;
3396
- /**
3397
- * Returns the present value of an investment.
3398
- *
3399
- * Category: Financial
3400
- *
3401
- * @param {*} rate The interest rate per period. For example, if you obtain an automobile loan at a 10 percent annual interest rate and make monthly payments, your interest rate per month is 10%/12, or 0.83%. You would enter 10%/12, or 0.83%, or 0.0083, into the formula as the rate.
3402
- * @param {*} nper The total number of payment periods in an annuity. For example, if you get a four-year car loan and make monthly payments, your loan has 4*12 (or 48) periods. You would enter 48 into the formula for nper.
3403
- * @param {*} pmt The payment made each period and cannot change over the life of the annuity. Typically, pmt includes principal and interest but no other fees or taxes. For example, the monthly payments on a $10,000, four-year car loan at 12 percent are $263.33. You would enter -263.33 into the formula as the pmt. If pmt is omitted, you must include the fv argument.
3404
- * @param {*} fv Optional. The future value, or a cash balance you want to attain after the last payment is made. If fv is omitted, it is assumed to be 0 (the future value of a loan, for example, is 0). For example, if you want to save $50,000 to pay for a special project in 18 years, then $50,000 is the future value. You could then make a conservative guess at an interest rate and determine how much you must save each month. If fv is omitted, you must include the pmt argument.
3405
- * @param {*} type Optional. The number 0 or 1 and indicates when payments are due.
3406
- * @returns
3407
- */
3408
- export function PV(rate: any, per: any, pmt: any, fv: any, type: any): number | Error;
3409
- export namespace QUARTILE {
3410
- /**
3411
- * Returns the quartile of the data set, based on percentile values from 0..1, exclusive.
3412
- *
3413
- * Category: Statistical
3414
- *
3415
- * @param {*} array The array or value range of numeric values for which you want the quartile value.
3416
- * @param {*} quart Indicates which value to return.
3417
- * @returns
3418
- */
3419
- function EXC(range: any, quart: any): number | Error;
3420
- /**
3421
- * Returns the quartile of a data set.
3422
- *
3423
- * Category: Statistical
3424
- *
3425
- * @param {*} array The array or value range of numeric values for which you want the quartile value.
3426
- * @param {*} quart Indicates which value to return.
3427
- * @returns
3428
- */
3429
- function INC(range: any, quart: any): number | Error;
3430
- }
3431
- /**
3432
- * Returns the quartile of the data set, based on percentile values from 0..1, exclusive.
3433
- *
3434
- * Category: Statistical
3435
- *
3436
- * @param {*} array The array or value range of numeric values for which you want the quartile value.
3437
- * @param {*} quart Indicates which value to return.
3438
- * @returns
3439
- */
3440
- export function QUARTILEEXC(range: any, quart: any): number | Error;
3441
- /**
3442
- * Returns the quartile of a data set.
3443
- *
3444
- * Category: Statistical
3445
- *
3446
- * @param {*} array The array or value range of numeric values for which you want the quartile value.
3447
- * @param {*} quart Indicates which value to return.
3448
- * @returns
3449
- */
3450
- export function QUARTILEINC(range: any, quart: any): number | Error;
3451
- /**
3452
- * Returns the integer portion of a division.
3453
- *
3454
- * Category: Math and trigonometry
3455
- *
3456
- * @param {*} numerator The dividend.
3457
- * @param {*} denominator The divisor.
3458
- * @returns
3459
- */
3460
- export function QUOTIENT(numerator: any, denominator: any): any;
3461
- /**
3462
- * Converts degrees to radians.
3463
- *
3464
- * Category: Math and trigonometry
3465
- *
3466
- * @param {*} angle An angle in degrees that you want to convert.
3467
- * @returns
3468
- */
3469
- export function RADIANS(angle: any): number | Error;
3470
- /**
3471
- * Returns a random number between 0 and 1.
3472
- *
3473
- * Category: Math and trigonometry
3474
- *
3475
- * @returns
3476
- */
3477
- export function RAND(): number;
3478
- /**
3479
- * Returns a random number between the numbers you specify.
3480
- *
3481
- * Category: Math and trigonometry
3482
- *
3483
- * @param {*} bottom The smallest integer RANDBETWEEN will return.
3484
- * @param {*} top The largest integer RANDBETWEEN will return.
3485
- * @returns
3486
- */
3487
- export function RANDBETWEEN(bottom: any, top: any): any;
3488
- export namespace RANK {
3489
- /**
3490
- * Returns the rank of a number in a list of numbers.
3491
- *
3492
- * Category: Statistical
3493
- *
3494
- * @param {*} number The number whose rank you want to find.
3495
- * @param {*} ref An array of, or a reference to, a list of numbers. Nonnumeric values in Ref are ignored.
3496
- * @param {*} order Optional. A number specifying how to rank number.
3497
- * @returns
3498
- */
3499
- function AVG(number: any, ref: any, order: any): any;
3500
- /**
3501
- * Returns the rank of a number in a list of numbers.
3502
- *
3503
- * Category: Statistical
3504
- *
3505
- * @param {*} number The number whose rank you want to find.
3506
- * @param {*} ref An array of, or a reference to, a list of numbers. Non-numeric values in Ref are ignored.
3507
- * @param {*} order Optional. A number specifying how to rank number.
3508
- * @returns
3509
- */
3510
- function EQ(number: any, ref: any, order: any): any;
3511
- }
3512
- /**
3513
- * Returns the rank of a number in a list of numbers.
3514
- *
3515
- * Category: Statistical
3516
- *
3517
- * @param {*} number The number whose rank you want to find.
3518
- * @param {*} ref An array of, or a reference to, a list of numbers. Nonnumeric values in Ref are ignored.
3519
- * @param {*} order Optional. A number specifying how to rank number.
3520
- * @returns
3521
- */
3522
- export function RANKAVG(number: any, ref: any, order: any): any;
3523
- /**
3524
- * Returns the rank of a number in a list of numbers.
3525
- *
3526
- * Category: Statistical
3527
- *
3528
- * @param {*} number The number whose rank you want to find.
3529
- * @param {*} ref An array of, or a reference to, a list of numbers. Non-numeric values in Ref are ignored.
3530
- * @param {*} order Optional. A number specifying how to rank number.
3531
- * @returns
3532
- */
3533
- export function RANKEQ(number: any, ref: any, order: any): any;
3534
- /**
3535
- * Returns the interest rate per period of an annuity.
3536
- *
3537
- * Category: Financial
3538
- *
3539
- * @param {*} nper The total number of payment periods in an annuity.
3540
- * @param {*} pmt The payment made each period and cannot change over the life of the annuity. Typically, pmt includes principal and interest but no other fees or taxes. If pmt is omitted, you must include the fv argument.
3541
- * @param {*} pv The present value — the total amount that a series of future payments is worth now.
3542
- * @param {*} fv Optional. The future value, or a cash balance you want to attain after the last payment is made. If fv is omitted, it is assumed to be 0 (the future value of a loan, for example, is 0). If fv is omitted, you must include the pmt argument.
3543
- * @param {*} type Optional. The number 0 or 1 and indicates when payments are due.
3544
- * @param {*} guess Optional. Your guess for what the rate will be. If you omit guess, it is assumed to be 10 percent. If RATE does not converge, try different values for guess. RATE usually converges if guess is between 0 and 1.
3545
- - If you omit guess, it is assumed to be 10 percent.
3546
- - If RATE does not converge, try different values for guess. RATE usually converges if guess is between 0 and 1.
3547
- * @returns
3548
- */
3549
- export function RATE(nper: any, pmt: any, pv: any, fv: any, type: any, guess: any): any;
3550
- /**
3551
- * Replaces characters within text
3552
- *
3553
- * Category: Text
3554
- *
3555
- * @param {*} old_text Text in which you want to replace some characters.
3556
- * @param {*} num_chars The number of characters in old_text that you want REPLACE to replace with new_text.
3557
- * @param {*} length he number of characters in old_text that you want REPLACEB to replace with new_text.
3558
- * @param {*} new_text he text that will replace characters in old_text.
3559
- * @returns
3560
- */
3561
- export function REPLACE(old_text: any, num_chars: any, length: any, new_text: any): string | Error;
3562
- /**
3563
- * Repeats text a given number of times.
3564
- *
3565
- * Category: Text
3566
- *
3567
- * @param {*} text The text you want to repeat.
3568
- * @param {*} number_times A positive number specifying the number of times to repeat text.
3569
- * @returns
3570
- */
3571
- export function REPT(text: any, number_times: any): any;
3572
- /**
3573
- * Returns the rightmost characters from a text value
3574
- *
3575
- * Category: Text
3576
- *
3577
- * @param {*} text The text string containing the characters you want to extract.
3578
- * @param {*} num_chars Optional. Specifies the number of characters you want RIGHT to extract.
3579
- * @returns
3580
- */
3581
- export function RIGHT(text: any, num_chars: any): any;
3582
- /**
3583
- * Converts an arabic numeral to roman, as text.
3584
- *
3585
- * Category: Math and trigonometry
3586
- *
3587
- * @param {*} number The Arabic numeral you want converted.
3588
- * @returns
3589
- */
3590
- export function ROMAN(number: any): string | Error;
3591
- export function ROTKI(): string;
3592
- /**
3593
- * Rounds a number to a specified number of digits.
3594
- *
3595
- * Category: Math and trigonometry
3596
- *
3597
- * @param {*} number The number that you want to round.
3598
- * @param {*} num_digits The number of digits to which you want to round the number argument.
3599
- * @returns
3600
- */
3601
- export function ROUND(number: any, num_digits: any): any;
3602
- /**
3603
- * Rounds a number down, toward zero.
3604
- *
3605
- * Category: Math and trigonometry
3606
- *
3607
- * @param {*} number Any real number that you want rounded down.
3608
- * @param {*} num_digits The number of digits to which you want to round number.
3609
- * @returns
3610
- */
3611
- export function ROUNDDOWN(number: any, num_digits: any): any;
3612
- /**
3613
- * Rounds a number up, away from zero.
3614
- *
3615
- * Category: Math and trigonometry
3616
- *
3617
- * @param {*} number Any real number that you want rounded up.
3618
- * @param {*} num_digits The number of digits to which you want to round number.
3619
- * @returns
3620
- */
3621
- export function ROUNDUP(number: any, num_digits: any): any;
3622
- /**
3623
- * Returns the row number of a reference.
3624
- *
3625
- * Category: Lookup and reference
3626
- *
3627
- * @param {*} reference the value or range of values for which you want the row number.
3628
- * @param {*} index
3629
- * @returns
3630
- */
3631
- export function ROW(reference: any, index: any, ...args: any[]): any;
3632
- /**
3633
- * Returns the number of rows in a reference.
3634
- *
3635
- * Category: Lookup and reference
3636
- *
3637
- * @param {*} array An array, an array formula, or a reference to a range of values for which you want the number of rows.
3638
- * @returns
3639
- */
3640
- export function ROWS(array: any, ...args: any[]): any;
3641
- /**
3642
- * Returns an equivalent interest rate for the growth of an investment.
3643
- *
3644
- * Category: Financial
3645
- *
3646
- * @param {*} nper Nper is the number of periods for the investment.
3647
- * @param {*} pv Pv is the present value of the investment.
3648
- * @param {*} fv Fv is the future value of the investment.
3649
- * @returns
3650
- */
3651
- export function RRI(nper: any, pv: any, fv: any): number | Error;
3652
- /**
3653
- * Returns the square of the Pearson product moment correlation coefficient.
3654
- *
3655
- * Category: Statistical
3656
- *
3657
- * @param {*} known_y An array or range of data points.
3658
- * @param {*} known_x An array or range of data points.
3659
- * @returns
3660
- */
3661
- export function RSQ(known_y: any, known_x: any): number | Error;
3662
- export function SAFE(...args: any[]): Promise<any>;
3663
- /**
3664
- * Finds one text value within another (not case-sensitive)
3665
- *
3666
- * Category: Text
3667
- *
3668
- * @param {*} find_text The text that you want to find.
3669
- * @param {*} within_text The text in which you want to search for the value of the find_text argument.
3670
- * @param {*} start_num Optional. The character number in the within_text argument at which you want to start searching.
3671
- * @returns
3672
- */
3673
- export function SEARCH(find_text: any, within_text: any, start_num: any): number | Error;
3674
- /**
3675
- * Returns the secant of an angle.
3676
- *
3677
- * Category: Math and trigonometry
3678
- *
3679
- * @param {*} number The angle in radians for which you want the secant.
3680
- * @returns
3681
- */
3682
- export function SEC(number: any): number | Error;
3683
- /**
3684
- * Returns the hyperbolic secant of an angle.
3685
- *
3686
- * Category: Math and trigonometry
3687
- *
3688
- * @param {*} number The angle in radians for which you want the hyperbolic secant.
3689
- * @returns
3690
- */
3691
- export function SECH(number: any): number | Error;
3692
- /**
3693
- * Converts a serial number to a second.
3694
- *
3695
- * Category: Date and time
3696
- *
3697
- * @param {*} serial_number The time that contains the seconds you want to find. Times may be entered as text strings within quotation marks (for example, "6:45 PM"), as decimal numbers (for example, 0.78125, which represents 6:45 PM), or as results of other formulas or functions (for example, TIMEVALUE("6:45 PM")).
3698
- * @returns
3699
- */
3700
- export function SECOND(serial_number: any): any;
3701
- /**
3702
- * Returns the sum of a power series based on the formula.
3703
- *
3704
- * Category: Math and trigonometry
3705
- *
3706
- * @param {*} x The input value to the power series.
3707
- * @param {*} n The initial power to which you want to raise x.
3708
- * @param {*} m The step by which to increase n for each term in the series.
3709
- * @param {*} coefficients A set of coefficients by which each successive power of x is multiplied. The number of values in coefficients determines the number of terms in the power series. For example, if there are three values in coefficients, then there will be three terms in the power series.
3710
- * @returns
3711
- */
3712
- export function SERIESSUM(x: any, n: any, m: any, coefficients: any): number | Error;
3713
- /**
3714
- * Returns the sign of a number.
3715
- *
3716
- * Category: Math and trigonometry
3717
- *
3718
- * @param {*} number Any real number.
3719
- * @returns
3720
- */
3721
- export function SIGN(number: any): 0 | Error | 1 | -1;
3722
- /**
3723
- * Returns the sine of the given angle.
3724
- *
3725
- * Category: Math and trigonometry
3726
- *
3727
- * @param {*} number The angle in radians for which you want the sine.
3728
- * @returns
3729
- */
3730
- export function SIN(number: any): number | Error;
3731
- /**
3732
- * Returns the hyperbolic sine of a number.
3733
- *
3734
- * Category: Math and trigonometry
3735
- *
3736
- * @param {*} number Any real number.
3737
- * @returns
3738
- */
3739
- export function SINH(number: any): number | Error;
3740
- /**
3741
- * Returns the skewness of a distribution.
3742
- *
3743
- * Category: Statistical
3744
- *
3745
- * @param {*} args number1, number2, ... Number1 is required, subsequent numbers are optional. 1 to 255 arguments for which you want to calculate skewness. You can also use a single array or a reference to an array instead of arguments separated by commas.
3746
- * @returns
3747
- */
3748
- export function SKEW(...args: any[]): number | Error;
3749
- export namespace SKEW {
3750
- /**
3751
- * Returns the skewness of a distribution based on a population.
3752
- *
3753
- * Category: Statistical
3754
- *
3755
- * @returns
3756
- */
3757
- function P(...args: any[]): number | Error;
3758
- }
3759
- /**
3760
- * Returns the skewness of a distribution based on a population.
3761
- *
3762
- * Category: Statistical
3763
- *
3764
- * @returns
3765
- */
3766
- export function SKEWP(...args: any[]): number | Error;
3767
- /**
3768
- * Returns the straight-line depreciation of an asset for one period.
3769
- *
3770
- * Category: Financial
3771
- *
3772
- * @param {*} cost The initial cost of the asset.
3773
- * @param {*} salvage The value at the end of the depreciation (sometimes called the salvage value of the asset).
3774
- * @param {*} life The number of periods over which the asset is depreciated (sometimes called the useful life of the asset).
3775
- * @returns
3776
- */
3777
- export function SLN(cost: any, salvage: any, life: any): number | Error;
3778
- /**
3779
- * Returns the slope of the linear regression line.
3780
- *
3781
- * Category: Statistical
3782
- *
3783
- * @param {*} known_y An array or value range of numeric dependent data points.
3784
- * @param {*} known_x The set of independent data points.
3785
- * @returns
3786
- */
3787
- export function SLOPE(known_y: any, known_x: any): number | Error;
3788
- /**
3789
- * Returns the k-th smallest value in a data set.
3790
- *
3791
- * Category: Statistical
3792
- *
3793
- * @param {*} array An array or range of numerical data for which you want to determine the k-th smallest value.
3794
- * @param {*} k The position (from the smallest) in the array or range of data to return.
3795
- * @returns
3796
- */
3797
- export function SMALL(array: any, k: any): any;
3798
- export function SMARTCONTRACT(...args: any[]): Promise<any>;
3799
- /**
3800
- * Returns a sorted array of the elements in an array. The returned array is the same shape as the provided array argument.
3801
- *
3802
- * Category: Lookup and reference
3803
- *
3804
- * @param {*} array Array to sort
3805
- * @param {*} sort_index Optional. A number indicating the row or column to sort by
3806
- * @param {*} sort_order Optional. A number indicating the desired sort order; 1 for ascending order (default), -1 for descending order
3807
- * @param {*} by_col Optional. A logical value indicating the desired sort direction; FALSE to sort by row (default), TRUE to sort by column
3808
- * @returns
3809
- */
3810
- export function SORT(inputArray: any, sortIndex: number, isAscending: any, sortByColumn?: boolean): any;
3811
- /**
3812
- * Returns a positive square root.
3813
- *
3814
- * Category: Math and trigonometry
3815
- *
3816
- * @param {*} number The number for which you want the square root.
3817
- * @returns
3818
- */
3819
- export function SQRT(number: any): number | Error;
3820
- /**
3821
- * Returns the square root of (number * pi).
3822
- *
3823
- * Category: Math and trigonometry
3824
- *
3825
- * @param {*} number The number by which pi is multiplied.
3826
- * @returns
3827
- */
3828
- export function SQRTPI(number: any): number | Error;
3829
- /**
3830
- * Returns a normalized value.
3831
- *
3832
- * Category: Statistical
3833
- *
3834
- * @param {*} x The value you want to normalize.
3835
- * @param {*} mean The arithmetic mean of the distribution.
3836
- * @param {*} standard_dev The standard deviation of the distribution.
3837
- * @returns
3838
- */
3839
- export function STANDARDIZE(x: any, mean: any, standard_dev: any): number | Error;
3840
- export namespace STDEV {
3841
- /**
3842
- * Calculates standard deviation based on the entire population.
3843
- *
3844
- * Category: Statistical
3845
- *
3846
- * @param {*} args number1, number2, ... Number arguments 2 to 254 corresponding to a population. You can also use a single array or a reference to an array instead of arguments separated by commas.
3847
- * @returns
3848
- */
3849
- function P(...args: any[]): number;
3850
- /**
3851
- * Estimates standard deviation based on a sample.
3852
- *
3853
- * Category: Statistical
3854
- *
3855
- * @param {*} args number1, number2, ... Number arguments 2 to 254 corresponding to a sample of a population. You can also use a single array or a reference to an array instead of arguments separated by commas.
3856
- * @returns
3857
- */
3858
- function S(...args: any[]): number;
3859
- }
3860
- /**
3861
- * Estimates standard deviation based on a sample, including numbers, text, and logical values.
3862
- *
3863
- * Category: Statistical
3864
- *
3865
- * @param {*} args value1, value2, ... Value1 is required, subsequent values are optional. 1 to 255 values corresponding to a sample of a population. You can also use a single array or a reference to an array instead of arguments separated by commas.
3866
- * @returns
3867
- */
3868
- export function STDEVA(...args: any[]): number;
3869
- /**
3870
- * Calculates standard deviation based on the entire population.
3871
- *
3872
- * Category: Statistical
3873
- *
3874
- * @param {*} args number1, number2, ... Number arguments 2 to 254 corresponding to a population. You can also use a single array or a reference to an array instead of arguments separated by commas.
3875
- * @returns
3876
- */
3877
- export function STDEVP(...args: any[]): number;
3878
- /**
3879
- * Calculates standard deviation based on the entire population, including numbers, text, and logical values.
3880
- *
3881
- * Category: Statistical
3882
- *
3883
- * @param {*} args value1, value2, ... Value1 is required, subsequent values are optional. 1 to 255 values corresponding to a population. You can also use a single array or a reference to an array instead of arguments separated by commas.
3884
- * @returns
3885
- */
3886
- export function STDEVPA(...args: any[]): number;
3887
- /**
3888
- * Estimates standard deviation based on a sample.
3889
- *
3890
- * Category: Statistical
3891
- *
3892
- * @param {*} args number1, number2, ... Number arguments 2 to 254 corresponding to a sample of a population. You can also use a single array or a reference to an array instead of arguments separated by commas.
3893
- * @returns
3894
- */
3895
- export function STDEVS(...args: any[]): number;
3896
- /**
3897
- * Returns the standard error of the predicted y-value for each x in the regression.
3898
- *
3899
- * Category: Statistical
3900
- *
3901
- * @param {*} known_y An array or range of dependent data points.
3902
- * @param {*} known_x An array or range of independent data points.
3903
- * @returns
3904
- */
3905
- export function STEYX(known_y: any, known_x: any): number | Error;
3906
- /**
3907
- * Substitutes new text for old text in a text string.
3908
- *
3909
- * Category: Text
3910
- *
3911
- * @param {*} text The text or the reference to a value containing text for which you want to substitute characters.
3912
- * @param {*} old_text The text you want to replace.
3913
- * @param {*} new_text The text you want to replace old_text with.
3914
- * @param {*} instance_num Optional. Specifies which occurrence of old_text you want to replace with new_text. If you specify instance_num, only that instance of old_text is replaced. Otherwise, every occurrence of old_text in text is changed to new_text.
3915
- * @returns
3916
- */
3917
- export function SUBSTITUTE(text: any, old_text: any, new_text: any, instance_num: any, ...args: any[]): any;
3918
- /**
3919
- * Returns a subtotal in a list or database.
3920
- *
3921
- * Category: Math and trigonometry
3922
- *
3923
- * @param {*} function_num The number 1-11 or 101-111 that specifies the function to use for the subtotal. 1-11 includes manually-hidden rows, while 101-111 excludes them; filtered-out values are always excluded.
3924
- * @param {*} ref1 The first named range or reference for which you want the subtotal.
3925
- * @returns
3926
- */
3927
- export function SUBTOTAL(function_num: any, ref1: any): any;
3928
- /**
3929
- * Adds its arguments.
3930
- *
3931
- * Category: Math and trigonometry
3932
- *
3933
- * @returns
3934
- */
3935
- export function SUM(...args: any[]): number;
3936
- /**
3937
- * Adds the values specified by a given criteria.
3938
- *
3939
- * Category: Math and trigonometry
3940
- *
3941
- * @param {*} range The range of values that you want evaluated by criteria. Cells in each range must be numbers or names, arrays, or references that contain numbers. Blank and text values are ignored.
3942
- * @param {*} criteria The criteria in the form of a number, expression, a value reference, text, or a function that defines which values will be added.
3943
- * @param {*} sum_range Optional. The actual values to add, if you want to add values other than those specified in the range argument. If the sum_range argument is omitted, Excel adds the values that are specified in the range argument (the same values to which the criteria is applied). Sum_range should be the same size and shape as range. If it isn't, performance may suffer, and the formula will sum a range of values that starts with the first value in sum_range but has the same dimensions as range.
3944
- * @returns
3945
- */
3946
- export function SUMIF(range: any, criteria: any, sum_range: any): number | Error;
3947
- /**
3948
- * Adds the values in a range that meet multiple criteria.
3949
- *
3950
- * Category: Math and trigonometry
3951
- *
3952
- * @returns
3953
- */
3954
- export function SUMIFS(...args: any[]): number;
3955
- /**
3956
- * Returns the sum of the products of corresponding array components.
3957
- *
3958
- * Category: Math and trigonometry
3959
- *
3960
- * @returns
3961
- */
3962
- export function SUMPRODUCT(...args: any[]): number | Error;
3963
- /**
3964
- * Returns the sum of the squares of the arguments.
3965
- *
3966
- * Category: Math and trigonometry
3967
- *
3968
- * @param {*} args number1, number2, ... Number1 is required, subsequent numbers are optional. 1 to 255 arguments for which you want the sum of the squares. You can also use a single array or a reference to an array instead of arguments separated by commas.
3969
- * @returns
3970
- */
3971
- export function SUMSQ(...args: any[]): number | Error;
3972
- /**
3973
- * Returns the sum of the difference of squares of corresponding values in two arrays.
3974
- *
3975
- * Category: Math and trigonometry
3976
- *
3977
- * @param {*} array_x The first array or range of values.
3978
- * @param {*} array_y The second array or range of values.
3979
- * @returns
3980
- */
3981
- export function SUMX2MY2(array_x: any, array_y: any): number | Error;
3982
- /**
3983
- * Returns the sum of the sum of squares of corresponding values in two arrays.
3984
- *
3985
- * Category: Math and trigonometry
3986
- *
3987
- * @param {*} array_x The first array or range of values.
3988
- * @param {*} array_y The second array or range of values.
3989
- * @returns
3990
- */
3991
- export function SUMX2PY2(array_x: any, array_y: any): number | Error;
3992
- /**
3993
- * Returns the sum of squares of differences of corresponding values in two arrays.
3994
- *
3995
- * Category: Math and trigonometry
3996
- *
3997
- * @param {*} array_x The first array or range of values.
3998
- * @param {*} array_y The second array or range of values.
3999
- * @returns
4000
- */
4001
- export function SUMXMY2(array_x: any, array_y: any): number | Error;
4002
- /**
4003
- * Evaluates an expression against a list of values and returns the result corresponding to the first matching value. If there is no match, an optional default value may be returned.
4004
- *
4005
- * Category: Logical
4006
- *
4007
- * @returns
4008
- */
4009
- export function SWITCH(...args: any[]): any;
4010
- /**
4011
- * Returns the sum-of-years' digits depreciation of an asset for a specified period.
4012
- *
4013
- * Category: Financial
4014
- *
4015
- * @param {*} cost The initial cost of the asset.
4016
- * @param {*} salvage The value at the end of the depreciation (sometimes called the salvage value of the asset).
4017
- * @param {*} life The number of periods over which the asset is depreciated (sometimes called the useful life of the asset).
4018
- * @param {*} per The period and must use the same units as life.
4019
- * @returns
4020
- */
4021
- export function SYD(cost: any, salvage: any, life: any, per: any): number | Error;
4022
- /**
4023
- * Converts its arguments to text.
4024
- *
4025
- * Category: Text
4026
- *
4027
- * @param {*} value The value you want to test.
4028
- * @returns
4029
- */
4030
- export function T(value: any): string | Error;
4031
- export namespace T {
4032
- /**
4033
- * Returns the Percentage Points (probability) for the Student t-distribution.
4034
- *
4035
- * Category: Statistical
4036
- *
4037
- * @param {*} x The numeric value at which to evaluate the distribution
4038
- * @param {*} deg_freedom An integer indicating the number of degrees of freedom.
4039
- * @param {*} cumulative A logical value that determines the form of the function. If cumulative is TRUE, T.DIST returns the cumulative distribution function; if FALSE, it returns the probability density function.
4040
- * @returns
4041
- */
4042
- function DIST(x: any, deg_freedom: any, cumulative: any): number | Error;
4043
- namespace DIST {
4044
- /**
4045
- * Returns the Student's t-distribution.
4046
- *
4047
- * Category: Statistical
4048
- *
4049
- * @param {*} x The numeric value at which to evaluate the distribution.
4050
- * @param {*} deg_freedom An integer indicating the number of degrees of freedom.
4051
- * @returns
4052
- */
4053
- function RT(x: any, deg_freedom: any, ...args: any[]): number | Error;
4054
- }
4055
- /**
4056
- * Returns the t-value of the Student's t-distribution as a function of the probability and the degrees of freedom.
4057
- *
4058
- * Category: Statistical
4059
- *
4060
- * @param {*} probability The probability associated with the Student's t-distribution.
4061
- * @param {*} deg_freedom The number of degrees of freedom with which to characterize the distribution.
4062
- * @returns
4063
- */
4064
- function INV(probability: any, deg_freedom: any): any;
4065
- /**
4066
- * Returns the probability associated with a Student's t-test.
4067
- *
4068
- * Category: Statistical
4069
- *
4070
- * @param {*} array1 The first data set.
4071
- * @param {*} array2 The second data set.
4072
- * @returns
4073
- */
4074
- function TEST(array1: any, array2: any): number | Error;
4075
- }
4076
- export function TALLY(...args: any[]): Promise<any>;
4077
- /**
4078
- * Returns the tangent of a number.
4079
- *
4080
- * Category: Math and trigonometry
4081
- *
4082
- * @param {*} number The angle in radians for which you want the tangent.
4083
- * @returns
4084
- */
4085
- export function TAN(number: any): number | Error;
4086
- /**
4087
- * Returns the hyperbolic tangent of a number.
4088
- *
4089
- * Category: Math and trigonometry
4090
- *
4091
- * @param {*} number Any real number.
4092
- * @returns
4093
- */
4094
- export function TANH(number: any): number | Error;
4095
- /**
4096
- * Returns the bond-equivalent yield for a Treasury bill.
4097
- *
4098
- * Category: Financial
4099
- *
4100
- * @param {*} settlement The Treasury bill's settlement date. The security settlement date is the date after the issue date when the Treasury bill is traded to the buyer.
4101
- * @param {*} maturity The Treasury bill's maturity date. The maturity date is the date when the Treasury bill expires.
4102
- * @param {*} discount The Treasury bill's discount rate.
4103
- * @returns
4104
- */
4105
- export function TBILLEQ(settlement: any, maturity: any, discount: any): number | Error;
4106
- /**
4107
- * Returns the price per $100 face value for a Treasury bill.
4108
- *
4109
- * Category: Financial
4110
- *
4111
- * @param {*} settlement The Treasury bill's settlement date. The security settlement date is the date after the issue date when the Treasury bill is traded to the buyer.
4112
- * @param {*} maturity The Treasury bill's maturity date. The maturity date is the date when the Treasury bill expires.
4113
- * @param {*} discount The Treasury bill's discount rate.
4114
- * @returns
4115
- */
4116
- export function TBILLPRICE(settlement: any, maturity: any, discount: any): number | Error;
4117
- /**
4118
- * Returns the yield for a Treasury bill.
4119
- *
4120
- * Category: Financial
4121
- *
4122
- * @param {*} settlement The Treasury bill's settlement date. The security settlement date is the date after the issue date when the Treasury bill is traded to the buyer.
4123
- * @param {*} maturity The Treasury bill's maturity date. The maturity date is the date when the Treasury bill expires.
4124
- * @param {*} pr The Treasury bill's price per $100 face value.
4125
- * @returns
4126
- */
4127
- export function TBILLYIELD(settlement: any, maturity: any, pr: any): number | Error;
4128
- /**
4129
- * Returns the Percentage Points (probability) for the Student t-distribution.
4130
- *
4131
- * Category: Statistical
4132
- *
4133
- * @param {*} x The numeric value at which to evaluate the distribution
4134
- * @param {*} deg_freedom An integer indicating the number of degrees of freedom.
4135
- * @param {*} cumulative A logical value that determines the form of the function. If cumulative is TRUE, T.DIST returns the cumulative distribution function; if FALSE, it returns the probability density function.
4136
- * @returns
4137
- */
4138
- export function TDIST(x: any, deg_freedom: any, cumulative: any): number | Error;
4139
- export namespace TDIST {
4140
- /**
4141
- * Returns the Percentage Points (probability) for the Student t-distribution
4142
- *
4143
- * Category: Statistical
4144
- *
4145
- * @param {*} x The numeric value at which to evaluate the distribution.
4146
- * @param {*} deg_freedom An integer indicating the number of degrees of freedom.
4147
- * @returns
4148
- */
4149
- function _2T(x: any, deg_freedom: any, ...args: any[]): number | Error;
4150
- }
4151
- /**
4152
- * Returns the Student's t-distribution.
4153
- *
4154
- * Category: Statistical
4155
- *
4156
- * @param {*} x The numeric value at which to evaluate the distribution.
4157
- * @param {*} deg_freedom An integer indicating the number of degrees of freedom.
4158
- * @returns
4159
- */
4160
- export function TDISTRT(x: any, deg_freedom: any, ...args: any[]): number | Error;
4161
- /**
4162
- * Formats a number and converts it to text.
4163
- *
4164
- * Category: Text
4165
- *
4166
- * @param {*} value A numeric value that you want to be converted into text.
4167
- * @param {*} format_text A text string that defines the formatting that you want to be applied to the supplied value.
4168
- * @returns
4169
- */
4170
- export function TEXT(value$1: any, format_text: any): any;
4171
- /**
4172
- * Combines the text from multiple ranges and/or strings.
4173
- *
4174
- * Category: Text
4175
- * @param {*} delimiter A text string, either empty, or one or more characters enclosed by double quotes, or a reference to a valid text string. If a number is supplied, it will be treated as text.
4176
- * @param {*} ignore_empty If TRUE, ignores empty values.
4177
- * @param {*} args Text item to be joined. A text string, or array of strings, such as a range of values.
4178
- * @returns
4179
- */
4180
- export function TEXTJOIN(delimiter: any, ignore_empty: any, ...args: any): any;
4181
- /**
4182
- * Returns the serial number of a particular time.
4183
- *
4184
- * Category: Date and time
4185
- *
4186
- * @param {*} hour A number from 0 (zero) to 32767 representing the hour. Any value greater than 23 will be divided by 24 and the remainder will be treated as the hour value. For example, TIME(27,0,0) = TIME(3,0,0) = .125 or 3:00 AM.
4187
- * @param {*} minute A number from 0 to 32767 representing the minute. Any value greater than 59 will be converted to hours and minutes. For example, TIME(0,750,0) = TIME(12,30,0) = .520833 or 12:30 PM.
4188
- * @param {*} second A number from 0 to 32767 representing the second. Any value greater than 59 will be converted to hours, minutes, and seconds. For example, TIME(0,0,2000) = TIME(0,33,22) = .023148 or 12:33:20 AM
4189
- * @returns
4190
- */
4191
- export function TIME(hour: any, minute: any, second: any): string | Error;
4192
- /**
4193
- * Converts a time in the form of text to a serial number.
4194
- *
4195
- * Category: Date and time
4196
- *
4197
- * @param {*} time_text A text string that represents a time in any one of the Microsoft Excel time formats; for example, "6:45 PM" and "18:45" text strings within quotation marks that represent time.
4198
- * @returns
4199
- */
4200
- export function TIMEVALUE(time_text: any): number | Error;
4201
- /**
4202
- * Returns the t-value of the Student's t-distribution as a function of the probability and the degrees of freedom.
4203
- *
4204
- * Category: Statistical
4205
- *
4206
- * @param {*} probability The probability associated with the Student's t-distribution.
4207
- * @param {*} deg_freedom The number of degrees of freedom with which to characterize the distribution.
4208
- * @returns
4209
- */
4210
- export function TINV(probability: any, deg_freedom: any): any;
4211
- export namespace TINV {
4212
- /**
4213
- * Returns the inverse of the Student's t-distribution
4214
- *
4215
- * Category: Statistical
4216
- *
4217
- * @param {*} probability The probability associated with the Student's t-distribution.
4218
- * @param {*} deg_freedom The number of degrees of freedom with which to characterize the distribution.
4219
- * @returns
4220
- */
4221
- function _2T(probability: any, deg_freedom: any): number | Error;
4222
- }
4223
- /**
4224
- * Returns the serial number of today's date.
4225
- *
4226
- * Category: Date and time
4227
- *
4228
- * @returns
4229
- */
4230
- export function TODAY(): string;
4231
- /**
4232
- * Returns the transpose of an array.
4233
- *
4234
- * Category: Lookup and reference
4235
- *
4236
- * @param {*} array An array or range of values on a worksheet that you want to transpose. The transpose of an array is created by using the first row of the array as the first column of the new array, the second row of the array as the second column of the new array, and so on. If you're not sure of how to enter an array formula, see Create an array formula.
4237
- * @returns
4238
- */
4239
- export function TRANSPOSE(array: any): any;
4240
- /**
4241
- * Returns values along a linear trend.
4242
- *
4243
- * Category: Statistical
4244
- *
4245
- * @param {*} known_ys The set of y-values you already know in the relationship y = mx + b
4246
- * @param {*} known_xs An optional set of x-values that you may already know in the relationship y = mx + b
4247
- * @param {*} new_xs Optional. New x-values for which you want TREND to return corresponding y-values.
4248
- * @returns
4249
- */
4250
- export function TREND(known_ys: any, known_xs: any, new_xs: any): any[] | Error;
4251
- /**
4252
- * Removes spaces from text.
4253
- *
4254
- * Category: Text
4255
- *
4256
- * @param {*} text The text from which you want spaces removed.
4257
- * @returns
4258
- */
4259
- export function TRIM(text: any): any;
4260
- /**
4261
- * Returns the mean of the interior of a data set.
4262
- *
4263
- * Category: Statistical
4264
- *
4265
- * @param {*} array The array or range of values to trim and average.
4266
- * @param {*} percent The fractional number of data points to exclude from the calculation. For example, if percent = 0.2, 4 points are trimmed from a data set of 20 points (20 x 0.2): 2 from the top and 2 from the bottom of the set.
4267
- * @returns
4268
- */
4269
- export function TRIMMEAN(range: any, percent: any): any;
4270
- /**
4271
- * Returns the logical value TRUE.
4272
- *
4273
- * Category: Logical
4274
- *
4275
- * @returns
4276
- */
4277
- export function TRUE(): boolean;
4278
- /**
4279
- * Truncates a number to an integer.
4280
- *
4281
- * Category: Math and trigonometry
4282
- *
4283
- * @param {*} number The number you want to truncate.
4284
- * @param {*} num_digits Optional. A number specifying the precision of the truncation. The default value for num_digits is 0 (zero).
4285
- * @returns
4286
- */
4287
- export function TRUNC(number: any, num_digits: any): any;
4288
- /**
4289
- * Returns the probability associated with a Student's t-test.
4290
- *
4291
- * Category: Statistical
4292
- *
4293
- * @param {*} array1 The first data set.
4294
- * @param {*} array2 The second data set.
4295
- * @returns
4296
- */
4297
- export function TTEST(array1: any, array2: any): number | Error;
4298
- /**
4299
- * Returns a number indicating the data type of a value.
4300
- *
4301
- * Category: Information
4302
- *
4303
- * @param {*} value Can be any Microsoft Excel value, such as a number, text, logical value, and so on.
4304
- * @returns
4305
- */
4306
- export function TYPE(value: any): 1 | 2 | 4 | 16 | 64;
4307
- /**
4308
- * Returns the character specified by the code number.
4309
- *
4310
- * Category: Text
4311
- *
4312
- * @param {*} number A number between 1 and 255 specifying which character you want. The character is from the character set used by your computer. Note: Excel for the web supports only CHAR(9), CHAR(10), CHAR(13), and CHAR(32) and above.
4313
- * @returns
4314
- */
4315
- export function UNICHAR(number: any): string | Error;
4316
- /**
4317
- * Returns a numeric code for the first character in a text string.
4318
- *
4319
- * Category: Text
4320
- *
4321
- * @param {*} text The text for which you want the code of the first character.
4322
- * @returns
4323
- */
4324
- export function UNICODE(text: any): any;
4325
- /**
4326
- * Returns a list of unique values in a list or range.
4327
- *
4328
- * Category: Lookup and reference
4329
- *
4330
- * @returns
4331
- */
4332
- export function UNIQUE(...args: any[]): any[];
4333
- export function UNISWAP(...args: any[]): Promise<any>;
4334
- /**
4335
- * Converts text to uppercase.
4336
- *
4337
- * Category: Text
4338
- *
4339
- * @param {*} text The text you want converted to uppercase. Text can be a reference or text string.
4340
- * @returns
4341
- */
4342
- export function UPPER(text: any): any;
4343
- /**
4344
- * Converts a text argument to a number.
4345
- *
4346
- * Category: Text
4347
- *
4348
- * @param {*} text The text enclosed in quotation marks or a reference to a value containing the text you want to convert.
4349
- * @returns
4350
- */
4351
- export function VALUE(text: any): any;
4352
- export namespace VAR {
4353
- /**
4354
- * Calculates variance based on the entire population.
4355
- *
4356
- * Category: Statistical
4357
- *
4358
- * @param {*} args number1, number2, ... Number arguments 2 to 254 corresponding to a population.
4359
- * @returns
4360
- */
4361
- function P(...args: any[]): number | Error;
4362
- /**
4363
- * Estimates variance based on a sample.
4364
- *
4365
- * Category: Statistical
4366
- *
4367
- * @param {*} args number1, number2, ... Number arguments 2 to 254 corresponding to a sample of a population.
4368
- * @returns
4369
- */
4370
- function S(...args: any[]): number;
4371
- }
4372
- /**
4373
- * Estimates variance based on a sample, including numbers, text, and logical values.
4374
- *
4375
- * Category: Statistical
4376
- *
4377
- * @param {*} args value1, value2, ... Value1 is required, subsequent values are optional. 1 to 255 value arguments corresponding to a sample of a population.
4378
- * @returns
4379
- */
4380
- export function VARA(...args: any[]): number;
4381
- /**
4382
- * Calculates variance based on the entire population.
4383
- *
4384
- * Category: Statistical
4385
- *
4386
- * @param {*} args number1, number2, ... Number arguments 2 to 254 corresponding to a population.
4387
- * @returns
4388
- */
4389
- export function VARP(...args: any[]): number | Error;
4390
- /**
4391
- * Calculates variance based on the entire population, including numbers, text, and logical values.
4392
- *
4393
- * Category: Statistical
4394
- *
4395
- * @param {*} args value1, value2, ... Value1 is required, subsequent values are optional. 1 to 255 value arguments corresponding to a population.
4396
- * @returns
4397
- */
4398
- export function VARPA(...args: any[]): number | Error;
4399
- /**
4400
- * Estimates variance based on a sample.
4401
- *
4402
- * Category: Statistical
4403
- *
4404
- * @param {*} args number1, number2, ... Number arguments 2 to 254 corresponding to a sample of a population.
4405
- * @returns
4406
- */
4407
- export function VARS(...args: any[]): number;
4408
- /**
4409
- * Looks in the first column of an array and moves across the row to return the value of a value.
4410
- *
4411
- * Category: Lookup and reference
4412
- *
4413
- * @param {*} lookup_value The value to be found in the first row of the table. Lookup_value can be a value, a reference, or a text string.
4414
- * @param {*} table_array A table of information in which data is looked up. Use a reference to a range or a range name.
4415
- * @param {*} col_index_num The row number in table_array from which the matching value will be returned. A row_index_num of 1 returns the first row value in table_array, a row_index_num of 2 returns the second row value in table_array, and so on. If row_index_num is less than 1, HLOOKUP returns the #VALUE! error value; if row_index_num is greater than the number of rows on table_array, HLOOKUP returns the #REF! error value.
4416
- * @param {*} range_lookup Optional. A logical value that specifies whether you want HLOOKUP to find an exact match or an approximate match. If TRUE or omitted, an approximate match is returned. In other words, if an exact match is not found, the next largest value that is less than lookup_value is returned. If FALSE, HLOOKUP will find an exact match. If one is not found, the error value #N/A is returned.
4417
- * @returns
4418
- */
4419
- export function VLOOKUP(lookup_value: any, table_array: any, col_index_num: any, range_lookup: any): Error;
4420
- export function WALLET(...args: any[]): Promise<any>;
4421
- /**
4422
- * Converts a serial number to a day of the week.
4423
- *
4424
- * Category: Date and time
4425
- *
4426
- * @param {*} serial_number A sequential number that represents the date of the day you are trying to find.
4427
- * @param {*} return_type Optional. A number that determines the type of return value.
4428
- * @returns
4429
- */
4430
- export function WEEKDAY(serial_number: any, return_type: any): number | Error;
4431
- /**
4432
- * Converts a serial number to a number representing where the week falls numerically with a year.
4433
- *
4434
- * Category: Date and time
4435
- *
4436
- * @param {*} serial_number A date within the week.
4437
- * @param {*} return_type Optional. A number that determines on which day the week begins. The default is 1.
4438
- * @returns
4439
- */
4440
- export function WEEKNUM(serial_number: any, return_type: any): number | Error;
4441
- export namespace WEIBULL {
4442
- /**
4443
- * Returns the Weibull distribution.
4444
- *
4445
- * Category: Statistical
4446
- *
4447
- * @param {*} x The value at which to evaluate the function.
4448
- * @param {*} alpha A parameter to the distribution.
4449
- * @param {*} beta A parameter to the distribution.
4450
- * @param {*} cumulative Determines the form of the function.
4451
- * @returns
4452
- */
4453
- function DIST(x: any, alpha: any, beta: any, cumulative: any): number | Error;
4454
- }
4455
- /**
4456
- * Returns the Weibull distribution.
4457
- *
4458
- * Category: Statistical
4459
- *
4460
- * @param {*} x The value at which to evaluate the function.
4461
- * @param {*} alpha A parameter to the distribution.
4462
- * @param {*} beta A parameter to the distribution.
4463
- * @param {*} cumulative Determines the form of the function.
4464
- * @returns
4465
- */
4466
- export function WEIBULLDIST(x: any, alpha: any, beta: any, cumulative: any): number | Error;
4467
- /**
4468
- * Returns the serial number of the date before or after a specified number of workdays.
4469
- *
4470
- * Category: Date and time
4471
- *
4472
- * @param {*} start_date A date that represents the start date.
4473
- * @param {*} days The number of nonweekend and nonholiday days before or after start_date. A positive value for days yields a future date; a negative value yields a past date.
4474
- * @param {*} holidays Optional. An optional list of one or more dates to exclude from the working calendar, such as state and federal holidays and floating holidays. The list can be either a range of values that contain the dates or an array constant of the serial numbers that represent the dates.
4475
- * @returns
4476
- */
4477
- export function WORKDAY(start_date: any, days: any, holidays: any): string | Error;
4478
- export namespace WORKDAY {
4479
- /**
4480
- * Returns the serial number of the date before or after a specified number of workdays using parameters to indicate which and how many days are weekend days.
4481
- *
4482
- * Category: Date and time
4483
- *
4484
- * @param {*} start_date The start date, truncated to integer.
4485
- * @param {*} days The number of workdays before or after the start_date. A positive value yields a future date; a negative value yields a past date; a zero value yields the start_date. Day-offset is truncated to an integer.
4486
- * @param {*} weekend Optional. Indicates the days of the week that are weekend days and are not considered working days. Weekend is a weekend number or string that specifies when weekends occur. Weekend number values indicate the following weekend days:
4487
- * @param {*} holidays Optional. An optional set of one or more dates that are to be excluded from the working day calendar. Holidays shall be a range of values that contain the dates, or an array constant of the serial values that represent those dates. The ordering of dates or serial values in holidays can be arbitrary.
4488
- * @returns
4489
- */
4490
- function INTL(start_date: any, days: any, weekend: any, holidays: any): string | Error;
4491
- }
4492
- /**
4493
- * Returns the serial number of the date before or after a specified number of workdays using parameters to indicate which and how many days are weekend days.
4494
- *
4495
- * Category: Date and time
4496
- *
4497
- * @param {*} start_date The start date, truncated to integer.
4498
- * @param {*} days The number of workdays before or after the start_date. A positive value yields a future date; a negative value yields a past date; a zero value yields the start_date. Day-offset is truncated to an integer.
4499
- * @param {*} weekend Optional. Indicates the days of the week that are weekend days and are not considered working days. Weekend is a weekend number or string that specifies when weekends occur. Weekend number values indicate the following weekend days:
4500
- * @param {*} holidays Optional. An optional set of one or more dates that are to be excluded from the working day calendar. Holidays shall be a range of values that contain the dates, or an array constant of the serial values that represent those dates. The ordering of dates or serial values in holidays can be arbitrary.
4501
- * @returns
4502
- */
4503
- export function WORKDAYINTL(start_date: any, days: any, weekend: any, holidays: any): string | Error;
4504
- /**
4505
- * Returns the serial number of the date before or after a specified number of workdays using parameters to indicate which and how many days are weekend days.
4506
- *
4507
- * Category: Date and time
4508
- *
4509
- * @param {*} start_date The start date, truncated to integer.
4510
- * @param {*} days The number of workdays before or after the start_date. A positive value yields a future date; a negative value yields a past date; a zero value yields the start_date. Day-offset is truncated to an integer.
4511
- * @param {*} weekend Optional. Indicates the days of the week that are weekend days and are not considered working days. Weekend is a weekend number or string that specifies when weekends occur. Weekend number values indicate the following weekend days:
4512
- * @param {*} holidays Optional. An optional set of one or more dates that are to be excluded from the working day calendar. Holidays shall be a range of values that contain the dates, or an array constant of the serial values that represent those dates. The ordering of dates or serial values in holidays can be arbitrary.
4513
- * @returns
4514
- */
4515
- export function WORKDAY_INTL(start_date: any, days: any, weekend: any, holidays: any): string | Error;
4516
- /**
4517
- * Returns the internal rate of return for a schedule of cash flows that is not necessarily periodic.
4518
- *
4519
- * Category: Financial
4520
- *
4521
- * @param {*} values A series of cash flows that corresponds to a schedule of payments in dates. The first payment is optional and corresponds to a cost or payment that occurs at the beginning of the investment. If the first value is a cost or payment, it must be a negative value. All succeeding payments are discounted based on a 365-day year. The series of values must contain at least one positive and one negative value.
4522
- * @param {*} dates A schedule of payment dates that corresponds to the cash flow payments. Dates may occur in any order. Dates should be entered by using the DATE function, or as results of other formulas or functions. For example, use DATE(2008,5,23) for the 23rd day of May, 2008. Problems can occur if dates are entered as text. .
4523
- * @param {*} guess Optional. A number that you guess is close to the result of XIRR.
4524
- * @returns
4525
- */
4526
- export function XIRR(values: any, dates: any, guess: any): any;
4527
- export function XLOOKUP(search_key: any, lookup_range: any, result_range: any, isColV: any, missing_value: any, match_mode: any, search_mode: any): any;
4528
- /**
4529
- * Returns the net present value for a schedule of cash flows that is not necessarily periodic.
4530
- *
4531
- * Category: Financial
4532
- *
4533
- * @param {*} rate The discount rate to apply to the cash flows.
4534
- * @param {*} values A series of cash flows that corresponds to a schedule of payments in dates. The first payment is optional and corresponds to a cost or payment that occurs at the beginning of the investment. If the first value is a cost or payment, it must be a negative value. All succeeding payments are discounted based on a 365-day year. The series of values must contain at least one positive value and one negative value.
4535
- * @param {*} dates A schedule of payment dates that corresponds to the cash flow payments. The first payment date indicates the beginning of the schedule of payments. All other dates must be later than this date, but they may occur in any order.
4536
- * @returns
4537
- */
4538
- export function XNPV(rate: any, values: any, dates: any): number | Error;
4539
- /**
4540
- * Returns a logical exclusive OR of all arguments.
4541
- *
4542
- * Category: Logical
4543
- *
4544
- * @param {*} args logical1, logical2,… Logical 1 is required, subsequent logical values are optional. 1 to 254 conditions you want to test that can be either TRUE or FALSE, and can be logical values, arrays, or references.
4545
- * @returns
4546
- */
4547
- export function XOR(...args: any[]): any;
4548
- /**
4549
- * Converts a serial number to a year.
4550
- *
4551
- * Category: Date and time
4552
- *
4553
- * @param {*} serial_number The date of the year you want to find.
4554
- * @returns
4555
- */
4556
- export function YEAR(serial_number: any): any;
4557
- /**
4558
- * Returns the year fraction representing the number of whole days between start_date and end_date.
4559
- *
4560
- * Category: Date and time
4561
- *
4562
- * @param {*} start_date A date that represents the start date.
4563
- * @param {*} end_date A date that represents the end date.
4564
- * @param {*} basis Optional. The type of day count basis to use.
4565
- * @returns
4566
- */
4567
- export function YEARFRAC(start_date: any, end_date: any, basis: any): number | Error;
4568
- export function YIELD(...args: any[]): Promise<any>;
4569
- export namespace Z {
4570
- /**
4571
- * Returns the one-tailed probability-value of a z-test.
4572
- *
4573
- * Category: Statistical
4574
- *
4575
- * @param {*} array The array or range of data against which to test x.
4576
- * @param {*} x The value to test.
4577
- * @param {*} sigma Optional. The population (known) standard deviation. If omitted, the sample standard deviation is used.
4578
- * @returns
4579
- */
4580
- function TEST(array: any, x: any, sigma: any): number | Error;
4581
- }
4582
- /**
4583
- * Returns the one-tailed probability-value of a z-test.
4584
- *
4585
- * Category: Statistical
4586
- *
4587
- * @param {*} array The array or range of data against which to test x.
4588
- * @param {*} x The value to test.
4589
- * @param {*} sigma Optional. The population (known) standard deviation. If omitted, the sample standard deviation is used.
4590
- * @returns
4591
- */
4592
- export function ZTEST(array: any, x: any, sigma: any): number | Error;
4593
- export namespace utils {
4594
- export { errors };
4595
- export { symbols };
4596
- export { date };
4597
- }
4598
- declare var errors: Readonly<{
4599
- __proto__: any;
4600
- data: Error;
4601
- div0: Error;
4602
- error: Error;
4603
- na: Error;
4604
- name: Error;
4605
- nil: Error;
4606
- num: Error;
4607
- ref: Error;
4608
- value: Error;
4609
- }>;
4610
- declare var symbols: Readonly<{
4611
- __proto__: any;
4612
- ADD: typeof ADD;
4613
- DIVIDE: typeof DIVIDE;
4614
- EQ: typeof EQ;
4615
- GT: typeof GT;
4616
- GTE: typeof GTE;
4617
- LT: typeof LT;
4618
- LTE: typeof LTE;
4619
- MINUS: typeof MINUS;
4620
- MULTIPLY: typeof MULTIPLY;
4621
- NE: typeof NE;
4622
- POW: typeof POW;
4623
- }>;
4624
- declare var date: Readonly<{
4625
- __proto__: any;
4626
- dateToSerial: typeof dateToSerial;
4627
- formatDate: typeof formatDate;
4628
- readonly returnSerial: boolean;
4629
- serialToDate: typeof serialToDate;
4630
- useDate: typeof useDate;
4631
- useSerial: typeof useSerial;
4632
- }>;
4633
- /**
4634
- * Following functions are part of Formula.js only and not found in Excel.
4635
- * Purpose of these functions is to implement an Excel like behaviour for fundamental math symbols such as +, -, /, *, etc.
4636
- */
4637
- /**
4638
- * Formula.js only.
4639
- *
4640
- * @param {*} num1
4641
- * @param {*} num2
4642
- * @returns
4643
- */
4644
- declare function ADD(num1: any, num2: any, ...args: any[]): any;
4645
- /**
4646
- * Formula.js only
4647
- *
4648
- * @param {*} dividend
4649
- * @param {*} divisor
4650
- * @returns
4651
- */
4652
- declare function DIVIDE(dividend: any, divisor: any, ...args: any[]): any;
4653
- /**
4654
- * Formula.js only
4655
- *
4656
- * @param {*} value1
4657
- * @param {*} value2
4658
- * @returns
4659
- */
4660
- declare function EQ(value1: any, value2: any, ...args: any[]): boolean | Error;
4661
- /**
4662
- * Formula.js only
4663
- *
4664
- * @param {*} num1
4665
- * @param {*} num2
4666
- * @returns
4667
- */
4668
- declare function GT(num1: any, num2: any, ...args: any[]): any;
4669
- /**
4670
- * Formula.js only
4671
- *
4672
- * @param {*} num1
4673
- * @param {*} num2
4674
- * @returns
4675
- */
4676
- declare function GTE(num1: any, num2: any, ...args: any[]): any;
4677
- /**
4678
- * Formula.js only
4679
- *
4680
- * @param {*} num1
4681
- * @param {*} num2
4682
- * @returns
4683
- */
4684
- declare function LT(num1: any, num2: any, ...args: any[]): any;
4685
- /**
4686
- * Formula.js only
4687
- *
4688
- * @param {*} num1
4689
- * @param {*} num2
4690
- * @returns
4691
- */
4692
- declare function LTE(num1: any, num2: any, ...args: any[]): any;
4693
- /**
4694
- * Formula.js only
4695
- *
4696
- * @param {*} num1
4697
- * @param {*} num2
4698
- * @returns
4699
- */
4700
- declare function MINUS(num1: any, num2: any, ...args: any[]): any;
4701
- /**
4702
- * Formula.js only
4703
- *
4704
- * @param {*} factor1
4705
- * @param {*} factor2
4706
- * @returns
4707
- */
4708
- declare function MULTIPLY(factor1: any, factor2: any, ...args: any[]): any;
4709
- /**
4710
- * Formula.js only
4711
- *
4712
- * @param {*} value1
4713
- * @param {*} value2
4714
- * @returns
4715
- */
4716
- declare function NE(value1: any, value2: any, ...args: any[]): boolean | Error;
4717
- /**
4718
- * Formula.js only
4719
- *
4720
- * @param {*} base
4721
- * @param {*} exponent
4722
- * @returns
4723
- */
4724
- declare function POW(base: any, exponent: any, ...args: any[]): any;
4725
- declare function dateToSerial(date: any): number;
4726
- declare function formatDate(date: any): string;
4727
- declare function serialToDate(serial: any): Date;
4728
- declare function useDate(): void;
4729
- declare function useSerial(): void;
4730
- export { MINUS$1 as MINUS };