require(["esri/toolbars/draw"], function(Draw) { /* code goes here */ });Description
(Added at v1.0)
Toolbar that supports functionality to create new geometries by drawing them: points (POINT or MULTI_POINT), lines (LINE, POLYLINE, or FREEHAND_POLYLINE), polygons (FREEHAND_POLYGON or POLYGON), or rectangles (EXTENT). To edit geometries of existing graphics, use the
Edit Toolbar.Mouse behavior when drawing features
esri.bundle.toolbars.draw.addPoint = "Add a new tree to the map";To view all the customizable widget strings view any of the samples in a browser with debugging tools open and type
console.dir(esri.bundle)
in the console. Debugging tools are available as an integrated part of most modern browsers.
Samples
Search for
samplesthat use this class.
Constructors ConstantsARROW
Draws an arrow. CIRCLE
Draws a circle. DOWN_ARROW
Draws an arrow that points down. ELLIPSE
Draws an ellipse. EXTENT
Draws an extent box. FREEHAND_POLYGON
Draws a freehand polygon. FREEHAND_POLYLINE
Draws a freehand polyline. LEFT_ARROW
Draws an arrow that points left. LINE
Draws a line. MULTI_POINT
Draws a Multipoint. POINT
Draws a point. POLYGON
Draws a polygon. POLYLINE
Draws a polyline. RECTANGLE
Draws a rectangle. RIGHT_ARROW
Draws an arrow that points right. TRIANGLE
Draws a triangle. UP_ARROW
Draws an arrow that points up. Properties Methods 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.
Constructor Details
Creates a new Draw object. A map is a required parameter.
Parameters: <Map
> map Required Map the toolbar is associated with. <Object
> options Optional Parameters that define the functionality of the draw toolbar. See the options for a list of valid values. options
properties: <Number
> drawTime Optional Determines how much time to wait before adding a new point when using a freehand tool. The default value is 75. <Boolean
> showTooltips Optional If true, tooltips are displayed when creating new graphics with the draw toolbar.
require([ "esri/map", "esri/toolbars/draw", ... ], function(Map, Draw, ... ) { var map = new Map( ... ); var toolbar = new Draw(map, { showTooltips: false }); ... });<
Number
> tolerance Optional Determines how far the mouse moves before adding a new point when using one of the freehand tools. The default value is 8. <Number
> tooltipOffset Optional Determines how far to offset the tool tip from the mouse pointer. The default value is 15. Sample:
require([ "esri/map", "esri/toolbars/draw", ... ], function(Map, Draw, ... ) { var map = new Map( ... ); var toolbar = new Draw(map, { tooltipOffset: 20, drawTime: 90 }); ... });
Property Details
Symbol to be used when drawing a
Polyline.
When set to false, the geometry is modified to be topologically correct. When set to true, the input geometry is not modified.
Known values: true | false
Default value: false
Method Details
Activates the toolbar for drawing geometries. Activating the toolbar disables map navigation.
Parameters: <String
> geometryType Required The type of geometry drawn. See the Constants table for valid values. <Object
> options Optional Options that define the functionality of the draw toolbar. See the object specifications table below for the structure of the options
object. Object Specifications:
<options
>
Number
> drawTime Required Determines how much time to wait before adding a new point when using a freehand tool. The default value is 75. <Boolean
> showTooltips Required If true, tooltips are displayed when creating new graphics with the draw toolbar. The default value is true. <Number
> tolerance Required Determines how far the mouse moves before adding a new point when using one of the freehand tools. The default value is 8. <Number
> tooltipOffset Required Determines how far to offset the tool tip from the mouse pointer. The default value is 15. Sample:
require([ "esri/toolbars/draw", ... ], function(Draw, ... ) { var toolbar = new Draw( ... ); toolbar.activate(Draw.POINT); ... });
Deactivates the toolbar and reactivates map navigation.
Finishes drawing the geometry and fires the onDrawEnd event. Use this method to finish drawing a polyline, polygon or multipoint when working with the compact build on a touch supported device like the iPhone. (Added at v2.0)
Sample:drawToolbar.finishDrawing();
Sets whether the polygon geometry should be modified to be topologically correct.
Parameters: <Boolean
> set Required When set to false, the geometry is modified to be topologically correct. When set to true, the input geometry is not modified.
Event Details
[ On Style Events | Connect Style Event ]
Fired when the user has completed drawing. It returns the geometry of the drawn feature with the feature's geographic coordinates. (Added at v3.6)
Event Object Properties: <Geometry
> geographicGeometry Geometry of the drawn shape in geographic coordinates (latitude, longitude). Only available when the map's spatial reference is Web Mercator or Geographic (4326). <Geometry
> geometry Geometry of the shape that was drawn. Coordinates of this geometry have the same spatial reference of the map. This event is deprecated.
Use
draw-complete
instead. Fires when drawing has ended.
Event Object Properties: <Geometry
> geometry Geometry drawn on the client. Sample:
require([ "esri/toolbars/draw", "esri/graphic", ... ], function(Draw, Graphic, ... ) { function createToolbar(map) { var toolbar = new Draw(map); toolbar.on("draw-end", addToMap); } function addToMap(evt) { var graphic = new Graphic(evt.geometry, symbol); map.graphics.add(graphic); } ... });
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