Editor | API Reference | ArcGIS Maps SDK for JavaScript 4.31

Overview
Editor workflows
SceneLayer editing
Snapping in the Editor
Tooltips and editing constraints
Relationship editing
Editing date and time
Editing big integer data
Elevated user privileges
Suggestions and known limitations

Overview

This widget provides an out-of-the-box editing experience to help streamline editing within a web application. It automatically recognizes if there are editable feature layers within the map. The layers that are editable will automatically be used by the widget. It is possible to configure how the Editor behaves by setting its layerInfos property. This property takes an array of objects which allows configuring the the editing experience for these layers.

editor

Note that the update operations (such as rotate, move, and transform) happen in the map space. This means that, for example in 3D, if a graphic is rotated in a global WGS84 view, its shape and segment lengths change.

Editor workflows

The widget has different workflows based on the functionality needed. These workflows are dependent upon permissions set on the service or within the client application.

CreateFeaturesWorkflow - This workflow allows both individual and continuous feature creation at once. It is possible to continuously create multiple features of the same type at once. After the initial sketch is created, the attribute form will display with the set field elements. These fields can be updated as the user creates new features.
UpdateWorkflow - This workflow allows you to update and/or delete existing features within an editable feature layer.

SceneLayer editing

Since 4.27, it is possible to upload 3D models of various formats to an editable SceneLayer.

The following model formats are currently supported. For additional information, please refer to the ArcGIS Pro documentation. Please note that only one model can be uploaded at a time and zip files should be used for a model with additional texture files.

COLLADA (.dae)
Autodesk Filmbox (.fbx)
Autodesk Drawing (.dwg)
Industry Foundation Classes (.ifc)
Universal Scene Description (.usdc, .usdz)
Wavefront (.obj)
GL Transmission Format (.glTF)
Binary GL Transmission Format (.glb)

Snapping in the Editor

Snapping can be configured using the controls in the Editor widget's "Settings" menu. By default, snapping is disabled. Toggle "Enable snapping" to enable it. By default, both geometry guides and feature-to-feature snapping are enabled.

Geometry guides allow the editor to specify how they want their geometries to be drawn. For example, when the segment being drawn is nearly perpendicular to another segment, the cursor may snap to form a precise right angle.

Feature-to-feature snapping allows new or existing geometries to be snapped to other geometries, including those in other layers, as shown within the "Snapping layer" list. By default, all layers that can be configured for snapping are shown in this list. The available layers can be restricted by updating the Editor's snappingOptions by setting the FeatureSnappingLayerSource directly.

Tooltips and editing constraints

The tooltips provide useful information about a feature or its components (vertices and segments) that are being drawn or edited. For example, they show the position of vertices, the direction and distance of segments, as well as orientation and scale of meshes.

The tooltips can be enabled in the Editor widget's "Settings" menu.

Coordinate inputs and editing constraints are helpful to achieve greater control while drawing features. Press Tab to activate the input mode while drawing a new feature, or when editing a point, mesh, or a selected vertex.

See more about the available tooltip inputs and constraints under the tooltip options class.

editing constraints

Relationship editing

It is possible to edit related data via the Editor widget. The relationship element provides the functionality needed to configure the relationship within the formTemplate. These elements must be saved within the form for the Editor to support editing related data. This can be accomplished via the Map Viewer's authoring experience or programmatically using the SDK.

Once the form is authored, the Editor automatically checks if there is a formTemplate set on the editable layer, or the widget's corresponding layerInfo. If the form's template is not set or is not configured to contain relationship elements, the Editor will not display the option to edit the relationship data. Additional considerations when using the Editor to edit related data are provided below.

editing related records with the Editor widget

Considerations when editing related data in the Editor

Support is limited to 1:1 and 1:M cardinality.
Support is limited to feature-to-table and feature-to-feature relationships, ie. origin-to-destination. The origin's entry point must be a feature with geometry.
Relationship editing is only supported using ArcGIS Online and ArcGIS Enterprise version 11.2 or higher feature services.
The layer and associated relationship elements must be editable in order for the relationship to display.
The origin (parent) feature must be editable in order to edit the related destination (child) feature/row.
Data containing related records will display the relationship in the associated form as long as there is a relationship element configured in the layer or form's formTemplate. This can be accomplished via the Map Viewer's authoring experience, Field Maps Designer, or programmatically using the API.
The related layer or table must also be added to the map to be able to configure relationship elements.

Editing date and time

The Editor displays the date field type in the MapView's timeZone by default. However, when working with the timestamp-offset type, the data is displayed using the stored date values from the service. For example, if the stored value is 2023-09-11T22:39:05.242-0400, then the Editor will present three inputs to edit the date (9/11/2023), time (10:39:05 PM), and time zone offset (GMT-4) regardless of the MapView time zone.

Here are a few points to consider if using an unknown timezone:

The layer's setting takes priority over the view. For example, if a layer's timezone is unknown, both date and timestamp-offset field types are shown in UTC.
If a view's timezone is set to to unknown, but a layer has a preferredTimeZone, date field types will display values with the preferred time zone that is set within the layer.
If a view and layer's timezone are set to unknown, date field types will display values using UTC. If a view's timezone is set to to unknown and working with timestamp-offset field types, date is shown as-is, ie. as it's stored within the raw data.

Editing big integer data

The big-integer data type is a 64-bit signed integer that can store very large whole number integer values with the range of -9007199254740991 and 9007199254740991. Web applications can only edit whole numbers between -9007199254740991 and 9007199254740991. Any attempts to edit a number value higher or lower than these thresholds will not work and those edits will not be saved.

Elevated user privileges

Authenticated users that are layer owners, administrators or users with full editing privileges will have their elevated user privileges applied in regards to editing behavior and data access. This mimics the behavior available in Map Viewer. To opt out, set esriConfig.userPrivilegesApplied to false.

Suggestions and known limitations

It is not recommended to set a very small refreshInterval on an editable layer as this can potentially degrade performance within the application.
Editor workflows are only enabled if the feature service allows these operations. In addition, if wanting to completely remove the ability to select and update, it is necessary to also set attachmentsOnUpdateEnabled: false in layerInfo.attachmentsOnUpdateEnabled.
If a layer's feature template is not enabled within the Editor, check that the layer's permissions are enabled for editing. In addition, make sure that the layer is visible. If the feature template does not display, make sure that the layer is fully loaded in the map and that the Editor has access to edit it.

See also

Example

// At the very minimum, set the Editor's view
const editor = new Editor({
  view: view
});

view.ui.add(editor, "top-right");

Constructors

Editor Constructor new Editor(properties)

Parameter

properties Object

optional

See the properties for a list of all the properties that may be passed into the constructor.

Example

// Typical usage for Editor widget. By default, this will recognize all editable layers in the map if no specific layers are set. It is also possible to iterate through the map's editableLayers and load any layers needed for editing.

const editor = new Editor({
  view: view
});

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
CreateFeaturesWorkflow\|UpdateWorkflow	A property indicating the current active workflow.	Editor
String	An array of string values which specifies what end users are allowed to edit.	Editor
String\|HTMLElement	The ID or node representing the DOM element containing the widget.	Widget
String	The name of the class.	Accessor
Number	Indicates the heading level to use for title of the widget.	Editor
String	Icon which represents the widget.	Editor
String	The unique ID assigned to the widget when the widget is created.	Widget
String	The widget's default label.	Editor
SketchLabelOptions	Options to configure the sketch labels shown next to each segment of the geometry being created or updated.	Editor
LayerInfo []	An array of editing configurations for individual layers.	Editor
SnappingOptions	The SnappingOptions for editing.	Editor
SupportingWidgetDefaults	This property allows customization of supporting Editor widgets and their default behavior.	Editor
SketchTooltipOptions	Options to configure the tooltip shown next to the cursor when creating or updating graphics.	Editor
SketchValueOptions	Options to configure how values are displayed and input when creating or updating graphics.	Editor
MapView\|SceneView	A reference to the MapView or SceneView.	Editor
EditorViewModel	The view model for this widget.	Editor
Boolean	Indicates whether the widget is visible.	Widget
VisibleElements	The visible elements that are displayed within the widget.	Editor

Property Details

activeWorkflow Property activeWorkflow CreateFeaturesWorkflow |UpdateWorkflowreadonly

A property indicating the current active workflow. This is either CreateFeaturesWorkflow or UpdateWorkflow.

allowedWorkflows Property allowedWorkflows String Deprecated since version 4.29. Use Editor.visibleElements instead.

An array of string values which specifies what end users are allowed to edit.

Possible Value	Description
create-features	This allows the end user to create either individual or continuous features in the feature service.
update	This allows the end user to update and/or delete features in the feature service.

Possible Values:"create-features" |"update"

See also

container Inherited Property container String |HTMLElement Inherited from Widget

The ID or node representing the DOM element containing the widget. This property can only be set once. The following examples are all valid use case when working with widgets.

Examples

// Create the HTML div element programmatically at runtime and set to the widget's container
const basemapGallery = new BasemapGallery({
  view: view,
  container: document.createElement("div")
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});

// Specify an already-defined HTML div element in the widget's container

const basemapGallery = new BasemapGallery({
  view: view,
  container: basemapGalleryDiv
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});

// HTML markup
<body>
  <div id="viewDiv"></div>
  <div id="basemapGalleryDiv"></div>
</body>

// Specify the widget while adding to the view's UI
const basemapGallery = new BasemapGallery({
  view: view
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

headingLevel Property headingLevel Number Since: ArcGIS Maps SDK for JavaScript 4.20 Editor since 4.11, headingLevel added at 4.20.

Indicates the heading level to use for title of the widget. By default, the title (i.e. "Editor") is rendered as a level 4 heading (e.g. <h4>Editor</h4>). Depending on the widget's placement in your app, you may need to adjust this heading for proper semantics. This is important for meeting accessibility standards.

Default Value:4

See also

Heading Elements

Example

// "Editor" will render as an <h3>
editor.headingLevel = 3;

icon Property icon String Since: ArcGIS Maps SDK for JavaScript 4.27 Editor since 4.11, icon added at 4.27.

Icon which represents the widget. It is typically used when the widget is controlled by another one (e.g. in the Expand widget).

Default Value:"pencil"

See also

Calcite Icon Search

id Inherited Property id String Inherited from Widget

The unique ID assigned to the widget when the widget is created. If not set by the developer, it will default to the container ID, or if that is not present then it will be automatically generated.

label Property label String

The widget's default label.

labelOptions Property labelOptions SketchLabelOptionsautocast Since: ArcGIS Maps SDK for JavaScript 4.24 Editor since 4.11, labelOptions added at 4.24.

Options to configure the sketch labels shown next to each segment of the geometry being created or updated.

Known Limitation

Sketch labels are currently only supported when working with a SceneView.

layerInfos Property layerInfos LayerInfo[]

An array of editing configurations for individual layers. It is possible to iterate through the map's editableLayers and configure these individual layers as needed.

If you have an editable feature layer but do not want the end user to do any type of editing, you can limit this by setting the enabled property to false.

See also

Example

const editor = new Editor({
  view: view,
  layerInfos: [{
    layer: featureLayer, // pass in the feature layer,
    formTemplate:  { // autocastable to FormTemplate
      elements: [
        { // autocastable to FieldElement
          type: "field",
          fieldName: "fulladdr",
          label: "Full Address"
        }
      ]
    },
    enabled: true, // Default is true, set to false to disable editing functionality.
    addEnabled: true, // Default is true, set to false to disable the ability to add a new feature.
    updateEnabled: false, // Default is true, set to false to disable the ability to edit an existing feature.
    deleteEnabled: false, // Default is true, set to false to disable the ability to delete features.
    attributeUpdatesEnabled: true, // Default is true, set to false to disable the ability to edit attributes in the update workflow.
    geometryUpdatesEnabled: true, // Default is true, set to false to disable the ability to edit feature geometries in the update workflow.
    attachmentsOnCreateEnabled: true, //Default is true, set to false to disable the ability to work with attachments while creating features.
    attachmentsOnUpdateEnabled: true //Default is true, set to false to disable the ability to work with attachments while updating/deleting features.
  }]
});

snappingOptions Property snappingOptions SnappingOptionsautocast Since: ArcGIS Maps SDK for JavaScript 4.19 Editor since 4.11, snappingOptions added at 4.19.

The SnappingOptions for editing. Supports self snapping and feature snapping. Starting with version 4.23, the SnappingControls UI is automatically integrated into the Editor widget. Modify the snappingOptions if modifications are needed from what is provided in the default UI.

See also

Sample - Editor widget with configurations

Example

// Creates the Editor with SnappingOptions with no snapping UI
const editor = new Editor({
  view: view,
  snappingOptions: { // autocasts to SnappingOptions()
    enabled: true,
    featureSources: [{layer: streetsLayer}] // autocasts to FeatureSnappingLayerSource()
  }
});

// Add the widgets to the view
view.ui.add(editor, "top-right");

supportingWidgetDefaults Property supportingWidgetDefaults SupportingWidgetDefaults

This property allows customization of supporting Editor widgets and their default behavior. These widgets include FeatureForm, FeatureTemplates, and the SketchViewModel.

This property is useful for basic overrides of the default widgets. There may be some limitations to what the Editor can do with these overridden properties. For example, the Editor will disable the multipleSelectionEnabled property in Sketch.defaultUpdateOptions no matter what is set within this property.

See also

tooltipOptions Property tooltipOptions SketchTooltipOptionsautocast Since: ArcGIS Maps SDK for JavaScript 4.24 Editor since 4.11, tooltipOptions added at 4.24.

Options to configure the tooltip shown next to the cursor when creating or updating graphics.

valueOptions Property valueOptions SketchValueOptionsautocast Since: ArcGIS Maps SDK for JavaScript 4.29 Editor since 4.11, valueOptions added at 4.29.

Options to configure how values are displayed and input when creating or updating graphics.

view Property view MapView |SceneView

A reference to the MapView or SceneView. This view provides the editable layers for the Editor widget.

viewModel Property viewModel EditorViewModelautocast

The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the EditorViewModel class to access all properties and methods on the widget.

visible Inherited Property visible Boolean Inherited from Widget

Indicates whether the widget is visible.

If false, the widget will no longer be rendered in the web document. This may affect the layout of other elements or widgets in the document. For example, if this widget is the first of three widgets associated to the upper right hand corner of the view UI, then the other widgets will reposition when this widget is made invisible. For more information, refer to the css display value of "none".

Default Value:true

Example

// Hides the widget in the view
widget.visible = false;

visibleElements Property visibleElements VisibleElements Since: ArcGIS Maps SDK for JavaScript 4.25 Editor since 4.11, visibleElements added at 4.25.

The visible elements that are displayed within the widget. This property provides the ability to turn individual elements of the widget's display on/off.

Example

editor.visibleElements = {
  snappingControls: true,
  snappingControlsElements: {
    featureEnabledToggle: false, // removes "Feature to feature" toggle
    layerList: false // removes Snapping layers list
  }
};

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
Promise<void>	Cancels any active workflow.	Editor
String	A utility method used for building the value for a widget's `class` property.	Widget
Promise<void>	This is applicable if there is an active UpdateWorkflow.	Editor
	Destroys the widget instance.	Widget
Boolean	Emits an event on the instance.	Widget
Boolean	Indicates whether there is an event listener on the instance that matches the provided event name.	Widget
Boolean	Returns true if a named group of handles exist.	Accessor
Boolean	`isFulfilled()` may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).	Widget
Boolean	`isRejected()` may be used to verify if creating an instance of the class is rejected.	Widget
Boolean	`isResolved()` may be used to verify if creating an instance of the class is resolved.	Widget
Object	Registers an event handler on the instance.	Widget
	Adds one or more handles which are to be tied to the lifecycle of the widget.	Widget
	Executes after widget is ready for rendering.	Widget
	Removes a group of handles owned by the object.	Accessor
Object	This method is implemented by subclasses for rendering.	Widget
	Renders widget to the DOM immediately.	Widget
	Schedules widget rendering.	Widget
Promise<void>	Initiates the CreateFeaturesWorkflow by displaying the panel where feature(s) creation begins.	Editor
Promise<void>	This method starts the CreateFeaturesWorkflow at the "creating-features" step with the provided feature.	Editor
Promise<void>	Initiates the CreateFeaturesWorkflow by displaying the FeatureTemplates panel.	Editor
Promise<void>	Starts the UpdateWorkflow at the attribute editing panel.	Editor
Promise<void>	Starts the UpdateWorkflow using the current selected feature.	Editor
Promise<void>	This method starts the UpdateWorkflow where it waits for multiple features to be selected.	Editor
Promise	`when()` may be leveraged once an instance of the class is created.	Widget

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.

cancelWorkflow Method cancelWorkflow(){Promise<void>}

Cancels any active workflow.

Returns

Type	Description
Promise<void>	Resolves once the workflow is canceled.

classes Inherited Method classes(classNames){String} Inherited from Widget

A utility method used for building the value for a widget's class property. This aids in simplifying css class setup.

Parameter

classNames String|String []|Object

repeatable

The class names.

Returns

Type	Description
String	The computed class name.

Example

// .tsx syntax showing how to set css classes while rendering the widget

render() {
  const dynamicClasses = {
    [css.flip]: this.flip,
    [css.primary]: this.primary
  };

  return (
    <div class={classes(css.root, css.mixin, dynamicClasses)} />
  );
}

deleteFeatureFromWorkflow Method deleteFeatureFromWorkflow(){Promise<void>}

This is applicable if there is an active UpdateWorkflow. If so, this method deletes the workflow feature.

Returns

Type	Description
Promise<void>	Resolves once the active UpdateWorkflow is deleted.

See also

UpdateWorkflow

destroy Inherited Method destroy() Inherited from Widget

Destroys the widget instance.

emit Inherited Method emit(type, event){Boolean} Inherited from Widget

Emits an event on the instance. This method should only be used when creating subclasses of this class.

Parameters

type String

The name of the event.

event Object

optional

The event payload.

Returns

Type	Description
Boolean	`true` if a listener was notified

hasEventListener Inherited Method hasEventListener(type){Boolean} Inherited from Widget

Indicates whether there is an event listener on the instance that matches the provided event name.

Parameter

type String

The name of the event.

Returns

Type	Description
Boolean	Returns true if the class supports the input event.

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");
}

isFulfilled Inherited Method isFulfilled(){Boolean} Inherited from Widget Since: ArcGIS Maps SDK for JavaScript 4.19 Widget since 4.2, isFulfilled added at 4.19.

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). If it is fulfilled, true will be returned.

Returns

Type	Description
Boolean	Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).

isRejected Inherited Method isRejected(){Boolean} Inherited from Widget Since: ArcGIS Maps SDK for JavaScript 4.19 Widget since 4.2, isRejected added at 4.19.

isRejected() may be used to verify if creating an instance of the class is rejected. If it is rejected, true will be returned.

Returns

Type	Description
Boolean	Indicates whether creating an instance of the class has been rejected.

isResolved Inherited Method isResolved(){Boolean} Inherited from Widget Since: ArcGIS Maps SDK for JavaScript 4.19 Widget since 4.2, isResolved added at 4.19.

isResolved() may be used to verify if creating an instance of the class is resolved. If it is resolved, true will be returned.

Returns

Type	Description
Boolean	Indicates whether creating an instance of the class has been resolved.

on Inherited Method on(type, listener){Object} Inherited from Widget

Registers an event handler on the instance. Call this method to hook an event with a listener.

Parameters

type String|String []

An event or an array of events to listen for.

listener Function

The function to call when the event fires.

Returns

Type Description

Object

Returns an event handler with a remove() method that should be called to stop listening for the event(s).

Property	Type	Description
remove	Function	When called, removes the listener from the event.

Example

view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});

own Inherited Method own(handleOrHandles) Inherited from Widget Since: ArcGIS Maps SDK for JavaScript 4.24 Widget since 4.2, own added at 4.24. Deprecated since 4.28 Use addHandles() instead.

Adds one or more handles which are to be tied to the lifecycle of the widget. The handles will be removed when the widget is destroyed.

const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true}
);

this.own(handle); // Handle gets removed when the widget is destroyed.

Parameter

handleOrHandles WatchHandle|WatchHandle []

Handles marked for removal once the widget is destroyed.

postInitialize Inherited Method postInitialize() Inherited from Widget

Executes after widget is ready for rendering.

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");

render Inherited Method render(){Object} Inherited from Widget

This method is implemented by subclasses for rendering.

Returns

Type	Description
Object	The rendered virtual node.

renderNow Inherited Method renderNow() Inherited from Widget

Renders widget to the DOM immediately.

scheduleRender Inherited Method scheduleRender() Inherited from Widget

Schedules widget rendering. This method is useful for changes affecting the UI.

startCreateFeaturesWorkflowAtFeatureCreation Method startCreateFeaturesWorkflowAtFeatureCreation(creationInfo){Promise<void>} Since: ArcGIS Maps SDK for JavaScript 4.23 Editor since 4.11, startCreateFeaturesWorkflowAtFeatureCreation added at 4.23.

Initiates the CreateFeaturesWorkflow by displaying the panel where feature(s) creation begins. This method takes a CreationInfo object containing the layer(s) and template(s) to use.

Parameter

creationInfo CreationInfo

An object containing information needed to create a new feature using the Editor widget. This object provides the feature template and layer for creating a new feature or features.

Returns

Type	Description
Promise<void>	Resolves when the CreateFeaturesWorkflow initiates and displays the panel where feature(s) creation begins.

See also

CreateFeaturesWorkflow

startCreateFeaturesWorkflowAtFeatureEdit Method startCreateFeaturesWorkflowAtFeatureEdit(params){Promise<void>} Since: ArcGIS Maps SDK for JavaScript 4.29 Editor since 4.11, startCreateFeaturesWorkflowAtFeatureEdit added at 4.29.

This method starts the CreateFeaturesWorkflow at the "creating-features" step with the provided feature.

Any CreateFeaturesWorkflow instance generated by this method will only support creating a single feature per operation, (ie. batch creation is disabled).

Parameters

params Object

Parameters object containing an initialFeature to use in the associated CreateFeaturesWorkflow.

Specification

initialFeature Graphic

The initial feature used when you begin creating features.

Returns

Type	Description
Promise<void>	Resolves once the CreateFeaturesWorkflow initiates and displays the panel where additional edits can be made to the provided feature.

See also

CreateFeaturesWorkflow

startCreateFeaturesWorkflowAtFeatureTypeSelection Method startCreateFeaturesWorkflowAtFeatureTypeSelection(){Promise<void>} Since: ArcGIS Maps SDK for JavaScript 4.23 Editor since 4.11, startCreateFeaturesWorkflowAtFeatureTypeSelection added at 4.23.

Initiates the CreateFeaturesWorkflow by displaying the FeatureTemplates panel.

Returns

Type	Description
Promise<void>	Resolves when the CreateFeaturesWorkflow is initiated and displays the FeatureTemplates panel.

startUpdateWorkflowAtFeatureEdit Method startUpdateWorkflowAtFeatureEdit(feature){Promise<void>}

Starts the UpdateWorkflow at the attribute editing panel.

Parameter

feature Graphic

The feature to be updated.

Returns

Type	Description
Promise<void>	Resolves once the UpdateWorkflow initiates the attribute editing panel.

See also

startUpdateWorkflowAtFeatureSelection Method startUpdateWorkflowAtFeatureSelection(){Promise<void>}

Starts the UpdateWorkflow using the current selected feature.

Returns

Type	Description
Promise<void>	Resolves once the UpdateWorkflow is initiated using the current selected feature.

See also

UpdateWorkflow

startUpdateWorkflowAtMultipleFeatureSelection Method startUpdateWorkflowAtMultipleFeatureSelection(candidates){Promise<void>}

This method starts the UpdateWorkflow where it waits for multiple features to be selected.

Parameter

candidates Graphic []

An array of features to be updated. This is only relevant when there are multiple candidates to update.

Returns

Type	Description
Promise<void>	Resolves once the UpdateWorkflow is initiated as it waits for multiple features to be selected.

See also

UpdateWorkflow

when Inherited Method when(callback, errback){Promise} Inherited from Widget Since: ArcGIS Maps SDK for JavaScript 4.19 Widget since 4.2, when added at 4.19.

when() may be leveraged once an instance of the class is created. This method takes two input parameters: a callback function and an errback function. The callback executes when the instance of the class loads. The errback executes if the instance of the class fails to load.

Parameters

callback Function

optional

The function to call when the promise resolves.

errback Function

optional

The function to execute when the promise fails.

Returns

Type	Description
Promise	Returns a new Promise for the result of `callback`.

Example

// Although this example uses the BasemapGallery widget, any class instance that is a promise may use when() in the same way
let bmGallery = new BasemapGallery();
bmGallery.when(function(){
  // This function will execute once the promise is resolved
}, function(error){
  // This function will execute if the promise is rejected due to an error
});

Type Definitions

CreationInfo Type Definition CreationInfo

This object provides required and optional properties needed when creating a new feature.

Properties: layer FeatureLayer|OrientedImageryLayer|SceneLayer|SubtypeSublayer

The associated layer for newly-created feature.

template FeatureTemplate

The associated feature template used to create new features.

geometryToPlace Mesh

optional
The associated Mesh geometry for the newly-created feature. This property is only applicable when editing scene layers.

maxFeatures Number

optional
The maximum amount of feature to create in one batch editing operation.

initialFeature Graphic

optional
The initial feature used when you begin creating features.

LayerInfo Type Definition LayerInfo

Configurations used for setting the layer's editable preferences within the Editor.

Properties: layer FeatureLayer|OrientedImageryLayer|SceneLayer|SubtypeSublayer|SubtypeGroupLayer

The associated layer containing the fields to edit.

enabled Boolean

optional
Default Value:true

Indicates whether to enable editing on the layer.

addEnabled Boolean

optional
Default Value:true

Indicates whether to enable the ability to create new features.

updateEnabled Boolean

optional
Default Value:true

Indicates whether to enable the ability to update existing features.

deleteEnabled Boolean

optional
Default Value:true

Indicates whether to enable the ability to delete features.

attributeUpdatesEnabled Boolean

optional
Default Value:true

Indicates whether to enable or disable attribute updates from the feature's form.

attachmentsOnCreateEnabled Boolean

optional
Default Value:true

(Since 4.26) Indicates whether to enable or disable attachments while creating features. Support for this is dependent upon whether this operation is supported on the FeatureLayer.capabilities.operations.

attachmentsOnUpdateEnabled Boolean

optional
Default Value:true

(Since 4.26) Indicates whether to enable or disable attachments while updating existing features. Support for this is dependent upon whether update or delete operations are supported on the FeatureLayer.capabilities.

The Editor will not display attachment file names if it is displaying image types. These images must have resize support within its corresponding FeatureLayer, ie. FeatureLayer.capabilities.attachment.supportsResize is true. Attachment types, other than images, will display an icon and its corresponding file name.

geometryUpdatesEnabled Boolean

optional
Default Value:true

Indicates whether to enable or disable geometry updates.

formTemplate FormTemplate

optional
A template that defines the feature's form content. Use this when setting the fields for editing.

SupportingWidgetDefaults Type Definition SupportingWidgetDefaults

Set this to customize any supporting Editor widget's default behavior. Specific properties can be adjusted in the Attachments, FeatureForm, and FeatureTemplates widgets. In addition, it is possible to update specific properties within the SketchViewModel.

Properties

attachments Object

optional

An object containing properties specific for customizing the Attachments widget.

Specification: displayType String

optional
String indicating how to display the attachments.

capabilities AttachmentsCapabilities

optional
The capabilities needed for the attachments widget.

featureForm Object

optional

An object containing properties specific for customizing the FeatureForm widget.

Specification: groupDisplay String

optional
String indicating the groupDisplay and how they will be displayed to the end user. This only applies if using grouped field elements configured in the Editor's layer infos.

featureTemplates Object

optional

An object containing properties specific for customizing the FeatureTemplates widget.

Specification: groupBy String|GroupByFunction

optional
Aids in managing various template items and how they display within the widget. Please refer to groupBy API reference for additional information.

visibleElements.filter Boolean

optional
Indicates whether the templates filter displays.

enableListScroll Boolean

optional
(Since 4.28) Indicates whether the list of feature template items should scroll within the containing element.

sketch Object

optional

An object containing properties specific for customizing the Sketch widget.

Specification: defaultUpdateOptions Object

optional
An object containing the defaultUpdateOptions for the Sketch widget.

markerSymbol SimpleMarkerSymbol

optional
The marker symbol used to symbolize any point feature updates.

polygonSymbol SimpleFillSymbol

optional
The polygon symbol used to symbolize any polygon feature updates.

polylineSymbol SimpleLineSymbol

optional
The line symbol used to symbolize any line feature updates.

VisibleElements Type Definition VisibleElements

The visible elements that are displayed within the widget. This provides the ability to turn individual elements of the widget's display on/off.

Properties

createFeaturesSection Boolean

optional

Since 4.28. Indicates whether to display the "create features" section of the widget in the default view.

editFeaturesSection Boolean

optional

Since 4.28. Indicates whether to display the "edit features" section of the widget in the default view.

labelsToggle Boolean

optional

Since 4.29. Indicates whether to display the sketch labels toggle. Default value is true.

tooltipsToggle Boolean

optional

Since 4.29. Indicates whether to display the tooltips toggle. Default value is true.

settingsMenu Boolean

optional

Since 4.30. Indicates whether to display the settings menu. This menu contains the snapping and tooltips settings.

snappingControls Boolean

optional

Indicates whether to display the SnappingControls widget. Default is true.

snappingControlsElements Object

optional

The available SnappingControls elements within the widget.

Properties

header Boolean

optional

Indicates whether to display the header. Default is false.

enabledToggle Boolean

optional

Indicates whether to display the enabledToggle (Enable snapping). Default is true. This toggles the SnappingOptions.enabled property.

Note

It is recommended to set Editor.snappingOptions.enabled = true if enabledToggle is set to false. This is because selfEnabledToggle and featureEnabledToggle require snapping globally to be enabled in order to be interactive. Otherwise, these toggles will not be responsive.

selfEnabledToggle Boolean

optional

Indicates whether to display the selfEnabledToggle (Geometry guides). Default is true. This toggles the SnappingOptions.selfEnabled property.

featureEnabledToggle Boolean

optional

Indicates whether to display the featureEnabledToggle (Feature to feature). Default is true. This toggles the SnappingOptions.featureEnabled property.

layerList Boolean

optional

Indicates whether to display the FeatureSnappingLayerSource layerList. Default is true. The layerlist provides the available layer sources supported for snapping.

layerListToggleLayersButton Boolean

optional

Indicates whether to display the “Enable all” or “Disable all” button to enable / disable snapping for all the layers in the list.

gridEnabledToggle Boolean

optional

Since 4.30. Indicates whether to display the grid display toggle embedded in grid controls. Default is false.

gridControls Boolean

optional

Since 4.30. Indicates whether to display the grid controls widget embedded in snapping controls. Default is true.

gridControlsElements Object

optional

Since 4.30. The available GridControls elements within the widget.

Specification: gridSnapEnabledToggle Boolean

optional
Indicates whether to display the grid snapping toggle embedded in grid controls. Default is false.

gridEnabledToggle Boolean

optional
Indicates whether to display the grid display toggle embedded in grid controls. Default is false.

colorSelection Boolean

optional
Indicates whether to display the color/theme selection component of grid controls. Default is true.

dynamicScaleToggle Boolean

optional
Indicates whether to display the dynamic scaling toggle in grid controls. Default is true.

rotateWithMapToggle Boolean

optional
Indicates whether to display the 'rotate with map' toggle in grid controls. Default is true.

numericInputs Boolean

optional
Indicates whether to display the spacing and rotation inputs in grid controls. Default is true.

lineIntervalInput Boolean

optional
Indicates whether to display the major line interval input in grid controls. Default is true.

placementButtons Boolean

optional
Indicates whether to display the interactive placement buttons in grid controls. Default is true.

outOfScaleWarning Boolean

optional
Indicates whether to display a notice when the grid is not visible because it is out of scale and dynamic scaling is turned off. Default is true.

Example

// This removes the feature enabled snapping toggle and the layerlist.
editor.visibleElements = {
  snappingControlsElements: {
    featureEnabledToggle: false,
    layerList: false
  }
}

Event Overview

Name	Type	Summary	Class
	{type: "sketch-create",layer: FeatureLayer\|SceneLayer\|SubtypeSublayer,detail: Object,detail.graphic: Graphic,detail.state: "start"\|"active"\|"complete"\|"cancel",detail.tool: "point"\|"multipoint"\|"polyline"\|"polygon"\|"circle"\|"rectangle"\|"mesh",detail.toolEventInfo: CreateToolEventInfo,detail.type: "create"}	Fires when a user starts drawing a feature, is actively drawing a feature, and completes drawing a feature.	Editor
	{type: "sketch-update",layer: FeatureLayer\|SceneLayer\|SubtypeSublayer,detail: Object,detail.aborted: Boolean,detail.graphics: Graphic [],detail.state: "start"\|"active"\|"complete",detail.tool: "move"\|"transform"\|"reshape",detail.toolEventInfo: UpdateToolEventInfo,detail.type: "update"}	Fires when a user starts updating a feature's geometry, is actively updating a feature's geometry, and completes updating a feature's geometry.	Editor

Event Details

sketch-create Event sketch-create Since: ArcGIS Maps SDK for JavaScript 4.29 Editor since 4.11, sketch-create added at 4.29.

Fires when a user starts drawing a feature, is actively drawing a feature, and completes drawing a feature.

Properties

type String

The value is always "sketch-create".

layer FeatureLayer|SceneLayer|SubtypeSublayer

The layer currently being edited.

detail Object

Detailed information returned within the "sketch-create" event.

Specification: graphic Graphic

The feature being created.

state String

The current state of the event.

Value Description

start State changes to start when the first vertex is created. Not applicable when creating points.

active State is active while feature is being created. Not applicable when creating points.

complete State changes to complete after the complete() method is called, when the user double clicks, presses the Enter key or clicks the first vertex of the polygon while creating a feature. When point is created, the a single sketch-create event is fired with the complete state.

cancel State changes to cancel if the user presses the escape key or the create() or cancel() methods are called during the create operation and before the state changes to complete.

Possible Values:"start"|"active"|"complete"|"cancel"

tool String

Name of the create tool.

Possible Values:"point"|"multipoint"|"polyline"|"polygon"|"circle"|"rectangle"|"mesh"

toolEventInfo CreateToolEventInfo

Returns additional information associated with the create operation.

type String

The value is always "create".

Example

// Listen to Editor's create event.
editor.on("sketch-create", function(evt) {
  const { graphic, tool } = evt.detail;

  // Check if the tool used is a 'polyline'
  if (tool === "polyline") {
    // Set the active polyline symbol to white while drawing
    graphic.symbol.color = "#ffffff";
  }
});

sketch-update Event sketch-update Since: ArcGIS Maps SDK for JavaScript 4.29 Editor since 4.11, sketch-update added at 4.29.

Fires when a user starts updating a feature's geometry, is actively updating a feature's geometry, and completes updating a feature's geometry.

Properties

type String

The value is always "sketch-update".

layer FeatureLayer|SceneLayer|SubtypeSublayer

The layer currently being edited.

detail Object

Detailed information returned within the "sketch-update" event.

Specification: aborted Boolean

Indicates if the update operation was aborted. Returns true if the user pressed the esc key, or when the update(), create() or cancel() method is called before the update event's state changes to complete.

graphics Graphic []

An array of features that are being updated.

state String

The state of the event.

Value Description

start State changes to start when a feature is selected to update.

active State is active while features are being updated and toolEventInfo parameter is not null.

complete State changes to complete after features are updated.

Possible Values:"start"|"active"|"complete"

tool String

Name of the update operation tool.

Possible Values:"move"|"transform"|"reshape"

toolEventInfo UpdateToolEventInfo

Update operation tool info. Returns additional information associated with the update operation that is taking place for selected feature and what stage it is at. Value of this parameter changes to null when the update event's state changes to complete.

type String

The value is always "update".

Example

// Listen to Editor's update event.
editor.on("sketch-update", function(evt) {
  const { tool, graphics } = evt.detail;

  // Check if the layer's geometryType is a 'polyline'
  if (evt.layer?.geometryType === "polyline") {
    // For every feature, update the line symbol
    // width to emphasize the feature being updated
    graphics.forEach((graphic) => graphic.symbol.width = 5);
  }
});