ArcadeLabelExpression

An expression script using the Arcade language. The Arcade label expression property must contain a syntactically correct Arcade script expression.

An example expression that combines text with a field value is

"State: " + $feature.State_Name

Note that quotes are needed around the literal text. See ArcGIS Arcade for full documentation on the Arcade scripting language and its function library.

Any Arcade functions allowed for the Labeling profile can be used in a label arcade expression. Other functions (for example, FeatureSet functions) are potentially too slow to be used in a dynamic label evaluation. Warning: If the expression attempts to use attributes which don't exist then no label will be produced. This is distinct from the attribute existing but having a null or empty value, which can form part of the produced text label.

Since

200.1.0

Constructors

Link copied to clipboard
constructor(arcadeExpression: ArcadeExpression)

Creates a label arcade expression object using the com.arcgismaps.arcade.ArcadeExpression.expression.

constructor(arcadeString: String = "")

Creates a label arcade expression object with a specified Arcade expression script string.

Inherited properties

Link copied to clipboard

The label expression script string. The expression is expected to be a complete, self-contained label expression in the language specified by the label expression subclass object. Warning: If the expression attempts to use attributes which don't exist then no label will be produced. This is distinct from the attribute existing but having a null or empty value, which can form part of the produced text label.

Functions

Link copied to clipboard
open override fun clone(): ArcadeLabelExpression