UpdateWorkflow

AMD: require(["esri/widgets/Editor/UpdateWorkflow"], (UpdateWorkflow) => { /* code goes here */ });
ESM: import UpdateWorkflow from "@arcgis/core/widgets/Editor/UpdateWorkflow.js";
Class: esri/widgets/Editor/UpdateWorkflow
Inheritance: UpdateWorkflow Workflow Accessor
Since: ArcGIS Maps SDK for JavaScript 4.15

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.

See also

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
CreateFeaturesWorkflowData|UpdateWorkflowData

The shared workflow data.

Workflow
String

The name of the class.

Accessor
Boolean

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

Workflow
Boolean

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

Workflow
Boolean

Indicates whether the workflow is considered active.

Workflow
String

The name of the current step in the workflow.

Workflow
String

The type of workflow.

UpdateWorkflow

Property Details

The shared workflow data. This can be either CreateFeaturesWorkflowData 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

Show inherited methods Hide inherited methods
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
Boolean

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

addHandles(handleOrHandles, groupKey)inherited

Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor 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();
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(options){Promise<void>}inherited

Cancels the active workflow.

Parameters
Specification
options Object
optional

An object with the following properties.

Specification
error Error
optional

The returned Error object.

force Boolean
optional

Indicates whether to force cancel the active workflow.

notify Boolean
optional

Indicates whether to display a prompt indicating canceling 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 Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 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 Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 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<any>}inherited

Starts the workflow.

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

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.