require(["esri/widgets/Editor/UpdateWorkflow"], (UpdateWorkflow) => { /* code goes here */ });
import UpdateWorkflow from "@arcgis/core/widgets/Editor/UpdateWorkflow.js";
esri/widgets/Editor/UpdateWorkflow
A read-only class containing the logic used when updating and/or deleting features using the Editor widget.
This workflow is only enabled if the feature service allows this operation.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
The shared workflow data. | UpdateWorkflow | ||
The name of the class. | Accessor | ||
This property indicates whether there is a next step in the workflow. | Workflow | ||
This property indicates if there is a previous step in the workflow. | UpdateWorkflow | ||
Indicates whether the workflow is considered active. | Workflow | ||
The name of the current step in the workflow. | Workflow | ||
The type of workflow. | UpdateWorkflow |
Property Details
-
data
data UpdateWorkflowDatareadonly
Since: ArcGIS Maps SDK for JavaScript 4.30UpdateWorkflow since 4.15, data added at 4.30. -
The shared workflow data.
-
hasPreviousStep
hasPreviousStep Booleanreadonly
-
This property indicates if there is a previous step in the workflow.
-
type
type Stringreadonly
-
The type of workflow.
For UpdateWorkflow the type is always "update".
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
Promise<void> | Cancels the active workflow. | Workflow | |
Promise<void> | Call this method when the workflow is considered finished. | Workflow | |
Returns true if a named group of handles exist. | Accessor | ||
Promise<void> | Moves to the next step in the workflow. | Workflow | |
Promise<void> | Moves to the previous step in the workflow. | Workflow | |
Removes a group of handles owned by the object. | Accessor | ||
Promise<void> | Resets the workflow. | Workflow | |
Promise<any> | Starts the workflow. | Workflow |
Method Details
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, addHandles added at 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 } ); this.addHandles(handle); // Destroy the object this.destroy();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey 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.
-
Inherited from Workflow
-
Call this method when the workflow is considered finished. This is used to help process the editing results.
ReturnsType Description Promise<void> Resolves when the active workflow commits and processes the edited results.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}
Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 4.25. -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType 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"); }
-
Inherited from Workflow
-
Moves to the next step in the workflow.
ReturnsType Description Promise<void> Resolves when moved to the next step within the active workflow.
-
Inherited from Workflow
-
Moves to the previous step in the workflow.
ParametersReturnsType Description Promise<void> Resolves when moved to the previous step within the active workflow.
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 4.25. -
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
Inherited from Workflow
-
Resets the workflow.
ReturnsType Description Promise<void> Resolves when the active workflow is reset.
-
Inherited from Workflow
-
Starts the workflow.
ReturnsType Description Promise<any> Resolves when the active workflow starts.