OpenLayers 3

Class: Draw

ol.interaction.Draw

Interaction for drawing feature geometries.

new ol.interaction.Draw(options)

src/ol/interaction/drawinteraction.js, line 90
Name Type Description
options

Options.

Name Type Description
clickTolerance number | undefined experimental

The maximum distance in pixels between "down" and "up" for a "up" event to be considered a "click" event and actually add a point/vertex to the geometry being drawn. Default is 6 pixels. That value was chosen for the draw interaction to behave correctly on mouse as well as on touch devices.
features ol.Collection.<ol.Feature> | undefined experimental

Destination collection for the drawn features.
source ol.source.Vector | undefined experimental

Destination source for the drawn features.
snapTolerance number | undefined experimental

Pixel distance for snapping to the drawing finish. Default is 12.
type ol.geom.GeometryType experimental

Drawing type ('Point', 'LineString', 'Polygon', 'MultiPoint', 'MultiLineString', 'MultiPolygon' or 'Circle').
maxPoints number | undefined experimental

The number of points that can be drawn before a polygon ring or line string is finished. The default is no restriction.
minPoints number | undefined experimental

The number of points that must be drawn before a polygon ring or line string can be finished. Default is 3 for polygon rings and 2 for line strings.
style ol.style.Style | Array.<ol.style.Style> | ol.style.StyleFunction | undefined experimental

Style for sketch features.
geometryFunction ol.interaction.DrawGeometryFunctionType | undefined experimental

Function that is called when a geometry's coordinates are updated.
geometryName string | undefined experimental

Geometry name to use for features created by the draw interaction.
condition ol.events.ConditionType | undefined experimental

A function that takes an ol.MapBrowserEvent and returns a boolean to indicate whether that event should be handled. By default ol.events.condition.noModifierKeys, i.e. a click, adds a vertex or deactivates freehand drawing.
freehandCondition ol.events.ConditionType | undefined experimental

Condition that activates freehand drawing for lines and polygons. This function takes an ol.MapBrowserEvent and returns a boolean to indicate whether that event should be handled. The default is ol.events.condition.shiftKeyOnly, meaning that the Shift key activates freehand drawing.
wrapX boolean | undefined experimental

Wrap the world horizontally on the sketch overlay. Default is false.
Fires:

Extends

Observable Properties

Name Type Settable ol.ObjectEvent type Description
active boolean yes change:active

true if the interaction is active, false otherwise.

Methods

ol.interaction.Draw.createRegularPolygon(opt_sides, opt_angle){ol.interaction.DrawGeometryFunctionType} experimental

src/ol/interaction/drawinteraction.js, line 797

Create a geometryFunction for mode: 'Circle' that will create a regular polygon with a user specified number of sides and start angle instead of an ol.geom.Circle geometry.

Name Type Description
sides number

Number of sides of the regular polygon. Default is 32.
angle number

Angle of the first point in radians. 0 means East. Default is the angle defined by the heading from the center of the regular polygon to the current pointer position.
Returns:
Function that draws a polygon.

ol.interaction.Draw.handleEvent(mapBrowserEvent){boolean} experimental

src/ol/interaction/drawinteraction.js, line 341

Handles the map browser event and may actually draw or finish the drawing.

This:
Name Type Description
mapBrowserEvent ol.MapBrowserEvent

Map browser event.
Returns:
false to stop event propagation.

changed() inherited experimental

src/ol/observable.js, line 51

Increases the revision counter and dispatches a 'change' event.

extend(feature) experimental

src/ol/interaction/drawinteraction.js, line 724

Extend an existing geometry by adding additional points. This only works on features with LineString geometries, where the interaction will extend lines by adding points to the end of the coordinates array.

Name Type Description
feature ol.Feature

Feature to be extended.

finishDrawing() experimental

src/ol/interaction/drawinteraction.js, line 655

Stop drawing and add the sketch feature to the target layer. The ol.interaction.DrawEventType.DRAWEND event is dispatched before inserting the feature.

get(key){*} inherited

src/ol/object.js, line 150

Gets a value.

Name Type Description
key string

Key name.
Returns:
Value.

getActive(){boolean} inherited experimental

src/ol/interaction/interaction.js, line 65

Return whether the interaction is currently active.

Returns:
true if the interaction is active, false otherwise.

getKeys(){Array.<string>} inherited

src/ol/object.js, line 164

Get a list of object property names.

Returns:
List of property names.

getProperties(){Object.<string, *>} inherited

src/ol/object.js, line 174

Get an object of all property names and values.

Returns:
Object.

getRevision(){number} inherited experimental

src/ol/observable.js, line 70

Get the version number for this object. Each time the object is modified, its version number will be incremented.

Returns:
Revision.

on(type, listener, opt_this){goog.events.Key} inherited

src/ol/observable.js, line 83

Listen for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.
listener function

The listener function.
this Object

The object to use as this in listener.
Returns:
Unique key for the listener.

once(type, listener, opt_this){goog.events.Key} inherited

src/ol/observable.js, line 96

Listen once for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.
listener function

The listener function.
this Object

The object to use as this in listener.
Returns:
Unique key for the listener.

removeLastPoint() experimental

src/ol/interaction/drawinteraction.js, line 622

Remove last point of the feature currently being drawn.

set(key, value) inherited

src/ol/object.js, line 203

Sets a value.

Name Type Description
key string

Key name.
value *

Value.

setActive(active) inherited experimental

src/ol/interaction/interaction.js, line 86

Activate or deactivate the interaction.

Name Type Description
active boolean

Active.

setProperties(values) inherited

src/ol/object.js, line 216

Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).

Name Type Description
values Object.<string, *>

Values.

un(type, listener, opt_this) inherited

src/ol/observable.js, line 109

Unlisten for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.
listener function

The listener function.
this Object

The object which was used as this by the listener.

unByKey(key) inherited

src/ol/observable.js, line 122

Removes an event listener using the key returned by on() or once(). Note that using the ol.Observable.unByKey static function is to be preferred.

Name Type Description
key goog.events.Key

The key returned by on() or once().

unset(key) inherited

src/ol/object.js, line 229

Unsets a property.

Name Type Description
key string

Key name.