UpdateWorkflow

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

The following stages depict editing a single feature.

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

Update multiple features

The following stages depict editing multiple features.

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

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:

• Editor
• Workflow
• Edits
• CreateWorkflow
• CreateWorkflowData
• UpdateWorkflowData

• Guide topic: Widget development - ViewModel pattern

• Sample - Edit features with the Editor widget

• Sample - Edit features in 3D with the Editor widget

• Sample - Editor widget with configurations

• Sample - Popup with edit action

Property Overview

Property Details

data CreateWorkflowData|UpdateWorkflowDatareadonly inherited

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

Method Details

cancel(){Promise<void>}inherited

Cancels the active workflow.

Returns:

Type	Description
Promise<void>

commit(){Promise<void>}inherited

Call this method when the workflow is considered finished. This method is used to help process the editing results.

Returns:

Type	Description
Promise<void>

next(){Promise<void>}inherited

Moves to the next step in the workflow.

Returns:

Type	Description
Promise<void>

previous(){Promise<void>}inherited

Moves to the previous step in the workflow.

Returns:

Type	Description
Promise<void>

reset(){Promise<void>}inherited

Resets the workflow.

Returns:

Type	Description
Promise<void>

start(){Promise<void>}inherited

Starts the workflow.

Returns:

Type	Description
Promise<void>