MAXA
Returns the largest value in a set of values. Does not ignore logical values and text.
Syntax
expression.MAXA(args);
expression - A variable that represents a ApiWorksheetFunction class.
Parameters
| Name | Required/Optional | Data type | Default | Description |
|---|---|---|---|---|
| args | Required | number | string | boolean | (number | string | boolean)[] | ApiRange | ApiName | Up to 255 values (number, text, logical value) for which the largest value will be returned. The first argument is required, subsequent arguments are optional. Arguments can be numbers, logical values and text representations of numbers, names, ranges, or arrays. |
Returns
number
Example
This example shows how to return the largest value in a set of values. Does not ignore logical values and text.
- Code
- Result
// How to get a maximum from a list including text and logical values.
// Use a function to find a maximum from a list of objects.
const worksheet = Api.GetActiveSheet();
let range = worksheet.GetRange("A1:A5").GetValue();
let func = Api.GetWorksheetFunction();
let maxA = func.MAX(23, 45, true, "text", 0.89);
worksheet.GetRange("C1").SetValue(maxA);