Class: Extent

ol/interaction/Extent~Extent 


import Extent from 'ol/interaction/Extent';

Allows the user to draw a vector box by clicking and dragging on the map. Once drawn, the vector box can be modified by dragging its vertices or edges. This interaction is only supported for mouse devices.

new Extent(opt_options)

interaction/Extent.js, line 95
Name Type Description
options

Options.

Name Type Description
condition module:ol/events/condition~Condition | undefined

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

Initial extent. Defaults to no initial extent.
boxStyle module:ol/style/Style~StyleLike | undefined

Style for the drawn extent box. Defaults to the Polygon editing style documented in module:ol/style/Style~Style
pixelTolerance number (defaults to 10)

Pixel tolerance for considering the pointer close enough to a segment or vertex for editing.
pointerStyle module:ol/style/Style~StyleLike | undefined

Style for the cursor used to draw the extent. Defaults to the Point editing style documented in module:ol/style/Style~Style
wrapX boolean (defaults to false)

Wrap the drawn extent across multiple maps in the X direction? Only affects visuals, not functionality.
Fires:

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 68

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

dispatchEvent(event){boolean|undefined} inherited

events/Target.js, line 85

Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a type property.

Name Type Description
event module:ol/events/Event~BaseEvent | string

Event object.
Returns:
false if anyone called preventDefault on the event object or if any of the listeners returned false.

get(key){*} inherited

Object.js, line 135

Gets a value.

Name Type Description
key string

Key name.
Returns:
Value.

getActive(){boolean} inherited

interaction/Interaction.js, line 82

Return whether the interaction is currently active.

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

getExtent(){module:ol/extent~Extent}

interaction/Extent.js, line 441

Returns the current drawn extent in the view projection (or user projection if set)

Returns:
Drawn extent in the view projection.

getExtentInternal(){module:ol/extent~Extent}

interaction/Extent.js, line 454

Returns the current drawn extent in the view projection

Returns:
Drawn extent in the view projection.

getKeys(){Array.<string>} inherited

Object.js, line 148

Get a list of object property names.

Returns:
List of property names.

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

interaction/Interaction.js, line 91

Get the map associated with this interaction.

Returns:
Map.

getPointerCount(){number} inherited

interaction/Pointer.js, line 95

Returns the current number of pointers involved in the interaction, e.g. 2 when two fingers are used.

Returns:
The number of pointers.

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

Object.js, line 157

Get an object of all property names and values.

Returns:
Object.

getRevision(){number} inherited

Observable.js, line 79

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

Returns:
Revision.

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

Observable.js, line 153

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 165

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 207

Sets a value.

Name Type Description
key string

Key name.
value *

Value.
silent boolean | undefined

Update without triggering an event.

setActive(active) inherited

interaction/Interaction.js, line 111

Activate or deactivate the interaction.

Name Type Description
active boolean

Active.

setExtent(extent)

interaction/Extent.js, line 464

Manually sets the drawn extent, using the view projection.

Name Type Description
extent module:ol/extent~Extent

Extent

setProperties(values, opt_silent) inherited

Object.js, line 227

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 | undefined

Update without triggering an event.

un(type, listener) inherited

Observable.js, line 174

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 251

Unsets a property.

Name Type Description
key string

Key name.
silent boolean | undefined

Unset without triggering an event.