An Arcade expression object containing an expression, a name, a return type, and a title. More...
Import Statement: | import Esri.ArcGISRuntime |
Since: | Esri.ArcGISRuntime 100.11 |
Inherits: |
- List of all members, including inherited members
- ArcadeExpression is part of QML Type List.
Properties
- expression : string
- json : jsobject
- name : string
- returnType : Enums.ArcadeExpressionReturnType
- title : string
- unknownJson : jsobject
- unsupportedJson : jsobject
Signals
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 evaluates to a result which differs from Enums.ArcadeExpressionReturnType then the result will be cast to the expected return type. If the cast cannot be carried out, the result will be a type-specific error value. See Enums.ArcadeExpressionReturnType for details.
title : string |
The title that the author uses to describe the expression.
If not set explicitly, then the default is an empty title string.
[read-only] unknownJson : jsobject |
Returns the unknown JSON from the source JSON.
[read-only] unsupportedJson : jsobject |
Returns the unsupported data from the source JSON.
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.