arcgis-maps-kotlin/com.arcgismaps.arcade/ArcadeExpression

ArcadeExpression

class ArcadeExpression : JsonSerializable

An Arcade expression object, containing an expression, a name, a return type and a title. An ArcadeExpression object gathers an Arcade script expression together with:

The expected return type
The name that a map author uses to refer to it
The title that the author uses to describe the expression

Since

200.1.0

Constructors

ArcadeExpression

constructor(expression: String, title: String = "", name: String = "", returnType: ArcadeExpressionReturnType = ArcadeExpressionReturnType.Automatic)

Creates a new Arcade expression with an expression string, title, name, and return type. If the Arcade expression evaluates to a result which differs from ArcadeExpressionReturnType then the result will be cast to the expected return type.

Types

Companion

object Companion

Properties

expression

val expression: String

The Arcade expression string.

name

val 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

val returnType: ArcadeExpressionReturnType

The expected return type of the expression. If the Arcade expression evaluates to a result which differs from 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 ArcadeExpressionReturnType for details.

title

val title: String

The title that the author uses to describe the expression. If not set explicitly, then the default is an empty title string.

Inherited functions

toJson

open override fun toJson(): String

Convert an object to JSON string.