CreateWorkflow
esri/widgets/Editor/CreateWorkflow
A read-only class containing the logic used when creating features using the Editor widget. This is indicated via the widget's Add feature
option.
The following stages depict adding a new feature with this workflow.
Stage | Add feature example |
---|---|
1 - After selecting Add feature , the first panel contains the CreateWorkflowData.viewModel. | ![]() |
2 - After a template is selected, the next panel has access to CreateWorkflowData.creationInfo and CreateWorkflowData.viewModel. | ![]() |
3 - Once a feature geometry is specified, the subsequent attribute panel has access to CreateWorkflowData.creationInfo, UpdateWorkflowData.edits, and CreateWorkflowData.viewModel. | ![]() |
This workflow is only enabled if the feature service allows this operation. For example, if a feature service is only enabled to allow updates, 'Add features' is not enabled.
Property Overview
Name | Type | Summary | Class | |
---|---|---|---|---|
CreateWorkflowData|UpdateWorkflowData | Shared workflow data. more details | more details | Workflow | |
String | The name of the class. more details | more details | Accessor | |
Boolean | This property indicates whether there is a next step in the workflow. more details | more details | Workflow | |
Boolean | This property indicates if there is a previous step in the workflow. more details | more details | Workflow | |
Boolean | Indicates whether the workflow is considered active. more details | more details | Workflow | |
String | The name of the current step in the workflow. more details | more details | Workflow | |
String | The type of workflow. more details | more details | CreateWorkflow |
Property Details
Shared workflow data. Can be either 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.
Indicates whether the workflow is considered active.
- Default Value:false
The name of the current step in the workflow.
- type Stringreadonly
The type of workflow.
For CreateWorkflow the type is always "create".
Method Overview
Name | Return Type | Summary | Class | |
---|---|---|---|---|
Cancels the active workflow. more details | more details | Workflow | ||
Call this method when the workflow is considered finished. more details | more details | Workflow | ||
Moves to the next step in the workflow. more details | more details | Workflow | ||
Moves to the previous step in the workflow. more details | more details | Workflow | ||
Resets the workflow. more details | more details | Workflow | ||
Starts the workflow. more details | more details | Workflow |
Method Details
- cancel()inherited
Cancels the active workflow.
- commit()inherited
Call this method when the workflow is considered finished. This method is used to help process the editing results.
- next()inherited
Moves to the next step in the workflow.
- previous()inherited
Moves to the previous step in the workflow.
- reset()inherited
Resets the workflow.
- start()inherited
Starts the workflow.