ArcadeLabelExpression QML Type

  • Esri.ArcGISRuntime
  • ArcadeLabelExpression
  • An expression script using the Arcade language. More...

    Import Statement: import Esri.ArcGISRuntime
    Since: Esri.ArcGISRuntime 100.11
    Inherits:

    LabelExpression

    Properties

    Signals

    Detailed Description

    The label Arcade expression expects to hold a valid, Arcade script and to be read and evaluated by an Arcade expression interpreter. 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 https://links.esri.com/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.

    Note: If the expression attempts to use attributes that 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.

    This QML type supports the following default properties. A default property may be declared inside another declared object without being assigned explicitly to a property.

    TypeDefault Property
    ArcadeExpressionarcadeExpression

    Property Documentation

    [default] arcadeExpression : ArcadeExpression

    An ArcadeExpression containing the Arcade expression script to use.

    The expression is expected to be a complete, self-contained Arcade script that calculates a text string.

    The ArcadeExpression::expression property of arcadeExpression is the same script string as LabelExpression::expression. Changing one will change the other.


    Signal Documentation

    arcadeExpressionChanged()

    Emitted when the arcadeExpression property changes.

    Note: The corresponding handler is onArcadeExpressionChanged.


    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.