UpdateWorkflow

A read-only class containing the logic used when updating and/or deleting features using the Editor widget.

Update a single feature

The following stages depict editing a single feature.

Stage	Edit single feature example
1 - After selecting the feature to edit, 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 (ovelapped) features to edit, 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.

See also

• Editor
• Workflow
• CreateWorkflow
• UpdateWorkflowData

• Guide topic: Widget 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|CreateFeaturesWorkflowData|UpdateWorkflowDatareadonly inherited

The shared workflow data. This can be either CreateFeaturesWorkflowData (use this in place of the deprecated 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

addHandles(handleOrHandles, groupKey)inherited

Since: ArcGIS API for JavaScript 4.25

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);

Parameters

handleOrHandles WatchHandle|WatchHandle[] Handles marked for removal once the object is destroyed.

groupKey * optional Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

cancel(){Promise<void>}inherited

Cancels the active workflow.

Returns

Type	Description
Promise<void>	Resolves when the active workflow is canceled.

commit(){Promise<void>}inherited

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

Returns

Type	Description
Promise<void>	Resolves when the active workflow commits and processes the edited results.

hasHandles(groupKey){Boolean}inherited

Since: ArcGIS API for JavaScript 4.25

Returns true if a named group of handles exist.

Parameter

groupKey * optional A group key.

Returns

Type	Description
Boolean	Returns true if a named group of handles exist.

Example

// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}

next(){Promise<void>}inherited

Moves to the next step in the workflow.

Returns

Type	Description
Promise<void>	Resolves when moved to the next step within the active workflow.

previous(options){Promise<void>}inherited

Moves to the previous step in the workflow.

Parameters

options Object optional Options when calling this method. Specification cancelCurrentStep Boolean Cancels the current workflow when calling this method. Default value is false.

Returns

Type	Description
Promise<void>	Resolves when moved to the previous step within the active workflow.

removeHandles(groupKey)inherited

Since: ArcGIS API for JavaScript 4.25

Removes a group of handles owned by the object.

Parameter

groupKey * optional A group key or an array or collection of group keys to remove.

Example

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

reset(){Promise<void>}inherited

Resets the workflow.

Returns

Type	Description
Promise<void>	Resolves when the active workflow is reset.

start(){Promise<void>}inherited

Starts the workflow.

Returns

Type	Description
Promise<void>	Resolves when the active workflow starts.