ArcadeExpression QML Type

An Arcade expression object containing an expression, a name, a return type, and a title. More...

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

List of all members, including inherited members

Properties

expression : string
json : jsobject
name : string
returnType : Enums.ArcadeExpressionReturnType
title : string

Signals

expressionChanged()
nameChanged()
returnTypeChanged()
titleChanged()

Methods

bool equals(ArcadeExpression other)

Detailed Description

An ArcadeExpression object gathers an Arcade script expression together with:

expression - The Arcade expression to be evaluated. If set to an empty expression string then the evaluation will return zero, false, an empty string, or null, depending on whether the l {Enums.ArcadeExpressionReturnType} is Enums.ArcadeExpressionReturnTypeNumber, Enums.ArcadeExpressionReturnTypeBoolean, Enums.ArcadeExpressionReturnTypeString, or anything else, respectively.
title - The title of the expression.
name - The name of the expression.
returnType - Specify the type to cast the evaluated value to.

See also JsonSerializable.

Property Documentation

expression : string

The Arcade expression string.

json : jsobject

JSON that can be used to instantiate the type instance.

name : string

The name that the author uses to refer to the expression.

If not set explicitly, then the default is an empty name string.

returnType : Enums.ArcadeExpressionReturnType

The expected return type of the expression.

If the Arcade expression creates results of a different type (e.g., a Date or an Array), then the result will be cast to the expected return type. If no sensible cast can be carried out, then the result will be then the result will be null.

title : string

The title that the author uses to describe the expression.

If not set explicitly, then the default is an empty title string.

Signal Documentation

expressionChanged()

Emitted when the expression property changes.

Note: The corresponding handler is onExpressionChanged.

nameChanged()

Emitted when the name property changes.

Note: The corresponding handler is onNameChanged.

returnTypeChanged()

Emitted when the returnType property changes.

Note: The corresponding handler is onReturnTypeChanged.

titleChanged()

Emitted when the title property changes.

Note: The corresponding handler is onTitleChanged.

Method Documentation

bool equals(ArcadeExpression other)

Tests if two ArcadeExpression objects are equal.

other - The second object.

Returns true if this and other are equivalent, false otherwise.