OpenLayers 3 API Documentation

Class: DragBox

ol.interaction.DragBox

Allows the user to draw a vector box by clicking and dragging on the map, normally combined with an ol.events.condition that limits it to when the shift or other key is held down. This is used, for example, for zooming to a specific area of the map (see ol.interaction.DragZoom and ol.interaction.DragRotateAndZoom).

This interaction is only supported for mouse devices.

new ol.interaction.DragBox(opt_options)

src/ol/interaction/dragboxinteraction.js, line 87
Name Type Description
options

Options.

Name Type Description
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. Default is ol.events.condition.always.
style ol.style.Style experimental

Style for the box.
Fires:

Subclasses

Extends

Methods

dispatchChangeEvent() inherited experimental

src/ol/observable.js, line 42

Dispatches a change event.

Fires:
  • change experimental

getGeometry(){ol.geom.Geometry}

src/ol/interaction/dragboxinteraction.js, line 139

Returns geometry of last drawn box.

Returns:
Geometry.

getRevision(){number} inherited experimental

src/ol/observable.js, line 52
Returns:
Revision.

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

src/ol/observable.js, line 65

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 78

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.

un(type, listener, opt_this) inherited

src/ol/observable.js, line 91

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 101

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

Name Type Description
key goog.events.Key

Key.