Skip To ContentArcGIS for DevelopersSign In Dashboard

UpdateWorkflow

Class: esri/widgets/Editor/UpdateWorkflow
Inheritance: UpdateWorkflow Workflow Accessor
Since: ArcGIS API for JavaScript 4.15

A read-only class containing the logic used when updating and/or deleting features using the Editor widget's. This is indicated via the widget's Edit feature option.

Update a single feature

editfeature

The following stages depict editing a single feature.

StageEdit single feature example
1 - After selecting Edit feature, the initial panel contains the UpdateWorkflowData.viewModel.selectfeature
2 - Once a feature is selected, the subsequent attribute panel has access to UpdateWorkflowData.edits, UpdateWorkflowData.editableItem, and UpdateWorkflowData.viewModel.updateattributes

Update multiple features

The following stages depict editing multiple features.

Stageedit multiple features example
1 - After selecting Edit feature, the initial panel contains the UpdateWorkflowData.viewModel.selectfeature
2 - If multiple features are selected, the subsequent attribute panel has access to UpdateWorkflowData.candidates and UpdateWorkflowData.viewModel.multiplefeatureselection
3 - Once a feature is selected, the subsequent attribute panel has access to UpdateWorkflowData.edits, UpdateWorkflowData.editableItem, and UpdateWorkflowData.viewModel.selectedfeatureupdate

This workflow is only enabled if the feature service allows this operation. For example, if a feature service is only enabled to create features but not delete, 'Edit features' is not enabled.

See also:

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

The type of workflow.

more details
more detailsUpdateWorkflow

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 inherited

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

hasPreviousStep Booleanreadonly inherited

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

started Booleanreadonly inherited

Indicates whether the workflow is considered active.

Default Value:false
stepId Stringreadonly inherited

The name of the current step in the workflow.

type Stringreadonly

The type of workflow.

For UpdateWorkflow the type is always "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()inherited

Cancels the active workflow.

commit()inherited

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()inherited

Resets the workflow.

start()inherited

Starts the workflow.

API Reference search results

NameTypeModule
Loading...