Workflow
require(["esri/widgets/Editor/Workflow"], function(Workflow) { /* code goes here */ });esri/widgets/Editor/WorkflowA Workflow helps manage different stages of an editing workflow. A workflow can be thought of as one of two types: CreateWorkflow and UpdateWorkflow. If adding a new feature, the CreateWorkflow is used. Whereas if editing an existing feature, the UpdateWorkflow is used. Updating includes both editing geometry and attribute data and deleting features.
An instance of either a CreateWorkflow or UpdateWorkflow is accessed via the activeWorkflow property in either the Editor or EditorViewModel classes.
These workflows are only enabled if the feature service allows these operations. For example, if a feature service is only enabled to allow updates, it is not possible to override this using the API.
- See also:
Constructors
- new Workflow(properties)
- Parameter:properties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class | |
|---|---|---|---|---|
| CreateWorkflowData|UpdateWorkflowData | Shared workflow data. more details | more details | Workflow | |
| String | The name of the class. more details | more details | Accessor | |
| Boolean | This property indicates whether there is a next step in the workflow. more details | more details | Workflow | |
| Boolean | This property indicates if there is a previous step in the workflow. more details | more details | Workflow | |
| Boolean | Indicates whether the workflow is considered active. more details | more details | Workflow | |
| String | The name of the current step in the workflow. more details | more details | Workflow | |
| String | Value indicating the workflow type. more details | more details | Workflow |
Property Details
Shared workflow data. Can be either CreateWorkflowData or UpdateWorkflowData.
The name of the class. The declared class name is formatted as
esri.folder.className.
- hasNextStep Booleanreadonly
This property indicates whether there is a next step in the workflow.
- hasPreviousStep Booleanreadonly
This property indicates if there is a previous step in the workflow.
- started Booleanreadonly
Indicates whether the workflow is considered active.
- Default Value:false
- stepId Stringreadonly
The name of the current step in the workflow.
- type Stringreadonly
Value indicating the workflow type.
Possible Value Description Example create Indicated in the widget via the Add featureoption. This allows the end user to create new features in the feature service.
update Indicated in the widget via the Edit featureoption. This allows the end user to update and/or delete features in the feature service.
These workflows are only enabled if the feature service allows these operations. For example, if a feature service is only enabled to allow updates,
Add featuresis not enabled.Possible Values:"create"|"update"
Method Overview
| Name | Return Type | Summary | Class | |
|---|---|---|---|---|
Cancels the active workflow. more details | more details | Workflow | ||
Call this method when the workflow is considered finished. more details | more details | Workflow | ||
Moves to the next step in the workflow. more details | more details | Workflow | ||
Moves to the previous step in the workflow. more details | more details | Workflow | ||
Resets the workflow. more details | more details | Workflow | ||
Starts the workflow. more details | more details | Workflow |
Method Details
- cancel()
Cancels the active workflow.
- commit()Since: ArcGIS API for JavaScript 4.15
Call this method when the workflow is considered finished. This method is used to help process the editing results.
- next()
Moves to the next step in the workflow.
- previous()
Moves to the previous step in the workflow.
- reset()
Resets the workflow.
- start()
Starts the workflow.