User Manual

GETTING STARTED


OTHER EDITIONS


LAUNCHERS


MODULES


PLATFORM


APPENDIX


TUTORIALS & HELPFUL TRICKS


STRATEGIC PARTNER LINKS

Sepasoft - MES Modules
Cirrus Link - MQTT Modules

RESOURCES

Inductive University
Ignition Demo Project
Knowledge Base Articles
Forum
IA Support

ALL USER MANUAL VERSIONS

Ignition 8.1. Offline Version (04/2021)
Ignition 8 Online Version
Ignition 7.9 Online Version
Ignition 7.8 Online Version

Deprecated Pages

SDK Documentation

Employees

Sign In

Skip to end of metadata
Go to start of metadata

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 data type of the column to be numeric: other data types, such as strings, will throw an exception.

Any null values in the column are ignored. 

Syntax

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 data type of the column must be numeric.

  • Returns

Integer The maximum value in that column.

Syntax

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 data type 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.

The following feature is new in Ignition version 8.1.8
Click here to check out the other new features

The following overload was added in 8.1.8:

Syntax

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 the following 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.
  • No labels