Skip To ContentArcGIS for DevelopersSign In Dashboard
require(["esri/widgets/Editor/Workflow"], function(Workflow) { /* code goes here */ });
Class: esri/widgets/Editor/Workflow
Inheritance: Workflow Accessor
Since: ArcGIS API for JavaScript 4.11

A 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 Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummaryClass
CreateWorkflowData|UpdateWorkflowData

Shared workflow data.

more details
more detailsWorkflow
String

The name of the class.

more details
more detailsAccessor
Boolean

This property indicates whether there is a next step in the workflow.

more details
more detailsWorkflow
Boolean

This property indicates if there is a previous step in the workflow.

more details
more detailsWorkflow
Boolean

Indicates whether the workflow is considered active.

more details
more detailsWorkflow
String

The name of the current step in the workflow.

more details
more detailsWorkflow
String

Value indicating the workflow type.

more details
more detailsWorkflow

Property Details

Shared workflow data. Can be either CreateWorkflowData or UpdateWorkflowData.

declaredClass Stringreadonly inherited

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 ValueDescriptionExample
createIndicated in the widget via the Add feature option. This allows the end user to create new features in the feature service.combinedcreate
updateIndicated in the widget via the Edit feature option. This allows the end user to update and/or delete features in the feature service.combinedupdate

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 features is not enabled.

Possible Values:"create"|"update"

Method Overview

NameReturn TypeSummaryClass

Cancels the active workflow.

more details
more detailsWorkflow

Call this method when the workflow is considered finished.

more details
more detailsWorkflow

Moves to the next step in the workflow.

more details
more detailsWorkflow

Moves to the previous step in the workflow.

more details
more detailsWorkflow

Resets the workflow.

more details
more detailsWorkflow

Starts the workflow.

more details
more detailsWorkflow

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.

Moves to the next step in the workflow.

Moves to the previous step in the workflow.

reset()

Resets the workflow.

start()

Starts the workflow.

API Reference search results

NameTypeModule
Loading...