min
This function is used by Ignition's Expression language.
Description​
Finds and returns the minimum value in the given column of the given dataset, or the min value in a series of numbers specified as arguments. When looking up the min in a dataset, the column may be specified as an index or as a column name. Any null values in the column are ignored.
Syntax (index)​
min(dataset, columnIndex)
Parameters​
| Type | Parameter | Description |
|---|---|---|
| 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. |
Returns​
Integer - The minimum value in that column.
Syntax (name)​
min(dataset, columnName)
Parameters​
| Type | Parameter | Description |
|---|---|---|
| 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. |
Returns​
Integer - The minimum value in that column.
Syntax (value)​
min(value[, value...])
Parameters​
| Type | Parameter | Description |
|---|---|---|
| Integer/Float | value | A number. Can be as many values as needed. Can be either a float or an integer. |
Returns​
Integer - The minimum value in the list of values.
Syntax (sequence)​
New in 8.1.8
The following overload was added in 8.1.8:min(sequence)
Parameters​
| Type | Parameter | Description |
|---|---|---|
| Sequence | sequence | A list, tuple, array, or set of numerical values. |
Returns​
Integer - The minimum 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
min({Root Container.Table.data}, 1) //... would return 120
Code Snippet
min(0, 10/2, 3.14) //... would return 0
Code Snippet
min({SomeValue}, 180) //This example is a great way to make sure a value never goes above 180