ArcadeExpression

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

Link copied to clipboard
constructor(expression: String, title: String = "", name: String = "", returnType: ArcadeExpressionReturnType = ArcadeExpressionReturnType.Automatic)

Creates a new ArcadeExpression object.

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The Arcade expression string.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Inherited functions

Link copied to clipboard
open override fun toJson(): String

Convert an object to JSON string.