QUARTILE
Returns the quartile of a data set.
Syntax
expression.QUARTILE(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 cell range of numeric values for which the quartile value will be returned. | |
| arg2 | Required | ApiRange | ApiName | number | The quartile value to return: minimum value = 0; 1st quartile = 1; median value = 2; 3rd quartile = 3; maximum value = 4. |
Returns
number
Example
- Code
- Result
const worksheet = Api.GetActiveSheet();
let valueArr1 = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12];
let quart = 3; //eg: third quartile (75th percentile)
// Place the numbers in cells
for (let i = 0; i < valueArr1.length; i++) {
worksheet.GetRange("A" + (i + 1)).SetValue(valueArr1[i]);
}
//method params
let array = worksheet.GetRange("A1:A12");
let func = Api.GetWorksheetFunction();
let ans = func.QUARTILE(array, quart);
worksheet.GetRange("C1").SetValue(ans);