Class: DragBox

ol/interaction/DragBox~DragBox 


import DragBox from 'ol/interaction/DragBox';

Allows the user to draw a vector box by clicking and dragging on the map, normally combined with an module: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 module:ol/interaction/DragZoom~DragZoom and module:ol/interaction/DragRotateAndZoom).

This interaction is only supported for mouse devices.

new DragBox(opt_options)

interaction/DragBox.js, line 112
Name Type Description
options

Options.

Name Type Default Description
className string 'ol-dragbox'

CSS class name for styling the box.
condition module:ol/events/condition~Condition

A function that takes an module:ol/MapBrowserEvent~MapBrowserEvent and returns a boolean to indicate whether that event should be handled. Default is ol/events/condition~always.
minArea number 64

The minimum area of the box in pixel, this value is used by the default boxEndCondition function.
boxEndCondition module:ol/interaction/DragBox~EndCondition

A function that takes a module:ol/MapBrowserEvent~MapBrowserEvent and two module:ol/pixel~Pixels to indicate whether a boxend event should be fired. Default is true if the area of the box is bigger than the minArea option.
onBoxEnd function

Code to execute just before boxend is fired.
Fires:

Subclasses

Extends

Observable Properties

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

true if the interaction is active, false otherwise.

Methods

changed() inherited

Observable.js, line 36

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

get(key){*} inherited

Object.js, line 119

Gets a value.

Name Type Description
key string

Key name.
Returns:
Value.

getActive(){boolean} inherited

interaction/Interaction.js, line 60

Return whether the interaction is currently active.

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

getGeometry(){module:ol/geom/Polygon~Polygon}

interaction/DragBox.js, line 181

Returns geometry of last drawn box.

Returns:
Geometry.

getKeys(){Array.<string>} inherited

Object.js, line 132

Get a list of object property names.

Returns:
List of property names.

getMap(){module:ol/PluggableMap~PluggableMap} inherited

interaction/Interaction.js, line 69

Get the map associated with this interaction.

Returns:
Map.

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

Object.js, line 141

Get an object of all property names and values.

Returns:
Object.

getRevision(){number} inherited

Observable.js, line 47

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

Returns:
Revision.

handleEvent(mapBrowserEvent){boolean} inherited

interaction/Interaction.js, line 79

Handles the map browser event.

Name Type Description
mapBrowserEvent module:ol/MapBrowserEvent~MapBrowserEvent

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

on(type, listener){module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} inherited

Observable.js, line 60

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.
Returns:
Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

once(type, listener){module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} inherited

Observable.js, line 82

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.
Returns:
Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

set(key, value, opt_silent) inherited

Object.js, line 164

Sets a value.

Name Type Description
key string

Key name.
value *

Value.
silent boolean

Update without triggering an event.

setActive(active) inherited

interaction/Interaction.js, line 89

Activate or deactivate the interaction.

Name Type Description
active boolean

Active.

setProperties(values, opt_silent) inherited

Object.js, line 183

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.
silent boolean

Update without triggering an event.

un(type, listener) inherited

Observable.js, line 101

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.

unset(key, opt_silent) inherited

Object.js, line 195

Unsets a property.

Name Type Description
key string

Key name.
silent boolean

Unset without triggering an event.