CreateFeaturesWorkflowData | API Reference | ArcGIS Maps SDK for JavaScript 4.32

This object supports the Editor widget. It contains data for the CreateFeaturesWorkflow. This is accessed via the CreateFeaturesWorkflow.data.

See also

Property Overview

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
CreationInfo\|null\|undefined	This provides the feature template and layer when creating a new feature.	CreateFeaturesWorkflowData
String	The name of the class.	Accessor
FeatureTemplate\|SharedTemplate\|null\|undefined	The full version of the template referenced by the property `creationInfo.template`.	CreateFeaturesWorkflowData
Collection<Graphic>	Returns a collection of graphics representing features that have been created during the workflow.	CreateFeaturesWorkflowData
EditorViewModel	The associated EditorViewModel for this workflow.	CreateFeaturesWorkflowData

Property Details

creationInfo Property creationInfo CreationInfo |null |undefined

This provides the feature template and layer when creating a new feature.

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

The name of the class. The declared class name is formatted as esri.folder.className.

fullTemplate Property fullTemplate FeatureTemplate |SharedTemplate |null |undefined

The full version of the template referenced by the property creationInfo.template. If that template is a standard FeatureTemplate, this property will simply reference that template. If the template is a SharedTemplateMetadata, this property will be set to an instance of SharedTemplate representing that template's full definition.

Note, if this property references an instance of SharedTemplate, the instance will have already been loaded. Clients assigning a new value to this property should ensure that load has been called on the new value.

pendingFeatures Property pendingFeatures Collection<Graphic>readonly

Returns a collection of graphics representing features that have been created during the workflow.

See also

{CreateFeaturesWorkflow}

viewModel Property viewModel EditorViewModel

The associated EditorViewModel for this workflow.

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor 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();

Parameters

handleOrHandles WatchHandle|WatchHandle []

Handles marked for removal once the object is destroyed.

groupKey *

optional

Key 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 Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.

Returns true if a named group of handles exist.

Parameter

groupKey *

optional

A group key.

Returns

Type	Description
Boolean	Returns `true` if 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");
}

removeHandles Inherited Method removeHandles(groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.

Removes a group of handles owned by the object.

Parameter

groupKey *

optional

A group key or an array or collection of group keys to remove.

Example

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");