Module com.esri.arcgisruntime
Package com.esri.arcgisruntime.arcade
Class ArcadeConsoleMessageContext
java.lang.Object
com.esri.arcgisruntime.arcade.ArcadeConsoleMessageContext
Provides information about the execution context where an Arcade console function is invoked.
- Since:
- 100.14.0
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionGets a dictionary of optional context information where Arcade console function is invoked.Gets theArcadeProfile
which invoked the Arcade console function.
-
Method Details
-
getInformation
Gets a dictionary of optional context information where Arcade console function is invoked.If this is an
ArcadeProfile.ATTRIBUTE_RULE_CONSTRAINT
orArcadeProfile.ATTRIBUTE_RULE_CALCULATION
, expectgetInformation()
to include the following keys:- "ruleName" - The name of the attribute rule which invoked the Arcade console function.
- "tableName" - The name of the
ArcGISFeatureTable
evaluating the attribute rule.
- Returns:
- a dictionary of optional context information where Arcade console function is invoked
- Since:
- 100.14.0
-
getProfile
Gets theArcadeProfile
which invoked the Arcade console function.Arcade console messages may be sent from different execution contexts, for example:
-
ArcadeProfile.ATTRIBUTE_RULE_CONSTRAINT
indicates evaluation of an Attribute Rule Constraint. See documentation for Attribute Rule Constraint. -
ArcadeProfile.ATTRIBUTE_RULE_CALCULATION
indicates evaluation of an Attribute Rule Calculation. See documentation for Attribute Rule Calculation. -
ArcadeProfile.LABELING
indicates evaluation of aLabelDefinition.getExpression()
orLabelAngle.getAngleExpression()
. -
ArcadeProfile.POPUP
indicates evaluation of an expression used to populate popup fields. -
ArcadeProfile.RESTRICTED
indicates no optional functionality is allowed and is the preferred default for anArcadeEvaluator
. -
ArcadeProfile.UNRESTRICTED
indicates optional functionalities are allowed and is the legacy default.
- Returns:
- the
ArcadeProfile
which invoked the Arcade console function - Since:
- 100.14.0
-
-