ESM: import Workflow from "@arcgis/core/widgets/Editor/Workflow.js";
CDN: const Workflow = await $arcgis.import("@arcgis/core/widgets/Editor/Workflow.js");
Class: @arcgis/core/widgets/Editor/Workflow
Since: ArcGIS Maps SDK for JavaScript 4.11
Property Overview Any properties can be set, retrieved or listened to. See the Watch for changes topic.Show inherited properties Hide inherited properties
Property DetailsInherited
Property declaredClass Stringreadonly
The name of the class. The declared class name is formatted as esri.folder.className
.
hasNextStep Booleanreadonly
This property indicates whether there is a next step in the workflow.
hasPreviousStep Booleanreadonly
This property indicates if there is a previous step in the workflow.
started Booleanreadonly
Indicates whether the workflow is considered active.
stepId Stringreadonly
The name of the current step in the workflow.
type Stringreadonly
Value indicating the workflow type.
Possible Value Description create-features This allows the end user to create either individual or continuous features in the feature service. (Since 4.23) update This allows the end user to update and/or delete features in the feature service.These workflows are only enabled if the feature service allows these operations.
Possible Values:"add-association" |"create-features" |"update" |"update-feature" |"update-features" |"update-table-record"
Show inherited methods Hide inherited methods
Name Return Type Summary Class addHandles()Adds one or more handles which are to be tied to the lifecycle of the object.
Accessor cancel()Promise<void>
Cancels the active workflow.
Workflow commit()Promise<void>
Call this method when the workflow is considered finished.
Workflow hasHandles() BooleanReturns true if a named group of handles exist.
Accessor next()Promise<void>
Moves to the next step in the workflow.
Workflow previous()Promise<void>
Moves to the previous step in the workflow.
Workflow removeHandles()Removes a group of handles owned by the object.
Accessor reset()Promise<void>
Resets the workflow.
Workflow start()Promise<any>
Starts the workflow.
Workflow Method DetailsInherited
Method addHandles(handleOrHandles, groupKey)
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
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.
cancel(options){Promise<void>}
Cancels the active workflow.
Parameters
Specification
optionalAn object with the following properties.
Specification
optionalThe returned Error object.
optionalIndicates whether to force cancel the active workflow.
optionalIndicates 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>}
Since: ArcGIS Maps SDK for JavaScript 4.15 Workflow since 4.11, commit added at 4.15.
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.Inherited
Method hasHandles(groupKey){Boolean}
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 *
optionalA group key.
Returns
Type Description Boolean Returnstrue
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>}
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>}
Moves to the previous step in the workflow.
Parameters
optionalOptions when calling this method.
Specification
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.Inherited
Method removeHandles(groupKey)
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 *
optionalA 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>}
Resets the workflow.
Returns
Type Description Promise<void> Resolves when the active workflow is reset. start(){Promise<any>}
Starts the workflow.
Returns
Type Description Promise<any> Resolves when the active workflow starts.RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4