max

This function is used by Ignition's Expression language.

Description

Finds and returns the maximum value in the given column of the given dataset, or the max value in a series of numbers specified as arguments. When looking up the max in a dataset, the column may be specified as an index or as a column name.

This function expects the datatype of the column to be numeric: other datatypes, such as strings, will throw an exception.

Any null values in the column are ignored. If there are no rows in the dataset, null is returned.

Syntax (index)

max(dataset, columnIndex)

• Parameters

  • DataSet dataset - The dataset to search through.

  • Integer columnIndex - The index of the column to search through. Must be a column index of the provided dataset. Additionally, the datatype of the column must be numeric.

• Returns

  • Integer - The maximum value in that column.

Syntax (name)

max(dataset, columnName)

• Parameters

  • DataSet dataset - The dataset to search through.

  • string columnName - The name of the column to search through. Must match a column name in the provided dataset. Additionally, the datatype of the column must be numeric.

• Returns

  • Integer - The maximum value in that column.

Syntax

max(value[, value...])

• Parameters

  • Integer/Float value - A number. Can be as many values as needed. Can be either a float or an integer.

• Returns

  • Integer - The maximum value in the list of values.

Syntax

New in 8.1.8

The following overload was added in 8.1.8:

max(sequence)

• Parameters

  • Sequence sequence - A list, tuple, array, or set of numerical values.

• Returns

  • Integer - The maximum value in the list of values.

Examples

For example, suppose you had a table with this dataset in it:

ProductCode	Quantity	Weight
BAN_002	380	3.243
BAN_010	120	9.928
APL_000	125	1.287
FWL_220	322	7.889

Code Snippet

max({Root Container.Table.data}, 1) //would return 380

Code Snippet

max(0, 10/2, 3.14) //would return 5. You can also use this function to find the maximum in fixed series of numbers, specified as arguments

Code Snippet

max({SomeValue}, 0) //The following example is a great way to make sure a value never goes below zero