This widget provides an out-of-the-box editing experience to help streamline the editing experience within a web application. It automatically recognizes if there are editable feature layers within the map. If it recognizes that they are editable, the layers can be used by the widget. In addition, it is also possible to configure how the Editor
behaves by setting its
layerInfos property.
This property takes an array of configuration objects which allow you to configure the editing experience for these layers.
The widget has different workflows based on the functionality needed and are discussed below.
- CreateWorkflow (deprecated as of 4.23) - This workflow is primarily designed for existing custom workflows that target single feature creation. This workflow will eventually be removed in favor of,
- CreateFeaturesWorkflow (new at 4.23) - This workflow allows both individual and continuous feature creation at once.
- UpdateWorkflow - This workflow allows you to update and/or delete existing features within an editable feature layer.
Beginning with version 4.23, the Editor widget has undergone some significant updates including both its UI and the underlying API. These updates are just a few of the improvements on the Editor roadmap. Expect to see more updates as future versions are released. Some of these updates include:
- The initial Editor dialog has been removed and updated to include one initial panel that consolidates the creates and update workflows.
- An additional create features workflow was added to include continuous editing. It is now 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 specified field elements. These fields can be updated as the user creates new features. The existing create workflow will still work but has been marked as
deprecated
in favor of using create features workflow. This new workflow is designed for both individual and multiple feature creation. - Snapping is automatically included in the widget's UI. By default, snapping is disabled. Toggle "Enable snapping" to enable it. By default, both geometry constraints and feature to feature snapping is enabled. Geometry constraints allow the editor to specify how they want their geometries to be drawn. For example, if lines are needed to be at exact right angles, the snapping indicators display as such and vertices can be created appropriately. Feature to feature snapping allows the new or existing geometries to be snapped to geometries in other layers, as shown within the
Snapping layer
list, or with geometries within the layer that is currently being edited. By default, all layers that can be configured for snapping are automatically added to this list. If needing to update this, update the Editor's snappingOptions by setting the FeatureSnappingLayerSource directly.
Known Limitations
The Editor widget is not yet at full parity with the functionality provided in the 3.x Editor widget. For example, there is currently no support editing related feature attributes. Also, it is not recommended to set a very low refreshInterval on an editable layer as this can potentially degrade performance within the application.
- See also
// At the very minimum, set the Editor's view
const editor = new Editor({
view: view
});
view.ui.add(editor, "top-right");
Constructors
-
new Editor(properties)
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Example// Typical usage for Editor widget. Be 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 the layers that should be added to the Editor. const editor = new Editor({ view: view });
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
CreateWorkflow|CreateFeaturesWorkflow|UpdateWorkflow | A property indicating the current active workflow. more details | Editor | |
String | An array of string values which specifies what end users are allowed to edit. more details | Editor | |
String|HTMLElement | The ID or node representing the DOM element containing the widget. more details | Widget | |
String | The name of the class. more details | Accessor | |
Number | Indicates the heading level to use for title of the widget. more details | Editor | |
String | The widget's default CSS icon class. more details | Editor | |
String | The unique ID assigned to the widget when the widget is created. more details | Widget | |
String | The widget's default label. more details | Editor | |
SketchLabelOptions | Options to configure the labels shown next to each segment of the geometry being created or updated. more details | Editor | |
LayerInfo[] | An array of editing configurations for individual layers. more details | Editor | |
SnappingOptions | The SnappingOptions for editing. more details | Editor | |
SupportingWidgetDefaults | This property allows customization of supporting Editor widgets and their default behavior. more details | Editor | |
SketchTooltipOptions | Options to configure the tooltip shown next to the cursor when creating or updating graphics. more details | Editor | |
Boolean | Indicates whether the Editor should default to use the deprecated CreateWorkflow. more details | Editor | |
MapView|SceneView | A reference to the MapView or SceneView. more details | Editor | |
EditorViewModel | The view model for this widget. more details | Editor | |
Boolean | Indicates whether the widget is visible. more details | Widget | |
VisibleElements | The visible elements that are displayed within the widget. more details | Editor |
Property Details
-
-
A property indicating the current active workflow. This is either CreateFeaturesWorkflow or UpdateWorkflow.
-
allowedWorkflows String
-
An array of string values which specifies what end users are allowed to edit. For example, a feature layer with full editing privileges may be available. But you may only want the end user to have the ability to update existing features. Set the
allowedWorkflows
to onlyupdate
.Possible Value Description create This allows the end user to create a new individual feature in the feature service. (deprecated as of 4.23, use create-features
as noted below.)create-features This allows the end user to create either individual or continuous features in the feature service. (Since 4.23) update This allows the end user to update and/or delete features in the feature service. These workflows are only enabled if the feature service allows these operations.
Possible Values:"create-features"|"create"|"update"
- See also
Exampleconst editor = new Editor({ view: view, allowedWorkflows: ["update"] // allows only updates and no adds });
-
-
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 cases 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" });
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
headingLevel NumberSince: ArcGIS Maps SDK for JavaScript 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
Example// "Editor" will render as an <h3> editor.headingLevel = 3;
-
iconClass Stringreadonly
-
The widget's default CSS icon class.
-
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 String
-
The widget's default label.
-
labelOptions SketchLabelOptionsautocastSince: ArcGIS Maps SDK for JavaScript 4.24
-
Options to configure the 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 tofalse
.Exampleconst 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 SnappingOptionsautocastSince: ArcGIS Maps SDK for JavaScript 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");
-
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.
-
tooltipOptions SketchTooltipOptionsautocastSince: ArcGIS Maps SDK for JavaScript 4.24
-
Options to configure the tooltip shown next to the cursor when creating or updating graphics.
-
useDeprecatedCreateWorkflow BooleanSince: ArcGIS Maps SDK for JavaScript 4.23Deprecated since version 4.23. Although new at 4.23, this property was introduced to help migrate from the legacy CreateWorkflow to the updated CreateFeaturesWorkflow. Once CreateWorkflow is fully removed, this property will no longer be necessary.
-
Indicates whether the Editor should default to use the deprecated CreateWorkflow. By default, the Editor allows creating multiple features in one workflow using CreateFeaturesWorkflow. Set this to
true
if needing to revert to the deprecated single feature creation workflow.- Default Value:false
- See also
-
A reference to the MapView or SceneView. This view provides the editable layers for the Editor widget.
-
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.
-
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 VisibleElementsSince: ArcGIS Maps SDK for JavaScript 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.
Exampleeditor.visibleElements = { sketchTooltipControls: false, snappingControls: true, snappingControlsElements: { featureEnabledToggle: false, // removes "Feature to feature" toggle layerList: false // removes Snapping layers list } };
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. more details | Accessor | ||
Promise<void> | Cancels any active workflow. more details | Editor | |
String | A utility method used for building the value for a widget's | Widget | |
Promise<void> | This is applicable if there is an active UpdateWorkflow. more details | Editor | |
Destroys the widget instance. more details | Widget | ||
Boolean | Emits an event on the instance. more details | Widget | |
Boolean | Indicates whether there is an event listener on the instance that matches the provided event name. more details | Widget | |
Boolean | Returns true if a named group of handles exist. more details | Accessor | |
Boolean |
| Widget | |
Boolean |
| Widget | |
Boolean |
| Widget | |
Object | Registers an event handler on the instance. more details | Widget | |
Adds one or more handles which are to be tied to the lifecycle of the widget. more details | Widget | ||
This method is primarily used by developers when implementing custom widgets. more details | Widget | ||
Removes a group of handles owned by the object. more details | Accessor | ||
Object | This method is primarily used by developers when implementing custom widgets. more details | Widget | |
Renders widget to the DOM immediately. more details | Widget | ||
This method is primarily used by developers when implementing custom widgets. more details | Widget | ||
Promise<void> | Initiates the CreateFeaturesWorkflow by displaying the panel where feature(s) creation begins. more details | Editor | |
Promise<void> | Initiates the CreateFeaturesWorkflow by displaying the FeatureTemplates panel. more details | Editor | |
Promise<void> | Initiates the CreateFeaturesWorkflow by displaying the panel where feature creation begins. more details | Editor | |
Promise<void> | This method starts the CreateWorkflow where it waits for the feature to be selected. more details | Editor | |
Promise<void> | Initiates the CreateWorkflow by displaying the FeatureTemplates panel. more details | Editor | |
Promise<void> | Starts the UpdateWorkflow at the attribute editing panel. more details | Editor | |
Promise<void> | Starts the UpdateWorkflow using the current selected feature. more details | Editor | |
Promise<void> | This method starts the UpdateWorkflow where it waits for multiple features to be selected. more details | Editor | |
Promise |
| Widget |
Method Details
-
addHandles(handleOrHandles, groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 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();
ParametershandleOrHandles WatchHandle|WatchHandle[]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.
ReturnsType Description Promise<void> Resolves once the workflow is canceled.
-
A utility method used for building the value for a widget's
class
property. This aids in simplifying CSS class setup.Parameterrepeatable The class names.
ReturnsType Description String The computed class name. Example// .tsx syntax showing how to set CSS classes while rendering the widget render() { const dynamicIconClasses = { [CSS.myIcon]: this.showIcon, [CSS.greyIcon]: !this.showIcon }; return ( <div class={classes(CSS.root, CSS.mixin, dynamicIconClasses)} /> ); }
-
deleteFeatureFromWorkflow(){Promise<void>}
-
This is applicable if there is an active UpdateWorkflow. If so, this method deletes the workflow feature.
ReturnsType Description Promise<void> Resolves once the active UpdateWorkflow is deleted. - See also
-
destroy()inherited
-
Destroys the widget instance.
-
Emits an event on the instance. This method should only be used when creating subclasses of this class.
Parameterstype StringThe name of the event.
event ObjectoptionalThe event payload.
ReturnsType Description Boolean true
if a listener was notified
-
Indicates whether there is an event listener on the instance that matches the provided event name.
Parametertype StringThe name of the event.
ReturnsType Description Boolean Returns true if the class supports the input event.
-
Since: ArcGIS Maps SDK for JavaScript 4.25
-
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType 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"); }
-
Since: ArcGIS Maps SDK for JavaScript 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.ReturnsType Description Boolean Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).
-
Since: ArcGIS Maps SDK for JavaScript 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.ReturnsType Description Boolean Indicates whether creating an instance of the class has been rejected.
-
Since: ArcGIS Maps SDK for JavaScript 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.ReturnsType Description Boolean Indicates whether creating an instance of the class has been resolved.
-
Registers an event handler on the instance. Call this method to hook an event with a listener.
ParametersAn event or an array of events to listen for.
listener FunctionThe function to call when the event fires.
ReturnsType 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. Exampleview.on("click", function(event){ // event is the event handle returned after the event fires. console.log(event.mapPoint); });
-
own(handleOrHandles)inheritedSince: ArcGIS Maps SDK for JavaScript 4.24
-
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.
ParameterhandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the widget is destroyed.
-
postInitialize()inherited
-
This method is primarily used by developers when implementing custom widgets. Executes after widget is ready for rendering.
-
removeHandles(groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 4.25
-
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
This method is primarily used by developers when implementing custom widgets. It must be implemented by subclasses for rendering.
ReturnsType Description Object The rendered virtual node.
-
renderNow()inherited
-
Renders widget to the DOM immediately.
-
scheduleRender()inherited
-
This method is primarily used by developers when implementing custom widgets. Schedules widget rendering. This method is useful for changes affecting the UI.
-
startCreateFeaturesWorkflowAtFeatureCreation(creationInfo){Promise<void>}Since: ArcGIS Maps SDK for JavaScript 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.
ParametercreationInfo CreationInfoAn 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.
ReturnsType Description Promise<void> Resolves when the CreateFeaturesWorkflow initiates and displays the panel where feature(s) creation begins. - See also
-
startCreateFeaturesWorkflowAtFeatureTypeSelection(){Promise<void>}Since: ArcGIS Maps SDK for JavaScript 4.23
-
Initiates the CreateFeaturesWorkflow by displaying the FeatureTemplates panel.
ReturnsType Description Promise<void> Resolves when the CreateFeaturesWorkflow is initiated and displays the FeatureTemplates panel.
-
startCreateWorkflowAtFeatureCreation(creationInfo){Promise<void>}Deprecated since version 4.23. Instead use startCreateFeaturesWorkflowAtFeatureCreation
-
Initiates the CreateFeaturesWorkflow by displaying the panel where feature creation begins. This method takes a CreationInfo object containing the layer(s) and template(s) to use.
ParametercreationInfo CreationInfoAn 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.
ReturnsType Description Promise<void> Resolves when the CreateFeaturesWorkflow initiates and displays the panel where feature creation begins. - See also
-
startCreateWorkflowAtFeatureEdit(feature){Promise<void>}Deprecated since 4.23
-
This method starts the CreateWorkflow where it waits for the feature to be selected.
Parameterfeature GraphicThe feature to be edited.
ReturnsType Description Promise<void> Resolves once the CreateWorkflow initiates, displays the panel where feature creation begins, and waits for the feature to be selected. - See also
-
startCreateWorkflowAtFeatureTypeSelection(){Promise<void>}Deprecated since version 4.23. Instead use startCreateFeaturesWorkflowAtFeatureTypeSelection instead.
-
Initiates the CreateWorkflow by displaying the FeatureTemplates panel.
ReturnsType Description Promise<void> Resolves when the CreateWorkflow is initiated and displays the FeatureTemplates panel. - See also
-
startUpdateWorkflowAtFeatureEdit(feature){Promise<void>}
-
Starts the UpdateWorkflow at the attribute editing panel.
Parameterfeature GraphicThe feature to be updated.
ReturnsType Description Promise<void> Resolves once the UpdateWorkflow initiates the attribute editing panel.
-
startUpdateWorkflowAtFeatureSelection(){Promise<void>}
-
Starts the UpdateWorkflow using the current selected feature.
ReturnsType Description Promise<void> Resolves once the UpdateWorkflow is initiated using the current selected feature. - See also
-
startUpdateWorkflowAtMultipleFeatureSelection(candidates){Promise<void>}
-
This method starts the UpdateWorkflow where it waits for multiple features to be selected.
ParameterAn array of features to be updated. This is only relevant when there are multiple candidates to update.
ReturnsType Description Promise<void> Resolves once the UpdateWorkflow is initiated as it waits for multiple features to be selected. - See also
-
Since: ArcGIS Maps SDK for JavaScript 4.19
-
when()
may be leveraged once an instance of the class is created. This method takes two input parameters: acallback
function and anerrback
function. Thecallback
executes when the instance of the class loads. Theerrback
executes if the instance of the class fails to load.Parameterscallback FunctionoptionalThe function to call when the promise resolves.
errback FunctionoptionalThe function to execute when the promise fails.
ReturnsType 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
-
This object provides the feature template and layer for creating a new feature or features.
- Properties
-
layer FeatureLayer
The associated feature layer for newly-created feature(s).
template FeatureTemplateThe associated feature template used to create new feature(s).
-
LayerInfo
-
Configurations used for setting the layer's editable preferences within the Editor.
- Properties
-
layer FeatureLayer
The associated feature layer containing the editable fields.
enabled BooleanDefault Value:trueIndicates whether to enable editing on the layer.
addEnabled BooleanDefault Value:trueIndicates whether to enable the ability to create new features.
updateEnabled BooleanDefault Value:trueIndicates whether to enable the ability to update existing features.
deleteEnabled BooleanDefault Value:trueIndicates whether to enable the ability to delete features.
attributeUpdatesEnabled BooleanDefault Value:trueIndicates whether to enable or disable attribute updates from the feature's form.
allowAttachments BooleanDeprecated since version 4.26. UseoptionalattachmentsOnUpdateEnabled
orattachmentsOnCreateEnabled
instead.Default Value:trueIndicates whether to display the attachments widget in the Editor's UI. By default, this is
true
, if the service supportsAttachment.attachmentsOnCreateEnabled BooleanDefault Value:true(Since 4.26) Indicates whether to enable or disable attachments while creating features. Support for this is dependent upon the Editor's allowedWorkflows and whether this operation is supported on the FeatureLayer.capabilities.operations.
attachmentsOnUpdateEnabled BooleanDefault Value:true(Since 4.26) Indicates whether to enable or disable attachments while updating existing features. Support for this is dependent upon the Editor's allowedWorkflows and whether
update
ordelete
operations are supported on the FeatureLayer.capabilities.Starting at version 4.25 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
istrue
. Attachment types, other than images, will display an icon and its corresponding file name.geometryUpdatesEnabled BooleanDefault Value:trueIndicates whether to enable or disable geometry updates.
formTemplate FormTemplateA 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. These widgets include FeatureForm, FeatureTemplates, and SketchViewModel.
- Properties
-
featureForm Object
An object containing properties specific for customizing the FeatureForm widget.
- Specification
-
groupDisplay String
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 ObjectAn object containing properties specific for customizing the FeatureTemplates widget.
- Specification
-
groupBy String|GroupByFunction
Aids in managing various template items and how they display within the widget. Please refer to groupBy API reference for additional information.
visibleElements.filter BooleanIndicates whether the templates filter displays.
sketch ObjectAn object containing properties specific for customizing the Sketch widget.
- Specification
-
defaultUpdateOptions Object
An object containing the
defaultUpdateOptions
for the Sketch widget.markerSymbol SimpleMarkerSymbolThe marker symbol used to symbolize any point feature updates.
polygonSymbol SimpleFillSymbolThe polygon symbol used to symbolize any polygon feature updates.
polylineSymbol SimpleLineSymbolThe line symbol used to symbolize any line feature updates.
-
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
-
sketchTooltipControls Boolean
(Since 4.26) Indicates whether to display tooltips while sketching. Default value is
true
.snappingControls BooleanIndicates whether snapping controls will be displayed. Default value is
true
.snappingControlsElements ObjectThe elements contained within the snapping controls.
- Specification
-
header Boolean
Indicates whether to display the snapping controls' header. Default value is
false
.enabledToggle BooleanIndicates whether to display the snapping controls' toggle to entirely enable/disable snapping. Default value is
true
.selfEnabledToggle BooleanIndicates whether to display the snapping controls' toggle to enable/disable
Geometry guides
. Default value istrue
.featureEnabledToggle BooleanIndicates whether to display the snapping controls' toggle to enable/disable
Feature to feature
snapping. Default istrue
.layerList BooleanIndicates whether to display snapping controls'
Snapping layers
. Default value istrue
.