A read-only class containing the logic used when creating features using the Editor widget.
The following stages depict adding new feature(s) with this workflow.
Stage | Add feature example |
---|---|
1 - The first panel contains the CreateFeaturesWorkflowData.viewModel. | ![]() |
2 - After a template is selected, the next panel has access to CreateFeaturesWorkflowData.creationInfo and CreateFeaturesWorkflowData.viewModel. | ![]() |
3 - Once a feature geometry is specified, the subsequent attribute panel has access to CreateFeaturesWorkflowData.creationInfo, CreateWorkflowData.viewModel, and number of pending features, and actual pending features. | ![]() |
This workflow is only enabled if the feature service allows this operation.
Property Overview
Name | Type | Summary | Class | |
---|---|---|---|---|
String | more details Indicates the current feature state during creation. | more details | CreateFeaturesWorkflow | |
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 | |
Number | more details Returns the number of pending features of an active CreateWorkflow. | more details | CreateFeaturesWorkflow | |
Collection<Graphic> | more details Returns a collection of graphics representing features that are currently pending in the active CreateWorkflow. | more details | CreateFeaturesWorkflow | |
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 Value indicating the workflow type. | more details | Workflow |
Property Details
-
createFeatureState String
-
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"
-
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.
-
numPendingFeatures Number
-
Returns the number of pending features of an active CreateWorkflow. Returns 0 (zero) if no workflow is active or the workflow type is not matching.
- See also:
-
pendingFeatures Collection<Graphic>
-
Returns a collection of graphics representing features that are currently pending in the active CreateWorkflow.
- See also:
-
Indicates whether the workflow is considered active.
- Default Value:false
-
The name of the current step in the 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-features
as 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 | |
---|---|---|---|---|
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 | |
Promise<void> | more details Moves the pending feature into update mode. | more details | CreateFeaturesWorkflow |
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.