ESM: import Editor from "@arcgis/core/widgets/Editor.js";
CDN: const Editor = await $arcgis.import("@arcgis/core/widgets/Editor.js");
Class: @arcgis/core/widgets/Editor
Since: ArcGIS Maps SDK for JavaScript 4.11
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.
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 workflowsThe widget has different workflows based on the functionality needed. These workflows are dependent upon permissions set on the service or within the client application.
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.
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 constraintsThe 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.
Relationship editingIt 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.
Considerations when editing related data in the Editor
To enable support for editing associated features in Editor, the formTemplate must include one or more association elements. This can be achieved through the Map Viewer's authoring experience or programmatically via the SDK. Editing associated features is exclusively supported within UtilityNetworks.
Once the form is created, the Editor checks if a formTemplate is assigned to the layer or the widget's layerInfo. If the form's template lacks the necessary association elements, the Editor will not display associated features or options to edit them. Also, if an associated feature exists on a layer and that layer is not included in the WebMap being used, the associated feature will not be shown in Editor.
Creating associationsIf the formTemplate includes one or more association elements, Editor will provide the option to create new associations between the selected feature and another feature on the map. Only types specified in the formTemplate association elements can be used for new associations.
To create an association involving the selected feature, navigate to the association type desired for the new association and click "Add" below the list of associated layers. Select the layer containing the feature to form an association with, then select a feature within that layer.
The layers and features shown in the list are those that are compatible with the selected feature and association type based on utility network rules.
After choosing a feature to form the association with, settings specific to the association type can be configured, e.g., midspan location for connectivity associations.
Click "Add" to create the association.
Alternatively, if compatible layers are visible on the map, a feature can be selected on the map using a spatial selection toolbar. Features can be selected at a single point or within a region. Any compatible features at the selected point or within the defined region are displayed in a list. Hover over a feature in the list to highlight it on the map; click a feature in the list to choose the feature to form the association with.
While viewing compatible features on a layer, filters can optionally be used to find a specific feature to form an association with.
Deleting associationsWhen viewing an associated feature, the Editor widget provides a dropdown next to "Delete". Click the dropdown, then choose "Delete association". Confirm your choice to delete the association between the feature you initially selected and the feature you are now viewing.
Considerations when deleting associations in the Editor
If the deletion was successful, the Editor widget will return to the list of associated features for the chosen layer. If no associated features remain on that layer, the widget will return to the list of layers. If the selected feature is no longer involved in any associations, the widget returns to the selected feature.
While viewing associated features on a layer, a search bar can optionally be used to filter by the title of the feature shown in the list.
Editing date and timeThe 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:
unknown, both date and timestamp-offset field types are shown in UTC.unknown, but a layer has a preferredTimeZone, date field types will display values with the preferred time zone that is set within the layer.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.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.
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.
attachmentsOnUpdateEnabled: false in layerInfo.attachmentsOnUpdateEnabled.Example
// At the very minimum, set the Editor's view
const editor = new Editor({
view: view
});
view.ui.add(editor, "top-right"); new Editor(properties)
Parameter
optionalSee 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
});Show inherited properties Hide inherited properties
Property DetailsThe 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"
});Inherited
Property declaredClass Stringreadonly
The name of the class. The declared class name is formatted as esri.folder.className.
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.
Example
// "Editor" will render as an <h3>
editor.headingLevel = 3;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).
Inherited
Property id String
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.
The widget's default label.
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.
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.
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.
}]
});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.
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");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.
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.
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.
A reference to the MapView or SceneView. This view provides the editable layers for the Editor widget.
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.
Inherited
Property visible Boolean
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".
Example
// Hides the widget in the view
widget.visible = false;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
}
};Show inherited methods Hide inherited methods
Method DetailsInherited
Method addHandles(handleOrHandles, groupKey)
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
Handles marked for removal once the object is destroyed.
groupKey *
optionalKey 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(){Promise<void>}
Cancels any active workflow.
Returns
Type Description Promise<void> Resolves once the workflow is canceled.Inherited
Method classes(classNames){String}
A utility method used for building the value for a widget's class property. This aids in simplifying css class setup.
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)} />
);
} deleteAssociationFromWorkflow(){Promise<void>}
Since: ArcGIS Maps SDK for JavaScript 4.32 Editor since 4.11, deleteAssociationFromWorkflow added at 4.32.
This is applicable if there is an active UpdateWorkflow. If so, this method deletes the association involved with the workflow feature.
Returns
Type Description Promise<void> Resolves once the active UpdateWorkflow is deleted. 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. deleteFeatures(){Promise<void>}
Since: ArcGIS Maps SDK for JavaScript 4.33 Editor since 4.11, deleteFeatures added at 4.33.
If the active workflow is an UpdateWorkflow or UpdateFeaturesWorkflow, this method deletes the feature(s) associated with the workflow.
Returns
Type Description Promise<void> Resolves once the features have been deleted.Inherited
Method destroy()
Destroys the widget instance.
Inherited
Method emit(type, event){Boolean}
Emits an event on the instance. This method should only be used when creating subclasses of this class.
Parameters
The name of the event.
optionalThe event payload.
Returns
Type Description Booleantrue if a listener was notified
Inherited
Method hasEventListener(type){Boolean}
Indicates whether there is an event listener on the instance that matches the provided event name.
Returns
Type Description Boolean Returns true if the class supports the input event.Inherited
Method hasHandles(groupKey){Boolean}
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 *
optionalA group key.
Returns
Type Description Boolean Returnstrue 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");
}Inherited
Method isFulfilled(){Boolean}
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).Inherited
Method isRejected(){Boolean}
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.Inherited
Method isResolved(){Boolean}
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.Inherited
Method on(type, listener){Object}
Registers an event handler on the instance. Call this method to hook an event with a listener.
Returns
Type Description Object Returns an event handler with aremove() 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);
});Inherited
Method postInitialize()
Executes after widget is ready for rendering.
Inherited
Method removeHandles(groupKey)
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 *
optionalA 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");Inherited
Method render(){Object}
This method is implemented by subclasses for rendering.
Returns
Type Description Object The rendered virtual node.Inherited
Method renderNow()
Renders widget to the DOM immediately.
Inherited
Method scheduleRender()
Schedules widget rendering. This method is useful for changes affecting the UI.
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 CreateFeaturesCreationInfo object containing the layer(s) and template(s) to use.
Parameter
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. 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
Parameters object containing an initialFeature to use in the associated CreateFeaturesWorkflow.
Specification
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. 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
startUpdateFeaturesWorkflow(features){Promise<void>}
Since: ArcGIS Maps SDK for JavaScript 4.33 Editor since 4.11, startUpdateFeaturesWorkflow added at 4.33.
Starts an UpdateFeaturesWorkflow using the provided features.
Parameter
The features to batch update
Returns
startUpdateWorkflowAtFeatureEdit(feature){Promise<void>}
Starts the UpdateWorkflow at the attribute editing panel.
Parameter
The feature to be updated.
Returns
Type Description Promise<void> Resolves once the UpdateWorkflow initiates the attribute editing panel. 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. startUpdateWorkflowAtMultipleFeatureSelection(candidates){Promise<void>}
This method starts the UpdateWorkflow where it waits for multiple features to be selected.
Parameter
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.Inherited
Method when(callback, errback){Promise}
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
optionalThe function to call when the promise resolves.
optionalThe function to execute when the promise fails.
Returns
Type Description Promise Returns a new Promise for the result ofcallback.
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
}); CreateFeaturesCreationInfo
This object provides required properties needed when creating a new feature.
CreationInfo
This object provides required and optional properties needed when creating a new feature.
LayerInfo
Configurations used for setting the layer's editable preferences within the Editor.
The associated layer containing the fields to edit.
optionalDefault Value:true
Indicates whether to enable editing on the layer.
optionalDefault Value:true
Indicates whether to enable the ability to create new features.
optionalDefault Value:true
Indicates whether to enable the ability to update existing features.
optionalDefault Value:true
Indicates whether to enable the ability to delete features.
optionalDefault Value:true
Indicates whether to enable or disable attribute updates from the feature's form.
optionalDefault 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.
optionalDefault 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.
Default Value:true
Indicates whether to enable or disable geometry updates.
optionalA template that defines the feature's form content. Use this when setting the fields for editing.
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.
An object containing properties specific for customizing the Attachments widget.
An object containing properties specific for customizing the FeatureForm widget.
An object containing properties specific for customizing the FeatureTemplates widget.
An object containing properties specific for customizing the Sketch widget.
The visible elements that are displayed within the widget. This provides the ability to turn individual elements of the widget's display on/off.
Since 4.28. Indicates whether to display the "create features" section of the widget in the default view.
Since 4.28. Indicates whether to display the "edit features" section of the widget in the default view.
Since 4.29. Indicates whether to display the sketch labels toggle. Default value is true.
Since 4.29. Indicates whether to display the tooltips toggle. Default value is true.
Since 4.30. Indicates whether to display the settings menu. This menu contains the snapping and tooltips settings.
Since 4.32. Determines whether the widget should be shown within its built-in flow component or if the flow component should be excluded. The widget will be displayed within its original flow component if set to true. The flow component will be omitted from the widget if set to false. To place the widget into an existing Calcite flow component, set this property to false.
Since 4.32. Determines whether the widget should display an embedded Sketch widget to provide graphical controls for choosing drawing tools.
Since 4.32. Determines undo/redo buttons should be shown in the embedded Sketch toolbar.
Indicates whether to display the SnappingControls widget. Default is true.
The available SnappingControls elements within the widget.
Indicates whether to display the header. Default is false.
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.
Indicates whether to display the selfEnabledToggle (Geometry guides). Default is true. This toggles the SnappingOptions.selfEnabled property.
Indicates whether to display the featureEnabledToggle (Feature to feature). Default is true. This toggles the SnappingOptions.featureEnabled property.
Indicates whether to display the FeatureSnappingLayerSource layerList. Default is true. The layerlist provides the available layer sources supported for snapping.
Indicates whether to display the âEnable allâ or âDisable allâ button to enable / disable snapping for all the layers in the list.
Since 4.30. Indicates whether to display the grid display toggle embedded in grid controls. Default is false.
Since 4.30. Indicates whether to display the grid controls widget embedded in snapping controls. Default is true.
Since 4.30. The available GridControls elements within the widget.
Indicates whether to display the grid snapping toggle embedded in grid controls. Default is false.
Indicates whether to display the grid display toggle embedded in grid controls. Default is false.
Indicates whether to display the color/theme selection component of grid controls. Default is true.
Indicates whether to display the dynamic scaling toggle in grid controls. Default is true.
Indicates whether to display the 'rotate with map' toggle in grid controls. Default is true.
Indicates whether to display the spacing and rotation inputs in grid controls. Default is true.
Indicates whether to display the major line interval input in grid controls. Default is true.
Indicates whether to display the interactive placement buttons in grid controls. Default is true.
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
}
}Fires when a user starts drawing a feature, is actively drawing a feature, and completes drawing a feature.
Editor sketch-update {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
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.
The value is always "sketch-create".
layer FeatureLayer|SceneLayer|SubtypeSublayerThe layer currently being edited.
detail ObjectDetailed information returned within the "sketch-create" event.
The feature being created.
state StringThe current state of the event.
Value Description start State changes tostart 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 StringName of the create tool.
Possible Values:"point"|"multipoint"|"polyline"|"polygon"|"circle"|"rectangle"|"mesh"
toolEventInfo CreateToolEventInfoReturns additional information associated with the create operation.
type StringThe 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
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.
The value is always "sketch-update".
layer FeatureLayer|SceneLayer|SubtypeSublayerThe layer currently being edited.
detail ObjectDetailed information returned within the "sketch-update" event.
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.
An array of features that are being updated.
state StringThe state of the event.
Value Description start State changes tostart 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 StringName of the update operation tool.
Possible Values:"move"|"transform"|"reshape"
toolEventInfo UpdateToolEventInfoUpdate 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.
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);
}
});RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4