Extent~Extent

import Extent from 'ol/interaction/Extent.js';

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. The interaction can also be configured with an initial extent and a createCondition to prevent the creation of a new extent on pointerdown, if desired.

new Extent(options) interaction/Extent.js, line 105

Name	Type	Description
`condition`	Condition \| undefined	A function that takes a `MapBrowserEvent` and returns a boolean to indicate whether that event should be handled. Default is `always`.
`createCondition`	Condition \| null (defaults to null)	A function that takes a `MapBrowserEvent` and returns a boolean to indicate whether that event should be handled to create a new extent. If `null`, the `condition` will also be used as `createCondition`.
`drag`	boolean (defaults to false)	An extent can be dragged.
`extent`	Extent \| undefined	Initial extent. Defaults to no initial extent.
`boxStyle`	StyleLike \| undefined	Style for the drawn extent box. Defaults to the `Polygon` editing style documented in `Style`
`pixelTolerance`	number (defaults to 10)	Pixel tolerance for considering the pointer close enough to a segment or vertex for editing.
`pointerStyle`	StyleLike \| undefined	Style for the cursor used to draw the extent. Defaults to the `Point` editing style documented in `Style`
`wrapX`	boolean (defaults to false)	Wrap the drawn extent across multiple maps in the X direction? Only affects visuals, not functionality.

Fires:

change (BaseEvent) - Generic change event. Triggered when the revision counter is increased.
change:active (ObjectEvent)
error (BaseEvent) - Generic error event. Triggered when an error occurs.
extentchanged (ExtentEvent) - Triggered after the extent is changed
propertychange (ObjectEvent) - Triggered when a property is changed.

Extends

PointerInteraction

Observable Properties

Name	Type	Settable	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`	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 136

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(){Extent} interaction/Extent.js, line 508

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

Returns:

Drawn extent in the view projection.

getExtentInternal(){Extent} interaction/Extent.js, line 522

Returns the current drawn extent in the view projection

Deprecated

Use getExtent instead.

Returns:

Drawn extent in the view projection.

getKeys(){Array.<string>} inherited Object.js, line 149

Get a list of object property names.

Returns:

List of property names.

getMap(){Map | 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(){NoInfer.<Properties>} inherited Object.js, line 158

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){EventsKey | Array<EventsKey>} inherited Observable.js, line 152

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){EventsKey | Array<EventsKey>} inherited Observable.js, line 164

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, silent) inherited Object.js, line 218

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 532

Manually sets the drawn extent, using the view projection.

Name	Type	Description
`extent`	Extent	Extent

setProperties(values, silent) inherited Object.js, line 238

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`	Partial.<NoInfer.<Properties>>	Values.
`silent`	boolean \| undefined	Update without triggering an event.

un(type, listener) inherited Observable.js, line 173

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, silent) inherited Object.js, line 262

Unsets a property.

Name	Type	Description
`key`	string	Key name.
`silent`	boolean \| undefined	Unset without triggering an event.