Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: Editor
[ AMD Module Require | Legacy Module Require ]
require(["esri/dijit/editing/Editor"], function(Editor) { /* code goes here */ });
Description
(Added at v2.0)
The Editor widget provides out-of-the-box editing capabilities using an editable layer in a Feature Service. It combines the out-of-the-box TemplatePicker, AttachmentEditor, AttributeInspector and GeometryService to provide feature and attribute editing. When building editing applications, try to take advantage of the customizable out-of-the-box Editor widget when possible.
Editing behaviors:
- To create features, click a feature template in the template picker then start drawing the feature.
- To move features, click and drag the feature to a new location.
- To delete features, click the feature then press the 'Delete' button on the attribute inspector.
- To edit features, click the feature to display the vertices and the attribute inspector.
- Editing Vertices:
- Add new vertices by clicking a ghost vertex.
- Right-click to delete a vertex.
- Click and drag to move a vertex to a new location.
- Attribute edits are saved automatically when you change selection, change the focus field, or press enter.
- Geometry edits are saved automatically.
Samples
Search for samples that use this class.Constructors
| Name | Summary |
|---|---|
| new Editor(params, srcNodeRef) | Creates a new Editor object. |
Constants
| Name | Description |
|---|---|
CREATE_TOOL_ARROW | Arrow tool |
CREATE_TOOL_AUTOCOMPLETE | Autocomplete polygon tool |
CREATE_TOOL_CIRCLE | Circle tool |
CREATE_TOOL_ELLIPSE | Ellipse tool |
CREATE_TOOL_FREEHAND_POLYGON | Freehand polygon tool |
CREATE_TOOL_FREEHAND_POLYLINE | Freehand polyline tool |
CREATE_TOOL_POLYGON | Polygon tool |
CREATE_TOOL_POLYLINE | Polyline tool |
CREATE_TOOL_RECTANGLE | Rectangle tool |
CREATE_TOOL_TRIANGLE | Triangle tool |
CSS
esri/dijit/editing/Editor | Download source
Properties
| Name | Type | Summary |
|---|---|---|
| editToolbar | Edit | The default Edit toolbar instance. |
Methods
| Name | Return type | Summary |
|---|---|---|
| startup() | None | Finalizes the creation of the widget. |
Events
[ On Style Events | Connect Style Event ]
All On Style event listeners receive a single event object. Additionally, the event object also contains a 'target' property whose value is the object which fired the event.
Events
| Name | Event Object | Summary |
|---|---|---|
| load | Fires when the widget has fully loaded. |
Constructor Details
Creates a new Editor object.
Parameters:
< |
Required | Parameters that define the functionality of the editor widget. Create a new settings object to pass to the widget (see options). |
< |
Required | HTML element where the widget should be rendered. |
params properties: < |
Optional | Create a new settings object that defines the capabilities of the widget. See the object specifications table below for details. |
Object Specifications:
<
createOptions>< |
Optional | See the constants list for valid options. |
< |
Optional | See the constants list for valid options. |
<
fieldInfo><dijit> customField |
Optional | Specify a custom dijit as the editor for this field. |
< |
Required | The name of the field to customize. |
< |
Optional | Specify this for editing time in a Date field. Specify it as an object with a single boolean property, 'time'. Note: In order to use this, the field must be formatted as either shortDateShortTime, shortDateLEShortTime, shortDateShortTime2, shortDateLEShortTime24, shortDateLongTime, shortDateLELongTime, shortDateLongTime24, or shortDateLELongTime24.
'fieldInfos':[
{'fieldName':'name','label':'Name'},
{'fieldName':'email','label':'Email'},
{'fieldName':'notedate','label':'Date','format':{'time':true}}
]
|
< |
Optional | Disable editing of the field. Setting this to true does not override a false value from the server. It will not allow editing directly within a PopupTemplate. |
< |
Optional | Define a label for the field. Setting this overrides the alias and field name from the service. |
< |
Optional | Use this option to override the default setting for the plug-in when using the rich text editor. See dijit/Editor for details. |
< |
Optional | Set the type of field to use when editing string values. See the constants table for a list of valid values. |
< |
Optional | Define a tooltip for the field. |
<
layerInfo>< |
Optional | If true, attributeInspector won't pop up when features in this featureLayer are selected. When adding a new feature, attributeInspector won't pop up either. |
< |
Optional | When true, the geometry is not editable. The default value is false. Requires ArcGIS Server feature service version 10.1 or greater (As of 2.6). |
< |
Required | Reference to the feature layer. |
< |
Optional | Customize how fields appear in the attribute inspector. If nothing is specified all fields, except the ObjectId and GlobalId are displayed. Specify FieldInfos to explicitly define the fields that are displayed and the field order. Added at version 2.2. See the fieldInfo object specifications table for details of each object. |
< |
Optional | Default is false. When true display the GlobalID field in the attribute inspector. |
< |
Optional | Default is false. When true display the ObjectID field in the attribute inspector. |
< |
Optional | Provide a userId for the currently logged-in user. If the application is using the IdentityManager it is not necessary to specify a userId since the feature layer has access to the credential object which contains this information. Requires ArcGIS Server feature service version 10.1 or greater (As of 2.6). |
<
settings>< |
Required | Specify the polygon and polyline draw tools to include on the toolbar. Only applicable when toolbarVisible is true. See the createOptions object specifications table for details. |
< |
Optional | When true, enable undo/redo behavior. |
< |
Required | Reference to the geometry service. Alternatively, you can set the geometry service using esri.config.defaults.geometryService (Required). |
< |
Optional | Specify which fields to display as a rich text editor. |
< |
Required | Array of feature layer information objects. See the layerInfo object specifications table for details of each object. |
< |
Required | Reference to the map (Required). |
< |
Optional | When undo/redo is enabled, specify the maximum number of undo/redo operations to maintain. Default value is 10. |
< |
Optional | Reference to the TemplatePicker. Use this option if you want to modify the appearance of the template picker, for example set the number of rows and columns. |
< |
Optional | Specify the tools to include on the toolbar. Only applicable when toolbarVisible is true. See the toolbarOptions object specifications table for details. |
< |
Optional | If true display the editing toolbar. |
< |
Optional | Specify an instance of the UndoManager for the Editor. |
<
toolbarOptions>< |
Optional | If true show the cut tool. |
< |
Optional | If true show the merge tool. Note that only polygons can be merged. |
< |
Optional | If true show the reshape tool. |
Sample:
Create a settings object that defines the capabilities of the widget.
var settings = {
map: map,
geometryService: new esri.tasks.GeometryService("http://servery/arcgis/rest/services/Geometry/GeometryServer"),
createOptions: { polygonDrawTools:[esri.dijit.editing.Editor.CREATE_TOOL_FREEHAND_POLYGON] },
layerInfos:layerInfos
};
Pass the settings to the widget
var params = {settings: settings};
var myFeatureServiceWidget = new esri.dijit.editing.Editor(params,'divFeatureServiceDijit');
myFeatureServiceWidget.startup();
Property Details
<Edit
EditThe default Edit toolbar instance. (Added at v3.14)
Sample:
require([
"esri/dijit/editing/Editor",
"esri/map",
"...",
"dojo/domReady!"
], function (Editor, Map, ...){
var params = {
settings: {
map: map,
layerInfos: featureLayerInfos
}
};
var editorWidget = new Editor(params, 'editorDiv');
editorWidget.startup();
editorWidget.editToolbar.on('graphic-first-move', function( e ) {
console.log('Move has begun');
});
});
Method Details
Event Details
[ On Style Events | Connect Style Event ]