OpenLayers 3 API Documentation

Class: Draw

ol.interaction. Draw

experimental new ol.interaction.Draw(options)

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

Interaction that allows drawing geometries

Name Type Description
options

Options.

Name Type Description
features ol.Collection | undefined

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

Destination source for the drawn features.
snapTolerance number | undefined

Pixel distance for snapping to the drawing finish (default is 12).
type ol.geom.GeometryType

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

The number of points that must be drawn before a polygon ring can be finished (default is 3).
style ol.style.Style | Array.<ol.style.Style> | ol.feature.StyleFunction | undefined

Style for sketch features.
Fires:

Extends

Methods

experimental inherited dispatchChangeEvent()

src/ol/observable.js, line 39

Dispatches a change event. Register a listener for this event to get notified of changes.

Fires:
  • change

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

src/ol/observable.js, line 61

Listen for a certain type of event.

Name Type Argument Description
type string | Array.<string>

The event type or array of event types.
listener function

The listener function.
this Object <optional>
 optional

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

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

src/ol/observable.js, line 74

Listen once for a certain type of event.

Name Type Argument Description
type string | Array.<string>

The event type or array of event types.
listener function

The listener function.
this Object <optional>
 optional

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

experimental inherited un(type, listener, opt_this)

src/ol/observable.js, line 86

Unlisten for a certain type of event.

Name Type Argument Description
type string | Array.<string>

The event type or array of event types.
listener function

The listener function.
this Object <optional>
 optional

The object to use as this in listener.

experimental inherited unByKey(key)

src/ol/observable.js, line 96

Removes an event listener using the key returned by on() or once().

Name Type Description
key goog.events.Key

Key.