groupConcat
This function is used by Ignition's Expression language.
Description​
Concatenates all of the values in the given column of the given dataset into a string, with each value separated by the string separator. Any null values in the column are ignored.
Concatenation for collections is now supported with the collection syntax.
Syntax (index)​
groupConcat(dataset, columnIndex, separator)
Parameters​
| Type | Parameter | Description |
|---|---|---|
| Dataset | dataset | The starting dataset. |
| Integer | columnIndex | The index of the column to concatenate. |
| String | separator | What will be used to separate each of the values. |
Returns​
String - A string with every value in the specified column of the specified dataset separated by the separator value.
Syntax (name)​
groupConcat(dataset, columnName, separator)
Parameters​
| Type | Parameter | Description |
|---|---|---|
| Dataset | dataset | The starting dataset. |
| String | columnName | The name of the column to concatenate. |
| String | separator | What will be used to separate each of the values. |
Returns​
String - A string with every value in the specified column of the specified dataset separated by the separator value.
Syntax (collection)​
groupConcat(collection, separator)
Parameters​
| Type | Parameter | Description |
|---|---|---|
| Collection | collection | The starting list, tuple, or set to use. |
| String | separator | What will be used to separate each of the values. |
Returns​
String - A string with every value in the specified collection separated by the separator value.
Examples​
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 |
groupConcat({Root Container.Table.data}, 1, " / ")
//returns the string: "380 / 120 / 125 / 322"
groupConcat({Root Container.Table.data}, "ProductCode", ", ")
//returns the string: "BAN_002, BAN_010, APL_000, FWL_220"