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

Stage Add 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.
Show inherited properties Hide inherited properties
Name Type Summary Class
CreateWorkflowData|UpdateWorkflowDatamore details

Shared workflow data.

more detailsWorkflow
Stringmore details

The name of the class.

more detailsAccessor
Booleanmore details

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

more detailsWorkflow
Booleanmore details

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

more detailsWorkflow
Booleanmore details

Indicates whether the workflow is considered active.

more detailsWorkflow
Stringmore details

The name of the current step in the workflow.

more detailsWorkflow
Stringmore details

The type of workflow.

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

Show inherited methods Hide inherited methods
Name Return Type Summary Class
Promise<void>more details

Cancels the active workflow.

more detailsWorkflow
Promise<void>more details

Call this method when the workflow is considered finished.

more detailsWorkflow
Promise<void>more details

Moves to the next step in the workflow.

more detailsWorkflow
Promise<void>more details

Moves to the previous step in the workflow.

more detailsWorkflow
Promise<void>more details

Resets the workflow.

more detailsWorkflow
Promise<void>more details

Starts the workflow.

more detailsWorkflow

Method Details

cancel(){Promise<void>}inherited

Cancels the active workflow.

Returns:
Type Description
Promise<void>
commit(){Promise<void>}inherited

Call this method when the workflow is considered finished. This method is used to help process the editing results.

Returns:
Type Description
Promise<void>

Moves to the next step in the workflow.

Returns:
Type Description
Promise<void>

Moves to the previous step in the workflow.

Returns:
Type Description
Promise<void>
reset(){Promise<void>}inherited

Resets the workflow.

Returns:
Type Description
Promise<void>
start(){Promise<void>}inherited

Starts the workflow.

Returns:
Type Description
Promise<void>

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.