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.
Property Overview
Name | Type | Summary | Class | |
---|---|---|---|---|
CreateWorkflowData|CreateFeaturesWorkflowData|UpdateWorkflowData | more details The shared workflow data. | more details | Workflow | |
String | more details The name of the class. | more details | Accessor | |
Boolean | more details This property indicates whether there is a next step in the workflow. | more details | Workflow | |
Boolean | more details This property indicates if there is a previous step in the workflow. | more details | Workflow | |
Boolean | more details Indicates whether the workflow is considered active. | more details | Workflow | |
String | more details The name of the current step in the workflow. | more details | Workflow | |
String | more details The type of workflow. | more details | UpdateWorkflow |
Property Details
-
The shared workflow data. This can be either CreateFeaturesWorkflowData (use this in place of the deprecated CreateWorkflowData) or UpdateWorkflowData.
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
This property indicates whether there is a next step in the workflow.
-
This property indicates if there is a previous step in the workflow.
-
Indicates whether the workflow is considered active.
- Default Value:false
-
The name of the current step in the workflow.
-
type Stringreadonly
-
The type of workflow.
For UpdateWorkflow the type is always "update".
Method Overview
Name | Return Type | Summary | Class | |
---|---|---|---|---|
Promise<void> | more details Cancels the active workflow. | more details | Workflow | |
Promise<void> | more details Call this method when the workflow is considered finished. | more details | Workflow | |
Promise<void> | more details Moves to the next step in the workflow. | more details | Workflow | |
more details Adds one or more handles which are to be tied to the lifecycle of the object. | more details | Accessor | ||
Promise<void> | more details Moves to the previous step in the workflow. | more details | Workflow | |
Promise<void> | more details Resets the workflow. | more details | Workflow | |
Promise<void> | more details Starts the workflow. | more details | Workflow |
Method Details
-
Cancels the active workflow.
Returns:Type Description Promise<void> Resolves when the active workflow is canceled.
-
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.
-
Moves to the next step in the workflow.
Returns:Type Description Promise<void> Resolves when moved to the next step within the active workflow.
-
own(handleOrHandles)inheritedSince: ArcGIS API for JavaScript 4.24
-
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.whenOnce(() => !view.updating) .then(() => { wkidSelect.disabled = false; }); handle.remove(); // Assign a handle using own() this.own(reactiveUtils.whenOnce(() => !view.updating) .then(() => { wkidSelect.disabled = false; }));
Parameter:handleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
-
Moves to the previous step in the workflow.
Parameters:options ObjectoptionalOptions when calling this method.
Specification:cancelCurrentStep BooleanCancels 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.
-
Resets the workflow.
Returns:Type Description Promise<void> Resolves when the active workflow is reset.
-
Starts the workflow.
Returns:Type Description Promise<void> Resolves when the active workflow starts.