require(["esri/widgets/Editor/CreateFeaturesWorkflow"], (CreateFeaturesWorkflow) => { /* code goes here */ });
import CreateFeaturesWorkflow from "@arcgis/core/widgets/Editor/CreateFeaturesWorkflow.js";
esri/widgets/Editor/CreateFeaturesWorkflow
A read-only class containing the logic used when creating features using the Editor widget. This workflow provides continuous creation of multiple features of the same type at once. After the initial sketch is created, the attribute form will display with the set field elements. These fields can be updated as the user creates new features. This workflow is designed for both individual and multiple feature creation.
This workflow is only enabled if the feature service allows this operation.
Property Overview
| Name | Type | Summary | Class |
|---|---|---|---|
Indicates the current feature state during creation. | CreateFeaturesWorkflow | ||
The shared workflow data. | CreateFeaturesWorkflow | ||
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. | Workflow | ||
Returns the number of pending features of an active CreateFeaturesWorkflow. | CreateFeaturesWorkflow | ||
Returns a collection of graphics representing features that are currently pending in the CreateFeaturesWorkflowData. | CreateFeaturesWorkflow | ||
Indicates whether the workflow is considered active. | Workflow | ||
The name of the current step in the workflow. | Workflow | ||
Value indicating the workflow type. | Workflow |
Property Details
-
createFeatureState
PropertycreateFeatureState Stringreadonly -
Indicates the current feature state during creation. This state is either 1) while creating a new feature, or 2) updating a pending feature while in the "creating-features" step.
Possible Values:"create-new" |"update-pending"
- Default Value:"create-new"
-
data
Propertydata CreateFeaturesWorkflowDatareadonlySince: ArcGIS Maps SDK for JavaScript 4.30CreateFeaturesWorkflow since 4.23, data added at 4.30. -
The shared workflow data.
-
numPendingFeatures
PropertynumPendingFeatures Numberreadonly -
Returns the number of pending features of an active CreateFeaturesWorkflow. Returns 0 (zero) if no workflow is active or the workflow type is not matching.
- See also
-
pendingFeatures
PropertypendingFeatures Collection<GraphicsLayer>readonly -
Returns a collection of graphics representing features that are currently pending in the CreateFeaturesWorkflowData.
- See also
-
type
InheritedPropertytype StringreadonlyInherited from Workflow -
Value indicating the workflow type.
Possible Value Description create This allows the end user to create a new individual feature in the feature service. (deprecated as of 4.23, use create-featuresas noted below.)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:"create" |"create-features" |"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 | |
Promise<void> | Moves the pending feature into update mode. | CreateFeaturesWorkflow |
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.
-
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 trueif 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 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");