Class: DrawTool

new DrawTool(optionsopt) [source]

In default, DrawTool supports the following modes:
[Point, LineString, Polygon, Circle, Ellipse, Rectangle, ArcCurve, QuadBezierCurve, CubicBezierCurve]
You can easily add new mode to DrawTool by calling registerMode

var drawTool = new DrawTool({
    mode : 'Polygon',
    symbol : {
        'lineColor' : '#000',
        'lineWidth' : 5
    },
    once : true
}).addTo(map);

Parameter Type Default Description

options opt

Object

null

construct options

Properties

Parameter	Type	Default	Description
`mode` opt	String	null	mode of the draw tool
`symbol` opt	Object	null	symbol of the geometries drawn
`once` opt	Boolean	null	whether disable immediately once drawn a geometry.
`autoPanAtEdge` opt	Boolean	false	Whether to make edge judgement or not.

Extends:

MapTool

Members

(constant) options

Properties:

Name Type Default Description

options opt

Object

null

construct options

Properties

Name	Type	Default	Description
`mode` opt	String	null	mode of the draw tool
`symbol` opt	Object	null	symbol of the geometries drawn
`once` opt	Boolean	null	whether disable immediately once drawn a geometry.
`autoPanAtEdge` opt	Boolean	false	Whether to make edge judgement or not.

Source:

map/tool/DrawTool.js, line 19

Static Methods

(static) registerMode(name, modeAction) [source]

//Register "CubicBezierCurve" mode to draw Cubic Bezier Curves.
DrawTool.registerMode('CubicBezierCurve', {
        'action': 'clickDblclick',
        'create': path => new CubicBezierCurve(path),
        'update': (path, geometry) => {
            geometry.setCoordinates(path);
        },
        'generate': geometry => geometry
       }
     });

Parameter Type Description

name String mode name

modeAction

Object

modeActions

Properties

Parameter	Type	Description
`action`	Object	the action of DrawTool: click, mousedown, clickDblclick
`create`	Object	the create method of drawn geometry
`update`	Object	the update method of drawn geometry
`generate`	Object	the method to generate geometry at the end of drawing.

(static) getRegisterMode(name) [source]

Get mode actions by mode name

Parameter	Type	Description
`name`	String	DrawTool mode name

Returns:

Object: mode actions

Methods

getMode() [source]

Get current mode of draw tool

Returns:

String: mode

setMode(mode) [source]

Set mode of the draw tool

Parameter	Type	Description
`mode`	String	mode of the draw tool

getSymbol() [source]

Get symbol of the draw tool

Returns:

Object: symbol

setSymbol(symbol) [source]

Set draw tool's symbol

Parameter	Type	Description
`symbol`	Object	symbol set

Returns:

DrawTool: this

getCurrentGeometry() [source]

Get geometry is currently drawing

Returns:

Geometry: geometry currently drawing

undo() [source]

Undo drawing, only applicable for click/dblclick mode

Returns:

DrawTool: this

redo() [source]

Redo drawing, only applicable for click/dblclick mode

Returns:

DrawTool: this

endDraw(paramopt) [source]

End current draw

Parameter	Type	Default	Description
`param` opt	Object	null	params of drawend event

Returns:

DrawTool: this

(inherited) addTo(map) [source]

Adds the map tool to a map.

Parameter	Type	Description
`map`	Map

Inherited From:

MapTool#addTo

Fires:

Returns:

MapTool: this

(inherited) getMap() [source]

Gets the map it added to.

Inherited From:

MapTool#getMap

Returns:

Map: map

(inherited) enable() [source]

Enable the map tool.

Inherited From:

MapTool#enable

Fires:

enable

Returns:

MapTool: this

(inherited) disable() [source]

Disable the map tool

Inherited From:

MapTool#disable

Fires:

disable

Returns:

MapTool: this

(inherited) isEnabled() [source]

Returns whether the tool is enabled

Inherited From:

MapTool#isEnabled

Returns:

Boolean: true | false

(inherited) on(eventsOn, handler, contextopt) [source]

foo.on('mousedown mousemove mouseup', onMouseEvent, foo);

Parameter	Type	Default	Description
`eventsOn`	String		event types to register, seperated by space if more than one.
`handler`	function		handler function to be called
`context` opt	Object	null	the context of the handler

Mixes From:

Eventable.on

Inherited From:

MapTool#on

Returns:

Any: this

(inherited) addEventListener(eventTypes, handler, contextopt) [source]

Alias for on

Parameter	Type	Default	Description
`eventTypes`	String		event types to register, seperated by space if more than one.
`handler`	function		handler function to be called
`context` opt	Object	null	the context of the handler

Mixes From:

Eventable.addEventListener

Inherited From:

MapTool#addEventListener

Returns:

: this

(inherited) once(eventTypes, handler, contextopt) [source]

Same as on, except the listener will only get fired once and then removed.

foo.once('mousedown mousemove mouseup', onMouseEvent, foo);

Parameter	Type	Default	Description
`eventTypes`	String		event types to register, seperated by space if more than one.
`handler`	function		listener handler
`context` opt	Object	null	the context of the handler

Mixes From:

Eventable.once

Inherited From:

MapTool#once

Returns:

: this

(inherited) off(eventsOff, handler, contextopt) [source]

Unregister the event handler for the specified event types.

foo.off('mousedown mousemove mouseup', onMouseEvent, foo);

Parameter	Type	Default	Description
`eventsOff`	String		event types to unregister, seperated by space if more than one.
`handler`	function		listener handler
`context` opt	Object	null	the context of the handler

Mixes From:

Eventable.off

Inherited From:

MapTool#off

Returns:

: this

(inherited) removeEventListener(eventTypes, handler, contextopt) [source]

Alias for off

Parameter	Type	Default	Description
`eventTypes`	String		event types to unregister, seperated by space if more than one.
`handler`	function		listener handler
`context` opt	Object	null	the context of the handler

Mixes From:

Eventable.removeEventListener

Inherited From:

MapTool#removeEventListener

Returns:

: this

(inherited) listens(eventType, hanlderopt, contextopt) [source]

Returns listener's count registered for the event type.

Parameter	Type	Default	Description
`eventType`	String		an event type
`hanlder` opt	function	null	listener function
`context` opt	Object	null	the context of the handler

Mixes From:

Eventable.listens

Inherited From:

MapTool#listens

Returns:

Number:

(inherited) copyEventListeners(target) [source]

Copy all the event listener to the target object

Parameter	Type	Description
`target`	Object	target object to copy to.

Mixes From:

Eventable.copyEventListeners

Inherited From:

MapTool#copyEventListeners

Returns:

: this

(inherited) fire(eventType, param) [source]

Fire an event, causing all handlers for that event name to run.

Parameter	Type	Description
`eventType`	String	an event type to fire
`param`	Object	parameters for the listener function.

Mixes From:

Eventable.fire

Inherited From:

MapTool#fire

Returns:

: this

(inherited) callInitHooks() [source]

Visit and call all the init hooks defined on Class and its parents.

Inherited From:

Class#callInitHooks

Returns:

Class: this

(inherited) setOptions(options) [source]

Merges options with the default options of the object.

Parameter	Type	Description
`options`	Object	options to set

Inherited From:

Class#setOptions

Returns:

Class: this

(inherited) config(conf) [source]

1. Return object's options if no parameter is provided.
2. update an option and enable/disable the handler if a handler with the same name existed.

// Get marker's options;
var options = marker.config();
// Set map's option "draggable" to false and disable map's draggable handler.
map.config('draggable', false);
// You can update more than one options like this:
map.config({
    'scrollWheelZoom' : false,
    'doubleClickZoom' : false
});

Parameter	Type	Description
`conf`	Object	config to update

Inherited From:

Class#config

Returns:

Class: this

(inherited) onConfig() [source]

Default callback when config is called

Inherited From:

Class#onConfig

Events

drawvertex [source]

drawvertex event.

Properties:

Name	Type	Description
`type`	String	drawvertex
`target`	DrawTool	draw tool
`geometry`	Geometry	geometry drawn
`coordinate`	Coordinate	coordinate of the event
`containerPoint`	Point	container point of the event
`viewPoint`	Point	view point of the event
`domEvent`	Event	dom event

Source:

map/tool/DrawTool.js, line 359

drawstart [source]

drawstart event.

Properties:

Name	Type	Description
`type`	String	drawstart
`target`	DrawTool	draw tool
`coordinate`	Coordinate	coordinate of the event
`containerPoint`	Point	container point of the event
`viewPoint`	Point	view point of the event
`domEvent`	Event	dom event

Source:

map/tool/DrawTool.js, line 400

mousemove [source]

mousemove event.

Properties:

Name	Type	Description
`type`	String	mousemove
`target`	DrawTool	draw tool
`geometry`	Geometry	geometry drawn
`coordinate`	Coordinate	coordinate of the event
`containerPoint`	Point	container point of the event
`viewPoint`	Point	view point of the event
`domEvent`	Event	dom event

Source:

map/tool/DrawTool.js, line 448

drawend [source]

drawend event.

Properties:

Name	Type	Description
`type`	String	drawend
`target`	DrawTool	draw tool
`geometry`	Geometry	geometry drawn
`coordinate`	Coordinate	coordinate of the event
`containerPoint`	Point	container point of the event
`viewPoint`	Point	view point of the event
`domEvent`	Event	dom event