Selects only items in a list that meet a set of criteria.
Purpose
Selects only items in a list that meet a set of criteria. The keyword 'value' should be used (and NOT in curly braces) to represent the list item being compared.
Compatibility
The macro can be used in all input document types and in Report Studio.
Behaviour (10)
| Parameter | Type | Presence | Purpose | Options | Default |
| String | Optional | Post processing formula. Use {value} for the macro output, e.g. {value}/1024. | N/A | N/A | |
| Boolean | Optional | Should NCalc expression evaluation throw error on Overflow |
|
true | |
| String | Optional | The macro is considered 'fatal' if the expression evaluates to true. Use 'value' as the macro output in the expression. | N/A | N/A | |
| Boolean | Optional | Whether to hide the macro output. |
|
false | |
| String | Optional | The condition that must be true in order for the macro to be executed/evaluated. Must either evaluate to true or false, for example: "3+5=8" or "contains('abcd', 'z'). | N/A | true | |
| MacroMode | Optional | The mode in which variables are stored. In the legacy mode (default for Schedules), the variable created is a string and formatted. In the normal mode (default for Report Studio), the output variable is stored as a strongly-typed theObject, e.g. an Int32 or a List |
|
Legacy | |
| ObfuscationType | Optional | Obfuscation type. Use obfuscation to write reports where sensitive data is hidden. When used, ReportMagic guarantees that the same input string will map to the same output string for the whole of the report (but the next time the report runs, it will most likely map to a different value). If you use obfuscation, the property in your macro will not show up and instead, you will see a fake item of the obfuscation type chosen. |
|
None | |
| Boolean | Optional | Whether substituted variables are hidden from macro results (and the word 'REDACTED' will appear in progress screens and elsewhere in the web UI). |
|
false | |
| Boolean | Optional | Whether to trim leading and trailing whitespace on input items. The trim operation is done BEFORE other operators such as selecting distinct items or sorting. |
|
false | |
| String | Optional | If specified, adds a warning message for this macro. This is processed as an NCalc, and the warning message will ALWAYS be present and will be the value of the evaluated NCalc expression. | N/A | N/A |
Colours (6)
| Parameter | Type | Presence | Purpose | Options | Default |
| Boolean | Optional | Whether to color table cells if thresholds are breached, rather than color the text. |
|
true | |
| Color | Optional | The font background color to use. |
|
N/A | |
| Color | Optional | The font color to use. |
|
N/A | |
| Color | Optional | The normal font background color to use. If omitted, no change is made. |
|
N/A | |
| Color | Optional | The normal font color to use. If omitted, no change is made. |
|
N/A | |
| Color | Optional | The normal table cell background color to use. If omitted, no change is made. |
|
N/A |
Formatting (5)
| Parameter | Type | Presence | Purpose | Options | Default |
| Boolean | Optional | Change the font weight (true=strong, false=normal). If omitted, no change is made. |
|
N/A | |
| Double | Optional | Change the font size in points. If omitted, no change is made. |
|
N/A | |
| String | Optional | The formatting to use for numbers. You can also specify 'format=string' to force numbers to be treated as strings. | N/A | N/A | |
| Boolean | Optional | Change the normal font weight (true=strong, false=normal). If omitted, no change is made. |
|
N/A | |
| Double | Optional | Change the normal font size in points. If omitted, no change is made. |
|
N/A |
Conditional Formatting (69)
| Parameter | Type | Presence | Purpose | Options | Default |
| DateTimeOffset | Optional | The macro is considered 'critical' if the output is after this DateTime UTC. | N/A | N/A | |
| DateTimeOffset | Optional | The macro is considered 'critical' if the output is before this DateTime UTC. | N/A | N/A | |
| String | Optional | The macro is considered 'critical' if the output is equal to this value. | N/A | N/A | |
| Color | Optional | The critical font background color to use. If omitted, no change is made. |
|
N/A | |
| Boolean | Optional | Change the font weight (true=strong, false=normal). If omitted, no change is made. |
|
N/A | |
| Color | Optional | The critical font color to use. If omitted, no change is made. |
|
N/A | |
| Double | Optional | Change the critical font size in points. If omitted, no change is made. |
|
N/A | |
| String | Optional | The macro is considered 'critical' if the output is greater than or equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'critical' if the output is greater than this value. | N/A | N/A | |
| String | Optional | The macro is considered 'critical' if the expression evaluates to true. Use 'value' as the macro output in the expression. | N/A | N/A | |
| String | Optional | The macro is considered 'critical' if the output is less than or equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'critical' if the output is less than this value. | N/A | N/A | |
| String | Optional | The macro is considered 'critical' if the output is not equal to this value. | N/A | N/A | |
| Color | Optional | The critical table cell background color to use. |
|
N/A | |
| DateTimeOffset | Optional | The macro is considered 'error' if the output is after this DateTime UTC. | N/A | N/A | |
| DateTimeOffset | Optional | The macro is considered 'error' if the output is before this DateTime UTC. | N/A | N/A | |
| String | Optional | The macro is considered 'error' if the output is equal to this value. | N/A | N/A | |
| Color | Optional | The error font background color to use. If omitted, no change is made. |
|
N/A | |
| Boolean | Optional | Change the error font weight (true=strong, false=normal). If omitted, no change is made. |
|
N/A | |
| Color | Optional | The error font color to use. If omitted, no change is made. |
|
N/A | |
| Double | Optional | Change the error font size in points. If omitted, no change is made. |
|
N/A | |
| String | Optional | The macro is considered 'error' if the output is greater than or equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'error' if the output is greater than this value. | N/A | N/A | |
| String | Optional | The macro is considered 'error' if the expression evaluates to true. Use 'value' as the macro output in the expression. | N/A | N/A | |
| String | Optional | The macro is considered 'error' if the output is less than or equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'error' if the output is less than this value. | N/A | N/A | |
| String | Optional | The macro is considered 'error' if the output is not equal to this value. | N/A | N/A | |
| Color | Optional | The error table cell background color to use. |
|
N/A | |
| DateTimeOffset | Optional | The macro is considered 'fatal' if the output is after this DateTime UTC. | N/A | N/A | |
| DateTimeOffset | Optional | The macro is considered 'fatal' if the output is before this DateTime UTC. | N/A | N/A | |
| String | Optional | The macro is considered 'fatal' if the output is equal to this value. | N/A | N/A | |
| Color | Optional | The fatal font background color to use. If omitted, no change is made. |
|
N/A | |
| Boolean | Optional | Change the fatal font weight (true=strong, false=normal). If omitted, no change is made. |
|
N/A | |
| Color | Optional | The fatal font color to use. If omitted, no change is made. |
|
N/A | |
| Double | Optional | Change the fatal font size in points. If omitted, no change is made. |
|
N/A | |
| String | Optional | The macro is considered 'fatal' if the output is greater than or equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'fatal' if the output is greater than this value. | N/A | N/A | |
| String | Optional | The macro is considered 'fatal' if the output is less than or equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'fatal' if the output is less than this value. | N/A | N/A | |
| String | Optional | The macro is considered 'fatal' if the output is not equal to this value. | N/A | N/A | |
| Color | Optional | The fatal table cell background color to use. |
|
N/A | |
| DateTimeOffset | Optional | The macro is considered 'info' if the output is after this DateTime UTC. | N/A | N/A | |
| DateTimeOffset | Optional | The macro is considered 'info' if the output is before this DateTime UTC. | N/A | N/A | |
| String | Optional | The macro is considered 'info' if the output is equal to this value. | N/A | N/A | |
| Color | Optional | The info font background color to use. If omitted, no change is made. |
|
N/A | |
| Boolean | Optional | Change the info font weight (true=strong, false=normal). If omitted, no change is made. |
|
N/A | |
| Color | Optional | The info font color to use. If omitted, no change is made. |
|
N/A | |
| Double | Optional | Change the info font size in points. If omitted, no change is made. |
|
N/A | |
| String | Optional | The macro is considered 'info' if the output is greater than or equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'info' if the output is greater than this value. | N/A | N/A | |
| String | Optional | The macro is considered 'info' if the expression evaluates to true. Use 'value' as the macro output in the expression. | N/A | N/A | |
| String | Optional | The macro is considered 'info' if the output is less than or equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'info' if the output is less than this value. | N/A | N/A | |
| String | Optional | The macro is considered 'info' if the output is not equal to this value. | N/A | N/A | |
| Color | Optional | The info table cell background color to use. |
|
N/A | |
| DateTimeOffset | Optional | The macro is considered 'warning' if the output is after this DateTime UTC. | N/A | N/A | |
| DateTimeOffset | Optional | The macro is considered 'warning' if the output is before this DateTime UTC. | N/A | N/A | |
| String | Optional | The macro is considered 'warning' if the output is equal to this value. | N/A | N/A | |
| Color | Optional | The warning font background color to use. If omitted, no change is made. |
|
N/A | |
| Boolean | Optional | Change the warning font weight (true=strong, false=normal). If omitted, no change is made. |
|
N/A | |
| Color | Optional | The warning font color to use. If omitted, no change is made. |
|
N/A | |
| Double | Optional | Change the warning font size in points. If omitted, no change is made. |
|
N/A | |
| String | Optional | The macro is considered 'warning' if the output is greater than or equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'warning' if the output is greater than this value. | N/A | N/A | |
| String | Optional | The macro is considered 'warning' if the expression evaluates to true. Use 'value' as the macro output in the expression. | N/A | N/A | |
| String | Optional | The macro is considered 'warning' if the output is less than or equal to this value. | N/A | N/A | |
| String | Optional | The macro is considered 'warning' if the output is less than this value. | N/A | N/A | |
| String | Optional | The macro is considered 'warning' if the output is not equal to this value. | N/A | N/A | |
| Color | Optional | The warning table cell background color to use. |
|
N/A |
Filtering & Sorting (10)2 additional
| Parameter | Type | Presence | Purpose | Options | Default |
| String | Optional | The name of the variable representing the current list item in the 'comparisonLambda' expression. | N/A | item | |
| String | Optional | An NCalc expression evaluated per item to extract the sort key. Use the variable name specified in 'comparisonItemName' (default 'item') to refer to the current list item. Supports functions like jPath() for accessing properties with special characters (e.g. dots in names). Cannot be used together with 'comparisons'. | N/A | N/A | |
| List<String> | Optional | In 'normal' mode only, the comparisons that are jsonPaths. For multiple items, separate by a semi-colon e.g. property1;property2;... | N/A | N/A | |
| String | Optional | The condition that must be true, using 'value'. | N/A | N/A | |
| List<Int32> | Optional | The semicolon-separated ordered list of columns to order by. The first is 0. e.g. 0;2;1 | N/A | N/A | |
| List<String> | Optional | The semicolon-separated order directions. Each must be one of: Ascending, Asc, Descending or Desc. When 'comparisonLambda' is used, the default is Asc (not None) since providing a lambda implies sorting is desired. Only the first value is used with 'comparisonLambda'. | N/A | None | |
| Int32 | Optional | The number of items AFTER the sort to skip. | N/A | 0 | |
| List<String> | Optional | The semicolon-separated sort types. Each must be one of Alphanumeric, Numeric or Auto. The default (Auto) will attempt a numeric sort if all the values are numeric, otherwise falls back to alphanumeric. | N/A | Auto | |
| StringListSortType | Optional | The sort method to use. This can be used to adjust the sort order used by the system. |
|
OrdinalIgnoreCase | |
| Int32 | Optional | The number of items AFTER the sort to take. | N/A | 2147483647 |
Output (1)9 additional
| Parameter | Type | Presence | Purpose | Options | Default |
| Char | Optional | The index delimiter. | N/A | ^ |
Additional (9)
| Parameter | Type | Presence | Purpose | Options | Default |
| Char | Optional | The delimiter character to delimit text-based input lists (e.g. 1;2;3;4). When this parameter is set and 'listDelimiter' is NOT set, this acts as both the input and output list delimiter. | N/A | ; | |
| String | Optional | The text to display should the macro fail to execute. Note that a poorly-specified macro (e.g. omitting mandatory parameters) will still result in an error message. | N/A | N/A | |
| String | Optional | The name of a variable to create should the macro fail to execute. The variable will be a text variable, and will contain either the failure text (only if the failureText parameter is set), otherwise it will contain the exception / failure message. | N/A | N/A | |
| Char | Optional | In Legacy Mode only, the delimiter character to delimit the output list, UNLESS only 'delimiter' is set, in which case 'delimiter' acts as both the input and output list delimiter. | N/A | ; | |
Normal mode |
Boolean | Optional | Any macros that output lists can optionally (in Normal mode) output a jArray instead. |
|
true |
| String | Optional | The variable to store the result as. | N/A | N/A | |
| String | Optional | The variable to store the result as, while hiding the output. Equivalent to 'storeAs=ThisValue, hidden=true'. | N/A | N/A | |
| Char | Optional | The delimiter used by storeAs to split the input (Legacy mode only), when there are multiple stored variables. For example, in this macro, we indicate that the value to be stored should be split by the asterisk when being stored: [String:value=a*b*c*d, storeAs=var1;var2;var3;var4, storeAsVariableDelimiter=*] | N/A | ; | |
| String | Optional | The name of the STRING variable to store the result as and output (both will use the same format) into the report. Note that if you also use 'storeAsHidden' in the same macro, you should not expect the output to be hidden, as this parameter overrides that. | N/A | N/A |
General (6)
| Parameter | Type | Presence | Purpose | Options | Default |
| List<Object> | Mandatory | The list of input values. In Legacy Mode, they should be split by the delimiter character. | N/A | N/A | |
| String | Optional | Add a comment to make your document template more readable. The comment is discarded in the output document. | N/A | N/A | |
| List<ExecutionResult> | Optional | If specified, asserts the expected execution result of the macro. Accepts a single value or a semicolon-separated list of acceptable values (e.g. 'Success;Warning'). The macro executes normally; if the actual result matches any of the desired values, the result is converted to Success. If the actual result does not match, the result is converted to MacroError with a descriptive message. This is primarily used for testing and diagnostic purposes. Valid values are: Unknown, Success, MacroError, WorkerStopped, Running, Warning, NeverRun, Cancelled, Pending, Paused, SystemError, Deferred, Stopped. |
|
N/A | |
| String | Optional | If specified, asserts the expected output type of the macro result. The macro executes normally; if the actual type does not match, a macro error is generated. Requires 'storeAs', 'storeAsHidden', or 'storeFormattedValueAs' to be set for typed validation. Valid types include CLR names (e.g. Int32, Int64, Single, Double, Boolean, String, JArray, JObject) and C# keyword aliases (e.g. int, long, float, double, bool, string, uint, ulong, short, ushort, byte, sbyte, decimal, char, object). The special value 'Number' matches any numeric type. | N/A | N/A | |
| String | Optional | If specified, asserts the expected output value of the macro result. The macro executes normally; if the actual value does not match, a macro error is generated. When 'storeAs' or 'storeAsHidden' is set, the stored variable value is compared. Otherwise, the document output text is compared. | N/A | N/A | |
Normal mode |
Boolean | Optional | In Normal Mode and for macros that output JArrays only, whether to convert a JArray of single-property jObjects into a flat JArray of values. |
|
false |
Deprecated (4)
| Parameter | Type | Preferred Parameter | Purpose | Options | Default |
| List<String> | comparisons | In 'normal' mode only, the comparisons that are jsonPaths. For multiple items, separate by a semi-colon e.g. property1;property2;... | N/A | N/A | |
| List<String> | orderDirection | The semicolon-separated order directions. Each must be one of: Ascending, Asc, Descending or Desc. When 'comparisonLambda' is used, the default is Asc (not None) since providing a lambda implies sorting is desired. Only the first value is used with 'comparisonLambda'. | N/A | None | |
| List<Int32> | orderByIndices | The semicolon-separated ordered list of columns to order by. The first is 0. e.g. 0;2;1 | N/A | N/A | |
| List<String> | sortTypes | The semicolon-separated sort types. Each must be one of Alphanumeric, Numeric or Auto. The default (Auto) will attempt a numeric sort if all the values are numeric, otherwise falls back to alphanumeric. | N/A | Auto |
Examples (12)
Example 1Normal mode
This Normal Mode example uses the [Calculate:] macro shorthand [:=] to create a list of strings, then uses [List.Where:] to create an output list variable that contains only the items that match 'banana':
// Use the Calculate macro shorthand to create a list
[=: `list('apple', 'apple', 'banana', 'apple', 'apple', 'banana')`, =>List]
// Find only the items that are 'banana', and store the result in a new list
[List.Where: values={=List}, condition="value == 'banana'", mode=Normal, storeAs=OutputList]Example 2Normal mode
This Normal Mode example creates a list / array of JObjects (each contains pairs of property names and values), then uses [List.Where:] to find matching items where the 'Count' property is greater than 2:
// Create an array of JObjects
[Array:
value=`[
{ "Pet" : "Dog", "Count" : 2 },
{ "Pet" : "Cat", "Count" : 4 },
{ "Pet" : "Fish", "Count" : 4 },
{ "Pet" : "Carrot", "Count" : 3 },
{ "Pet" : "None", "Count" : 1 }
]`,
=>TheArray]
// Select only those JObjects where the 'Count' property is greater than 2
[List.Where: values={=TheArray}, condition="jPath(value,'Count') > 2", mode=normal, storeAs=Result]Example 3
[List.Where: values=1;2;3;4;5, condition="value>2"]Example 4
[List.Where: values=3;2;1, storeAs=a, condition="true", orderDirection=Desc]Example 5
[List.Where: values=3;2;1, storeAs=a, condition="true", orderDirection=Asc]Example 6
[List.Where: values=3;2;1, storeAs=a, condition="false"]Example 7
[List.Where: values=3;2;1, storeAs=a, condition="value > 1", skip=1, take=10]Example 8
[List.Where: values=3;2;1, storeAs=a, condition="value == 1"]Example 9
[List.Where: values=10;2;hg;4;5, condition="value=='hg'"]Example 10
This example shows how to act upon lists of lists with the List.Where macro or the Calculate macro:
// Create a list of lists using the Calculate macro shorthand, each with various items including either 'APPLE' or 'BANANA' as the 4th item (index 3)
[=:`list(list(123, 'xxx', 'yyy', 'APPLE', 'Another item'), list(123, 'xxx', 'yyy', 'APPLE', 'Another item'), list(123, 'xxx', 'yyy', 'BANANA', 'Another item'))`, =>DevicePropertyList]
// Find all the inner items where the 4th item (index 3) is 'APPLE' and save into a variable
[List.Where: values={=DevicePropertyList}, condition=`itemAtIndex(value,3) == 'APPLE'`, =>MatchingProperties1]
// Find all the inner items where the 4th item (index 3) is 'BANANA' and save into a variable
[List.Where: values={=DevicePropertyList}, condition=`itemAtIndex(value,3) == 'BANANA'`, =>MatchingProperties2]
// Find all the inner items where the 4th item (index 3) is not 'BANANA' and save into a variable
[List.Where: values={=DevicePropertyList}, condition=`itemAtIndex(value,3) != 'BANANA'`, =>MatchingProperties3] Example 11Normal mode
This Normal Mode example demonstrates filtering a mixed-type list containing both integers and strings. Only items matching the string 'banana' are selected, while integer items are correctly excluded:
// Use the Calculate macro shorthand to create a mixed-type list containing integers and strings
[=: `list(10, 2, 'banana', 4, 5, 'banana')`, =>List]
// Find only the items that are 'banana', and store the result in a new list
[List.Where: values={=List}, condition="value == 'banana'", mode=Normal, storeAs=OutputList]Example 12Normal mode
This Normal Mode example demonstrates filtering numeric values from a mixed-type list containing both integers and strings. Only items matching the numeric condition are selected, while string items that cannot be compared numerically are correctly excluded:
// Use the Calculate macro shorthand to create a mixed-type list containing integers and strings
[=: `list(100, 'apple', 200, 'apple', 300, 'orange')`, =>List]
// Find only the items that equal 100, and store the result in a new list
[List.Where: values={=List}, condition="value == 100", mode=Normal, storeAs=OutputList]