ArcGIS Runtime SDK for iOS: AGSArcadeLabelExpression Class Reference
ArcGIS Runtime SDK for iOS  100.13
AGSArcadeLabelExpression Class Reference

Description

An expression script using the Arcade language. The Arcade label expression property must contain a syntactically correct Arcade script expression. 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://developers.arcgis.com/arcade/ for full documentation on the Arcade scripting language and its function library.

Warning
Any Arcade functions allowed for the Labeling profile can be used in a label Arcade expression. Other functions (for example, AGSFeatureSet functions) are potentially too slow to be used in a dynamic label evaluation.
Since
100.11
Inheritance diagram for AGSArcadeLabelExpression:
AGSLabelExpression AGSObject

Instance Methods

(instancetype) - init
 
(instancetype) - initWithArcadeExpression:
 
(instancetype) - initWithArcadeString:
 

Class Methods

(instancetype) + arcadeLabelExpression
 
(instancetype) + arcadeLabelExpressionWithArcadeExpression:
 
(instancetype) + arcadeLabelExpressionWithArcadeString:
 

Properties

NSString * expression
 

Method Documentation

◆ arcadeLabelExpression

+ (instancetype) arcadeLabelExpression

Creates a label Arcade expression with an empty expression script. An empty script is a valid Arcade expression that will evaluate to an empty string.

Since
100.11

◆ arcadeLabelExpressionWithArcadeExpression:

+ (instancetype) arcadeLabelExpressionWithArcadeExpression: (AGSArcadeExpression *)  arcadeExpression

Creates a label Arcade expression object using the AGSArcadeExpression::expression property.

Parameters
arcadeExpressionAn AGSArcadeExpression object containing the Arcade expression script to use.
Since
100.11

◆ arcadeLabelExpressionWithArcadeString:

+ (instancetype) arcadeLabelExpressionWithArcadeString: (NSString *)  arcadeString

Creates a label Arcade expression object with a specified Arcade expression script string.

Parameters
arcadeStringThe Arcade expression script string.
Since
100.11

◆ init

- (instancetype) init

Creates a label Arcade expression with an empty expression script. An empty script is a valid Arcade expression that will evaluate to an empty string.

Since
100.11

◆ initWithArcadeExpression:

- (instancetype) initWithArcadeExpression: (AGSArcadeExpression *)  arcadeExpression

Creates a label Arcade expression object using the AGSArcadeExpression::expression property.

Parameters
arcadeExpressionAn AGSArcadeExpression object containing the Arcade expression script to use.
Since
100.11

◆ initWithArcadeString:

- (instancetype) initWithArcadeString: (NSString *)  arcadeString

Creates a label Arcade expression object with a specified Arcade expression script string.

Parameters
arcadeStringThe Arcade expression script string.
Since
100.11

Property Documentation

◆ expression

- (NSString*) expression
readwritenonatomiccopyinherited

The label expression script string. The expression is expected to be a complete, self-contained label expression in the language specified by the label expression subclass object.

Since
100.11