LARGE
Returns the k-th largest value in a data set. For example, the fifth largest number.
Syntax
expression.LARGE(arg1, arg2);
expression - A variable that represents a ApiWorksheetFunction class.
Parameters
| Name | Required/Optional | Data type | Default | Description |
|---|---|---|---|---|
| arg1 | Required | ApiRange | ApiName | number[] | The array or range of data for which the k-th largest value will be determined. | |
| arg2 | Required | ApiRange | ApiName | number | The position (from the largest) in the array or cell range of data to return. |
Returns
number
Example
- Code
- Result
const worksheet = Api.GetActiveSheet();
let numbersArr = [4, 13, 27, 56, 46, 79, 22, 12];
// Place the numbers in cells
for (let i = 0; i < numbersArr.length; i++) {
worksheet.GetRange("A" + (i + 1)).SetValue(numbersArr[i]);
}
let func = Api.GetWorksheetFunction();
let range = worksheet.GetRange("A1:A8");
let largePostion = 4;
let kLargest = func.LARGE(range, largePostion);
worksheet.GetRange("C1").SetValue(kLargest);