Skip To ContentArcGIS for DevelopersSign In Dashboard

CreateWorkflow

Class: esri/widgets/Editor/CreateWorkflow
Inheritance: CreateWorkflow Workflow Accessor
Since: ArcGIS API for JavaScript 4.15

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.

addFeature

StageAdd feature example
1 - After selecting Add feature, the first panel contains the CreateWorkflowData.viewModel.firstPanel
2 - After a template is selected, the next panel has access to CreateWorkflowData.creationInfo and CreateWorkflowData.viewModel.addpoint
3 - Once a feature geometry is specified, the subsequent attribute panel has access to CreateWorkflowData.creationInfo, UpdateWorkflowData.edits, and CreateWorkflowData.viewModel.addattributes

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.

See also:

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummaryClass
CreateWorkflowData|UpdateWorkflowData

Shared workflow data.

more details
more detailsWorkflow
String

The name of the class.

more details
more detailsAccessor
Boolean

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

more details
more detailsWorkflow
Boolean

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

more details
more detailsWorkflow
Boolean

Indicates whether the workflow is considered active.

more details
more detailsWorkflow
String

The name of the current step in the workflow.

more details
more detailsWorkflow
String

The type of workflow.

more details
more detailsCreateWorkflow

Property Details

Shared workflow data. Can be either CreateWorkflowData 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 CreateWorkflow the type is always "create".

Method Overview

NameReturn TypeSummaryClass

Cancels the active workflow.

more details
more detailsWorkflow

Call this method when the workflow is considered finished.

more details
more detailsWorkflow

Moves to the next step in the workflow.

more details
more detailsWorkflow

Moves to the previous step in the workflow.

more details
more detailsWorkflow

Resets the workflow.

more details
more detailsWorkflow

Starts the workflow.

more details
more detailsWorkflow

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.

Moves to the next step in the workflow.

Moves to the previous step in the workflow.

reset()inherited

Resets the workflow.

start()inherited

Starts the workflow.

API Reference search results

NameTypeModule
Loading...