import { createArcadeProfile, createArcadeExecutor, createArcadeCache } from "@arcgis/core/arcade.js";const { createArcadeProfile, createArcadeExecutor, createArcadeCache } = await $arcgis.import("@arcgis/core/arcade.js");- Since
- ArcGIS Maps SDK for JavaScript 4.24
This module allows you to evaluate Arcade expressions outside traditional ArcGIS Arcade profiles. Profiles define the valid input variables (i.e. profile variables) for expressions, supported functions, and valid return types of expressions. All Arcade expressions executed in the ArcGIS Maps SDK for JavaScript must conform to the rules of the profile where they are written. The createArcadeExecutor() method provides an API for executing Arcade expressions outside the context of predefined ArcGIS Arcade profiles.
This module allows you to do the following:
- Execute expressions already written for existing ArcGIS profiles in another context. For example, an end user may have written an expression for a renderer, popup, or label in a WebMap and the data produced by the expression should be displayed outside the WebMap in a custom component, table, or summarized in a chart.
- Define custom Arcade profiles and provide a configurable experience within an app for users to write their own expressions.
- Developers may want to take advantage of the simplified experience of filtering and querying data using the chainable FeatureSet functions Arcade provides.
Type definitions
ArcadeSupportedFeatureSetLayerUnion
Layer types that may be used to construct Arcade FeatureSets.
ProfileName
- Type
- "aggregate-field" | "form-constraint" | "feature-z" | "field-calculation" | "form-calculation" | "labeling" | "popup" | "popup-element" | "popup-feature-reduction" | "popup-element-feature-reduction" | "visualization" | "popup-voxel" | "popup-element-voxel" | "popup-imagery" | "popup-element-imagery"
Profile
Defines the definitions of a profile's input variables. This consists of an array of objects specifying
the name of each profile variable and its Arcade data type. All profile names must begin with the $ character.
variables
- Type
- Variable[]
The Arcade type definitions for profile variables used as input to the compiled expression.
Example
const profile = { variables: [{ name: "$mapClick", type: "geometry" }, { name: "$threshold", type: "number" }, { name: "$feature", type: "feature" }, { name: "$map", type: "featureSetCollection" }]}; VariableType
- Type
- "array" | "boolean" | "date" | "dateOnly" | "dictionary" | "feature" | "featureSet" | "featureSetCollection" | "geometry" | "json" | "knowledgeGraph" | "number" | "pixel" | "text" | "time" | "voxel"
VariableBase
name
- Type
- string
The name of the profile variable. To follow Arcade's naming convention, this should start with the $
character unless this variable is nested in a DictionaryVariable.
SimpleVariable
The type definition for a simple Arcade profile variable.
- Supertypes
- VariableBase
type
- Type
- Exclude<VariableType, "dictionary" | "array">
The Arcade data type of the variable. See ProfileVariableInstance to see the mapping of Arcade types to JavaScript types.
Example
const profile = { variables: [{ name: "$mapClick", type: "geometry" }, { name: "$threshold", type: "number" }, { name: "$feature", type: "feature" }, { name: "$map", type: "featureSetCollection" }]}; DictionaryVariable
The type definition for an Arcade dictionary profile variable.
- Supertypes
- VariableBase
type
- Type
- "dictionary"
The Arcade data type of the variable. The corresponding JavaScript type to an Arcade Dictionary is a plain Object following the specification defined in ProfileVariableInstance.
properties
- Type
- Variable[]
The type definitions of the dictionary's properties. The names of
these properties should not begin with the $ character.
Example
const profile = { variables: [{ name: "$analysisParams", type: "dictionary", properties: [{ name: "distance", type: "number" }, { name: "projectType", type: "text" }, { name: "includeBuffer", type: "boolean" }] }, { name: "$projectLocation", type: "feature" }]}; ArrayVariable
The type definition for an Arcade array profile variable.
- Supertypes
- VariableBase
type
- Type
- "array"
The Arcade data type of the variable. For ArrayVariable, the type is always array.
The corresponding JavaScript type to an Arcade Array is an array following the specification defined in
ProfileVariableInstance.
elementType
- Type
- ArrayElement
The type definition of the Array's items. Arcade arrays must be of a single type when used as an input profile variable. When indicating an elementType, you do not need to specify a name for the element.
Example
const profile = { variables: [{ name: "$checkpoints", type: "array", elementType: { type: "feature" } }]}; Variable
The type definition of a profile variable. See the individual profile variable types for more information and examples.
ArrayElement
The type definition of a profile variable of type array.
- Type
- Omit<SimpleVariable, "name"> | Omit<DictionaryVariable, "name"> | Omit<ArrayVariable, "name">
ProfileVariableInstance
The JavaScript types that may be used as inputs to profile variables when evaluating compiled expressions with ExecuteFunction or ExecuteFunctionAsync. See the table below for the following mapping of JavaScript types that may be used to hydrate profile variables for corresponding Arcade data types.
| Arcade type | JS type | Notes |
|---|---|---|
| Number | Number | |
| Text | String | |
| Date | Date | Dates returned from Arcade expressions will not preserve time zone information included in the Arcade Date value. Since native JS Dates objects do not include time zone information, they will always display in the local or system time of the client executing the expression. To preserve time zone information in dates returned from Arcade, the expression author should cast dates to Arcade Text values in the return statement of the expression. |
| DateOnly | String | |
| Time | String | |
| Boolean | Boolean | |
| Dictionary | Object | An object with key/value pairs with keys defined by a DictionaryVariable whose values must be one of ProfileVariableInstance. |
| KnowledgeGraph | KnowledgeGraph | This value typically comes from KnowledgeGraphLayer.knowledgeGraph. |
| Array | Array | Arcade arrays are immutable and must be of a single ProfileVariableInstance. |
| Geometry | Geometry | |
| Feature | Graphic | |
| FeatureSet | ArcadeSupportedFeatureSetLayerUnion | FeatureSet | |
| FeatureSetCollection | Map | String | A string may be provided, pointing to the url of a Feature Service. |
- Type
- ArcadeSupportedFeatureSetLayerUnion | boolean | Date | EsriMap | FeatureSet | GeometryUnion | Graphic | KnowledgeGraph | null | undefined | number | string | { [key: string]: ProfileVariableInstance; } | ProfileVariableInstance[]
ExecuteContext
The execution context of the Arcade expression.
spatialReference
- Type
- SpatialReference | undefined
The expected spatial reference of input geometries in geometry functions. If executing an expression in the context of a map, then set the spatial reference of the view to this property. If executing an expression in the context of a layer, then use the layer's spatial reference. If not specified, then the spatial reference defaults to SpatialReference.WebMercator.
services
- Type
- ArcadeServices | undefined
- Since
- ArcGIS Maps SDK for JavaScript 4.33
Required for expressions that use the
GetUser() Arcade function.
timeZone
- Since
- ArcGIS Maps SDK for JavaScript 4.28
Defines the default time zone in which to create and display Arcade date types. Possible values include any time zone that may be set on the view's timeZone. Generally, if the Arcade context's profile involves a map, or features originating from a map, the value of the view's timeZone should be set here. By default, the time zone is set to "system".
- Default value
- system
Examples
// the input feature's geometry is expected// to be in the spatial reference of the view// All Arcade dates will be represented in the// time zone of the view or web map.await executor.executeAsync({ "$feature": feature}, { spatialReference: view.spatialReference, timeZone: view.timeZone});// the input feature's geometry is expected// to be in the spatial reference of the layerawait executor.executeAsync({ "$feature": feature}, { spatialReference: layer.spatialReference});// the input feature's geometry is expected// to be Web Mercatorawait executor.executeAsync({ "$feature": feature}); ArcadeServices
- Since
- ArcGIS Maps SDK for JavaScript 4.33
ArcadeServices provides access to services and user information that are required for executing Arcade expressions.
portal
An ArcGIS Portal instance. This is required for expressions that use the GetUser()
Arcade function. By default, the portal referenced in esriConfig.portalUrl is used.
ExecutorOptions
services
- Type
- ArcadeServices | undefined
- Since
- ArcGIS Maps SDK for JavaScript 4.33
Required for expressions that use the
GetUser() Arcade function.
ResultType
The JavaScript type of the result returned from the Arcade expression.
- Type
- number | string | Date | boolean | Graphic | GeometryUnion | Object | Array<ResultType> | null | undefined
SettledArcadePromise
- Since
- ArcGIS Maps SDK for JavaScript 4.33
Type definition for a settled promise of the asynchronous execution of an Arcade expression.
FulfilledArcadePromise
- Since
- ArcGIS Maps SDK for JavaScript 4.33
Type definition for a fulfilled promise of the asynchronous execution of an Arcade expression.
- Supertypes
- PromiseFulfilledResult<ResultType>
RejectedArcadePromise
- Since
- ArcGIS Maps SDK for JavaScript 4.33
Type definition for a rejected promise of the asynchronous execution of an Arcade expression.
- Supertypes
- PromiseRejectedResult
ArcadeExecutor
An executor provides a synchronous (if applicable) and asynchronous function used to evaluate the compiled Arcade expression with the inputs of the declared profile variables. It also provides metadata about the compilation result.
- See also
execute
- Type
- ExecuteFunction
A function that can be invoked to evaluate the compiled
expression for a set of profile variables. Will return the results of the evaluation. This function will
only be available if isAsync is false.
executeAsync
- Type
- ExecuteFunctionAsync
Asynchronous function that evaluates the compiled
expression. This function may always be used to evaluate the expression, but must be used if isAsync is true.
isAsync
- Type
- boolean
Indicates whether the compiled expression accesses data using a FeatureSet function
and therefore must be executed using the executeAsync function. If false, the expression may be executed
with execute or executeAsync.
variablesUsed
- Type
- string[]
- Since
- ArcGIS Maps SDK for JavaScript 4.34
References the names of profile variables used in the compiled expression.
fieldsUsed
- Type
- string[]
References the names of fields used in the compiled expression when
working with the $feature profile variable or functions that expect field names, such as Expects.
Field names referenced here should be requested by the underlying layer or datastore. In JavaScript,
this is typically done with layer.outFields.
geometryUsed
- Type
- boolean
Indicates whether the expression accesses or uses a feature's geometry.
Examples
// Synchronous execution for all features in layer view// % of the population not in labor forceconst arcadeScript = "(($feature.POP_16UP - $feature.EMP_CY) / $feature.POP_16UP) * 100"
const profile = { variables: [{ name: "$feature", type: "feature" }]};
const laborForceExecutor = await createArcadeExecutor(arcadeScript, profile);// ensures data values from fields used in the expression are// available when the expression executes.layer.outFields = laborForceExecutor.fieldsUsed;
const { features } = await layerView.queryFeatures();
const allValues = features.map( (feature) => { return laborForceExecutor.execute({ "$feature": feature });});
// allValues can be displayed in a chart, or used to// report stats for this variable// Asynchronous execution for one feature clicked in the view
const profile = { variables: [{ name: "$feature", type: "feature" }, { name: "$layer", type: "featureSet" }]};
// This expression executes on each feature click. It compares the % of the population// not participating in the labor force with the same value of all features within// one mile of the selected feature's locationconst arcadeScript = ` var featureNotLaborForce = Round((($feature.POP_16UP - $feature.EMP_CY)/$feature.POP_16UP)*100); var id = $feature.OBJECTID;
var neighbors = Filter( Intersects( $layer, BufferGeodetic($feature, 1, "mile") ), "OBJECTID <> @id" ); if( Count(neighbors) == 0 ){ return "No neighbors within 1 mile"; }
var neighborsNotLaborForceAverage = Average(neighbors, "( (POP_16UP - EMP_CY) / POP_16UP) * 100"); var difference = Round(featureNotLaborForce - neighborsNotLaborForceAverage); var differenceText = IIF(difference > 0, "+"+difference, Text(difference)); return differenceText;`;
const neighborhoodExecutor = await createArcadeExecutor(arcadeScript, profile);// ensures data values from fields used in the expression are// available when the expression executes.layer.outFields = neighborhoodExecutor.fieldsUsed;
view.on("click", async (event) => { const hitResponse = await view.hitTest(event, include: { layer }); const hitGraphic = hitResponse?.results[0].graphic;
const scriptResult = await neighborhoodExecutor.executeAsync({ "$feature": hitGraphic, "$layer": hitGraphic.layer }, { spatialReference: view.spatialReference });
// display the value of scriptResult in a UI component or use it // in some form of client-side analysis});const profile = { variables: [{ name: "$feature", type: "feature" }]};
// Arcade expression defined by user...const syncExecutor = await createArcadeExecutor(arcadeScript, profile);// ensures data values from fields used in the expression are// available when the expression executes.layer.outFields = syncExecutor.fieldsUsed;
// throw error if expression from user uses// invalid functions that require async executionif(syncExecutor.isAsync){ throw new Error("Invalid expression. Expression should not use FeatureSet functions.");}
const { features } = await layerView.queryFeatures();
const allValues = features.map( (feature) => { return syncExecutor.execute({ "$feature": feature });});
// allValues can be displayed in a chart, or used to// report stats for this variable ExecuteFunction
Executes the compiled Arcade expression synchronously with the given profile variable instances. This function may not be used if the expression accesses data using FeatureSet functions.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| profileVariableInstances | An object of key/value pairs where the key is the name of a Variable defined when creating the executor. The key's value must be of type ProfileVariableInstance. | | |
| context | The context with which to execute the expression. | |
- Returns
- ResultType
Returns the value of the evaluated expression.
Examples
// Synchronous execution for all features in layer view// % of the population not in labor forceconst arcadeScript = "(($feature.POP_16UP - $feature.EMP_CY) / $feature.POP_16UP) * 100"
const profile = { variables: [{ name: "$feature", type: "feature" }]};
const laborForceExecutor = await createArcadeExecutor(arcadeScript, profile);// ensures data values from fields used in the expression are// available when the expression executes.layer.outFields = laborForceExecutor.fieldsUsed;
const { features } = await layerView.queryFeatures();
const allValues = features.map( (feature) => { return laborForceExecutor.execute({ "$feature": feature });});
// allValues can be displayed in a chart, or used to// report stats for this variableconst profile = { variables: [{ name: "$feature", type: "feature" }]};
// Arcade expression defined by user...const syncExecutor = await createArcadeExecutor(arcadeScript, profile);// ensures data values from fields used in the expression are// available when the expression executes.layer.outFields = syncExecutor.fieldsUsed;
// throw error if expression from user uses invalid functionsif(syncExecutor.isAsync){ throw new Error("Invalid expression. Expression should not use FeatureSet functions.");}
const { features } = await layerView.queryFeatures();
const allValues = features.map( (feature) => { return syncExecutor.execute({ "$feature": feature });});
// allValues can be displayed in a chart, or used to// report stats for this variable ExecuteFunctionAsync
Executes the compiled Arcade expression asynchronously with the given profile variable instances.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| profileVariableInstances | An object of key/value pairs where the key is the name of a Variable defined when creating the executor, whose value must be of type ProfileVariableInstance. | | |
| context | The context with which to execute the expression. | |
- Returns
- Promise<ResultType>
Resolves to the value of the evaluated expression.
Example
// Asynchronous execution for one feature clicked in the view
const profile = { variables: [{ name: "$feature", type: "feature" }, { name: "$layer", type: "featureSet" }]};
// This expression executes on each feature click. It compares the % of the population// not participating in the labor force with the same value of all features within// one mile of the selected feature's locationconst arcadeScript = ` var featureNotLaborForce = Round((($feature.POP_16UP - $feature.EMP_CY)/$feature.POP_16UP)*100); var id = $feature.OBJECTID;
var neighbors = Filter( Intersects( $layer, BufferGeodetic($feature, 1, "mile") ), "OBJECTID <> @id" ); if( Count(neighbors) == 0 ){ return "No neighbors within 1 mile"; }
var neighborsNotLaborForceAverage = Average(neighbors, "( (POP_16UP - EMP_CY) / POP_16UP) * 100"); var difference = Round(featureNotLaborForce - neighborsNotLaborForceAverage); var differenceText = IIF(difference > 0, "+"+difference, Text(difference)); return differenceText;`;
const neighborhoodExecutor = await createArcadeExecutor(arcadeScript, profile);// ensures data values from fields used in the expression are// available when the expression executes.layer.outFields = neighborhoodExecutor.fieldsUsed;
view.on("click", async (event) => { const hitResponse = await view.hitTest(event, include: { layer }); const hitGraphic = hitResponse?.results[0].graphic;
const scriptResult = await neighborhoodExecutor.executeAsync({ "$feature": hitGraphic, "$layer": hitGraphic.layer }, { spatialReference: view.spatialReference });
// display the value of scriptResult in a UI component or use it // in some form of client-side analysis}); ExecuteFunctionAsyncBatch
- Since
- ArcGIS Maps SDK for JavaScript 4.33
Executes the compiled Arcade expression asynchronously for a batch of profile variable instances (i.e. inputs). This is the preferred execution method for large batches of features that require asynchronous execution.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| inputData | An iterable object, such as an array or collection, containing the data used to hydrate the profile variable instances. | | |
| variableInstancesCreator | Callback function used to
create profile variable instances from each | | |
| context | The context with which to execute the expression. | |
- Returns
- Promise<Array<SettledArcadePromise>>
Resolves with the results of evaluating the expression for each
inputDataitem.
Example
const profile = { variables: [{ name: "$text", type: "text" }]};
const arcadeScript = ` var locale = GetEnvironment().locale; // browser locale var result = TranslateText($text, locale); // result will be a dictionary with the translated text if (result.success){ if(HasValue(result, ["results", 0, "translation"])){ // returns "Hola mundo" if the device locale is 'es' and $text is "Hello world" return result.results[0].translation[locale]; } if (HasValue(result, ["results", 0, "text"])){ // returns "Hello world" if translation could not be performed return result.results[0].text; } } return "Translation not successful";`;
const executor = await createArcadeExecutor(arcadeScript, profile);const textToTranslate = ["Hello world", "Goodbye world", "Hello again", "Goodbye again"];
const translatedText = await executor.executeAsyncBatch( textToTranslate, (input) => ({ "$text": input }));
// persist the translated text for later use BatchExecuteContext
- Since
- ArcGIS Maps SDK for JavaScript 4.33
The context of the Arcade expression for batch execution.
- Supertypes
- ExecuteContext
VariableInstancesCreator
- Type parameters
- <A>
- Since
- ArcGIS Maps SDK for JavaScript 4.33
Callback function used to create profile variable instances from generic input data.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| inputData | A | Input data used to hydrate the profile variable instances. | |
- Returns
- ProfileVariableInstances
An object of profile variable instances represented as key/value pairs where the key is the name of a Variable defined when creating the executor, whose value must be of type ProfileVariableInstance.
Functions
| Name | Return Type | Object |
|---|---|---|
| | |
| | ||
| | ||
| | |
| | ||
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| |
createArcadeProfile
- Since
- ArcGIS Maps SDK for JavaScript 4.25
Creates a Profile definition for an Arcade profile implemented in the ArcGIS Maps SDK for JavaScript. The result of this should be provided to the createArcadeExecutor() method.
- Signature
-
createArcadeProfile (profileName: ProfileName | "feature-reduction-popup" | "feature-reduction-popup-element"): Profile
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| profileName | ProfileName | "feature-reduction-popup" | "feature-reduction-popup-element" | The name of the Arcade profile definition to create. The values | |
- Returns
- Profile
Returns the profile definition used to execute an expression with the ArcadeExecutor.
Example
const labelingProfile = arcade.createArcadeProfile("labeling");// creates the following object to be provided to the createArcadeExecutor method.// {// variables: [{// name: "$feature",// type: "feature"// }]// }
const labelExecutor = await createArcadeExecutor("$feature.NAME + ' COUNTY'", labelingProfile); createArcadeExecutor
Compiles an Arcade expression and its profile into an executor. The executor provides functions to evaluate the results for profile variables.
- Signature
-
createArcadeExecutor (script: string, profile: Profile, options?: ExecutorOptions): Promise<ArcadeExecutor>
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| script | The Arcade expression to compile and execute. | | |
| profile | The profile definition used to execute the given expression. The profile defines the profile variable names and data types the user may use as inputs in the expression. The variable instances are provided to the executor function. | | |
| options | Since 4.33 Options used to configure the executor. | |
- Returns
- Promise<ArcadeExecutor>
Resolves to an ArcadeExecutor that provides a synchronous (if applicable) and asynchronous function used to evaluate the compiled Arcade expression when provided with valid input profile variables.
Examples
// Synchronous execution for all features in layer view// % of the population not in labor forceconst arcadeScript = "(($feature.POP_16UP - $feature.EMP_CY) / $feature.POP_16UP) * 100"
const profile = { variables: [{ name: "$feature", type: "feature" }]};
const laborForceExecutor = await createArcadeExecutor(arcadeScript, profile);// ensures data values from fields used in the expression are// available when the expression executes.layer.outFields = laborForceExecutor.fieldsUsed;
const { features } = await layerView.queryFeatures();
const allValues = features.map( (feature) => { return laborForceExecutor.execute({ "$feature": feature });});
// allValues can be displayed in a chart, or used to// report stats for this variable// Asynchronous execution for one feature clicked in the view
const profile = { variables: [{ name: "$feature", type: "feature" }, { name: "$layer", type: "featureSet" }]};
// This expression executes on each feature click. It compares the % of the population// not participating in the labor force with the same value of all features within// one mile of the selected feature's locationconst arcadeScript = ` var featureNotLaborForce = Round((($feature.POP_16UP - $feature.EMP_CY)/$feature.POP_16UP)*100); var id = $feature.OBJECTID;
var neighbors = Filter( Intersects( $layer, BufferGeodetic($feature, 1, "mile") ), "OBJECTID <> @id" ); if( Count(neighbors) == 0 ){ return "No neighbors within 1 mile"; }
var neighborsNotLaborForceAverage = Average(neighbors, "( (POP_16UP - EMP_CY) / POP_16UP) * 100"); var difference = Round(featureNotLaborForce - neighborsNotLaborForceAverage); var differenceText = IIF(difference > 0, "+"+difference, Text(difference)); return differenceText;`;
const neighborhoodExecutor = await createArcadeExecutor(arcadeScript, profile);// ensures data values from fields used in the expression are// available when the expression executes.layer.outFields = neighborhoodExecutor.fieldsUsed;
view.on("click", async (event) => { const hitResponse = await view.hitTest(event, include: { layer }); const hitGraphic = hitResponse?.results[0].graphic;
const scriptResult = await neighborhoodExecutor.executeAsync({ "$feature": hitGraphic, "$layer": hitGraphic.layer }, { spatialReference: view.spatialReference });
// display the value of scriptResult in a UI component or use it // in some form of client-side analysis});