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)

Name Type Description
options

Options.

Name Type Description
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 module:ol/events/condition.always.

extent module:ol/extent~Extent

Initial extent. Defaults to no initial extent.

boxStyle module:ol/style/Style~StyleLike

Style for the drawn extent box. Defaults to module:ol/style/Style~createEditing()['Polygon']

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

Style for the cursor used to draw the extent. Defaults to module:ol/style/Style~createEditing()['Point']

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

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

dispatchEvent(event){boolean|undefined} inherited

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.

Gets a value.

Name Type Description
key string

Key name.

Returns:
Value.

Return whether the interaction is currently active.

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

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

Returns:
Drawn extent in the view projection.

Returns the current drawn extent in the view projection

Returns:
Drawn extent in the view projection.

getKeys(){Array.<string>} inherited

Get a list of object property names.

Returns:
List of property names.

Get the map associated with this interaction.

Returns:
Map.

getPointerCount(){number} inherited

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

Get an object of all property names and values.

Returns:
Object.

getRevision(){number} inherited

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

Returns:
Revision.

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.

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

Sets a value.

Name Type Description
key string

Key name.

value *

Value.

silent boolean

Update without triggering an event.

Activate or deactivate the interaction.

Name Type Description
active boolean

Active.

setExtent(extent)

Manually sets the drawn extent, using the view projection.

Name Type Description
extent module:ol/extent~Extent

Extent

setProperties(values, opt_silent) inherited

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

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

Unsets a property.

Name Type Description
key string

Key name.

silent boolean

Unset without triggering an event.