Filter by Expression

Tool icon Available in real-time and big data analytics.

The Filter by Expression tool Filter by Expression tool filters features by an attribute expression using the Arcade expression language. Each feature is evaluated by the expression specified. Features that the specified expression evaluates as true are retained.

Examples

The following are example uses of the Filter by Expression tool:

  • A real-time analytic uses the Filter by Expression tool to retain only the incoming records from a feed in which $feature.horizontal_accuracy < 15.
  • A big data analytic uses the Filter by Expression tool to retain only features in which $feature.description == 'Excellent Condition'.

Usage note

Filter data by defining Arcade expressions. To learn more about Arcade expressions, see Use Arcade expressions.

Parameters

The following are the parameters for the Filter by Expression tool:

ParameterDescriptionData type

Input Layer

The layer in which features will be filtered.

Features

Expression

An attribute expression that will be evaluated to filter the incoming data. The expression is configured in the Arcade expression builder, accessed by clicking Configure an Arcade Expression.

Each record is evaluated. Records that evaluate to true are retained, and those that evaluate to false are discarded.

String (Arcade expression)

Output layer

The Filter by Expression tool does not alter incoming features; the output layer will contain the same fields and attribute values as the incoming features.