Module com.esri.arcgisruntime
Package com.esri.arcgisruntime.arcade

Enum Class ArcadeProfile

java.lang.Object
java.lang.Enum<ArcadeProfile>
com.esri.arcgisruntime.arcade.ArcadeProfile
All Implemented Interfaces:
Serializable, Comparable<ArcadeProfile>, Constable
public enum ArcadeProfile extends Enum<ArcadeProfile>
The execution context a script will run under.

The Arcade profile specifies the context under which a script should be executed. This allows the script writer to program against a set of known profile variables and functionality restrictions that are appropriate for their use case. This includes the set of expected return types.

It is erroneous to try to use restricted functionality for instance the use of FeatureSets while working in the labeling profile. Often the restrictions are applied due to performance considerations.

This API does not check that the required profile variables are present for evaluation within a certain profile, nor does it check that the return type is the expected type. The ArcadeEvaluationResult.castTo(ArcadeExpressionReturnType) method converts the type of the evaluation result using Arcade casting rules.

Since:
100.14.0

  • Enum Constant Details

    • RESTRICTED

      public static final ArcadeProfile RESTRICTED
      Usage of any optional feature is blocked. Prefer this as your default.
      Since:
      100.14.0

    • UNRESTRICTED

      public static final ArcadeProfile UNRESTRICTED
      All optional functionality is allowed. The default profile due to compatibility reasons, prefer RESTRICTED as default.
      Since:
      100.14.0

    • ALIAS

      public static final ArcadeProfile ALIAS
      Alias profile.

      Alias profile functionality restrictions apply, only Alias profile variables should be made available. See Arcade profile documentation.

      Since:
      100.14.0

    • ATTRIBUTE_RULE_CALCULATION

      public static final ArcadeProfile ATTRIBUTE_RULE_CALCULATION
      Attribute Rule Calculation profile.

      Attribute Rule Calculation profile functionality restrictions apply, only Attribute Rule Calculation profile variables should be made available. See Arcade profile documentation.

      Since:
      100.14.0

    • ATTRIBUTE_RULE_CONSTRAINT

      public static final ArcadeProfile ATTRIBUTE_RULE_CONSTRAINT
      Attribute Rule Constraint profile.

      Attribute Rule Constraint profile functionality restrictions apply, only Attribute Rule Constraint profile variables should be made available. See Arcade profile documentation.

      Since:
      100.14.0

    • ATTRIBUTE_RULE_VALIDATION

      public static final ArcadeProfile ATTRIBUTE_RULE_VALIDATION
      Attribute Rule Validation profile.

      Attribute Rule profile functionality restrictions apply, only Attribute Rule profile variables should be made available. See Arcade profile documentation.

      Since:
      100.14.0

    • CONSTRAINT

      public static final ArcadeProfile CONSTRAINT
      Form Constraint profile.

      Form Constraint profile functionality restrictions apply, only Form Constraint profile variables should be made available. See Arcade profile documentation.

      Since:
      100.14.0

    • DASHBOARD_FORMATTING

      public static final ArcadeProfile DASHBOARD_FORMATTING
      Dashboard Formatting profile.

      Dashboard Formatting profile functionality restrictions apply, only Dashboard Formatting profile variables should be made available. See Arcade profile documentation.

      Since:
      100.14.0

    • DASHBOARD_DATA

      public static final ArcadeProfile DASHBOARD_DATA
      Dashboard Data profile.

      Dashboard Data profile functionality restrictions apply, only Dashboard Data profile variables should be made available. See Arcade profile documentation.

      Since:
      100.14.0

    • DICTIONARY_RENDERER

      public static final ArcadeProfile DICTIONARY_RENDERER
      Dictionary Renderer profile.

      Dictionary Renderer profile functionality restrictions apply, only Dictionary Renderer profile variables should be made available. See Arcade profile documentation.

      Since:
      100.14.0

    • FEATURE_Z

      public static final ArcadeProfile FEATURE_Z
      Feature Z profile.

      Feature Z profile functionality restrictions apply, only Feature Z profile variables should be made available. See Arcade profile documentation.

      Since:
      100.14.0

    • FIELD_CALCULATION

      public static final ArcadeProfile FIELD_CALCULATION
      Field Calculation profile.

      Field Calculation profile functionality restrictions apply, only Field Calculation profile variables should be made available. See Arcade profile documentation.

      Since:
      100.14.0

    • FIELD_MAPPING

      public static final ArcadeProfile FIELD_MAPPING
      Field Mapping profile.

      Field Mapping profile functionality restrictions apply, only Field Mapping profile variables should be made available. See Arcade profile documentation.

      Since:
      100.14.0

    • GEOANALYTICS

      public static final ArcadeProfile GEOANALYTICS
      Geoanalytics profile.

      Geoanalytics profile functionality restrictions apply, only Geoanalytics profile variables should be made available. See Arcade profile documentation.

      Since:
      100.14.0

    • LABELING

      public static final ArcadeProfile LABELING
      Labeling profile.

      Labeling profile functionality restrictions apply, only Labeling profile variables should be made available. See Arcade profile documentation.

      Since:
      100.14.0

    • LAYOUT

      public static final ArcadeProfile LAYOUT
      Layout profile.

      Layout profile functionality restrictions apply, only Layout profile variables should be made available. See Arcade profile documentation.

      Since:
      100.14.0

    • MEASURE_VISUALIZATION

      public static final ArcadeProfile MEASURE_VISUALIZATION
      Measure Visualization profile.

      Measure Visualization profile functionality restrictions apply, only Measure Visualization profile variables should be made available. See Arcade profile documentation.

      Since:
      100.14.0

    • VELOCITY

      public static final ArcadeProfile VELOCITY
      Velocity profile.

      Velocity profile functionality restrictions apply, only Velocity profile variables should be made available. See Arcade profile documentation.

      Since:
      100.14.0

    • VISUALIZATION

      public static final ArcadeProfile VISUALIZATION
      Visualization profile.

      Visualization profile functionality restrictions apply, only Visualization profile variables should be made available. See Arcade profile documentation.

      Since:
      100.14.0

    • GEOTRIGGER_NOTIFICATION

      public static final ArcadeProfile GEOTRIGGER_NOTIFICATION
      Geotrigger Notification profile.

      Geotrigger Notification profile functionality restrictions apply, only Geotrigger Notification profile variables should be made available. See Arcade profile documentation.

      Since:
      100.14.0

    • FORM_CALCULATION

      public static final ArcadeProfile FORM_CALCULATION
      Form Calculation profile.

      Form Calculation profile functionality restrictions apply, only Form Calculation profile variables should be made available. See Arcade profile documentation.

      Since:
      100.14.0

    • TASK

      public static final ArcadeProfile TASK
      Task profile.

      Task profile functionality restrictions apply, only Task profile variables should be made available. See Arcade profile documentation.

      Since:
      100.14.0

    • LOCATION_UPDATE_CONSTRAINT

      public static final ArcadeProfile LOCATION_UPDATE_CONSTRAINT
      Location Update Constraint profile.

      Location Update Constraint profile functionality restrictions apply, only Location Update Constraint profile variables should be made available. See Arcade profile documentation.

      Since:
      100.14.0

    • QUICK_CAPTURE

      public static final ArcadeProfile QUICK_CAPTURE
      Quick Capture profile.

      Quick Capture functionality restrictions apply, only Quick Capture variables should be made available. See Arcade profile documentation.

      Since:
      200.0.0

  • Method Details

    • values

      public static ArcadeProfile[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static ArcadeProfile valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null