Skip to main content

Array Filter

This node will take an array of items as input and output a filtered version of the items. Look at the Filter section below to find information on how to create filters.

Inputs

General

DataDescription
EnabledThe filtering is enabled by default, if disabled the array will simply pass through unfiltered.
ItemsThe array that should be filtered.
Use LimitEnables or disables limiting the number of objects in the outputted items array.
LimitSpecify the maximum number of objects in the filtered output.
SkipSpecify the number of objects to skip from the beginning of the filtered output.
SignalDescription
FilterBy default the node will filter as soon as there is a new array on the Items input or if that array changes. But if there is a connection to the Filter input it will wait until a signal is sent here to perform the filtering.

Filter

By default the Array Filter node will pass through all objects of the input array. You can filter on Object properties. Add which properties you want to filter on.

For each filter property you can specify:

Type The type you want for the filter, can be Number, String or Boolean.

Op The available operations of the filter depend on the type that is set.

  • Equals Include in filter if the property equals the provided value. Available for all types.
  • Not Equals Include in filter if the property does NOT equal the provided value. Available for all types.
  • Greater than Include in filter if the property is greater than the provided value. Only available if type is Number.
  • Less than Include in filter if the property is less than the provided value. Only available if type is Number.
  • Greater than or equal Include in filter if the property is greater than or equal to the provided value. Only available if type is Number.
  • Less than or equal Include in filter if the property is less than or equal to the provided value. Only available if type is Number.
  • Matches Regexp Match a regexp to the provided value. Available if type is String

?> To perform a free text search on strings, use the Matches Regexp operation and set the Value to the partial string you want to search for.

Value <##input:filterFilterValue-*##>The value used to test against in the filter operation.

Sort

By default the Array Filter node does not sort the output, it will be in the same order as the input. You can specify sorting. Like filters you simply add which properties you want to sort on. For each property you can choose the sorting order.

Outputs

General

DataDescription
ItemsThe filtered and sorted array.
CountThe number of objects in the filtered array.
First Item IdThe Id of the first object in the filtered array, or undefined if there are no items in the filtered array.
SignalDescription
FilteredSignal emitted when the array has been filtered, either due to a Filter signal sent or if the array has changed.