OpenLayers v5.3.0 API - Class: PointerInteraction

Class: PointerInteraction

ol/interaction/Pointer~PointerInteraction

import PointerInteraction from 'ol/interaction/Pointer';

Base class that calls user-defined functions on down, move and up events. This class also manages "drag sequences".

When the handleDownEvent user function returns true a drag sequence is started. During a drag sequence the handleDragEvent user function is called on move events. The drag sequence ends when the handleUpEvent user function is called and returns false.

new PointerInteraction(opt_options)

interaction/Pointer.js, line 46

Name Type Description

options

Options.

Name	Type	Description
`handleDownEvent`	function	Function handling "down" events. If the function returns `true` then a drag sequence is started.
`handleDragEvent`	function	Function handling "drag" events. This function is called on "move" events during a drag sequence.
`handleEvent`	function	Method called by the map to notify the interaction that a browser event was dispatched to the map. The function may return `false` to prevent the propagation of the event to other interactions in the map's interactions chain.
`handleMoveEvent`	function	Function handling "move" events. This function is called on "move" events, also during a drag sequence (so during a drag sequence both the `handleDragEvent` function and this function are called).
`handleUpEvent`	function	Function handling "up" events. If the function returns `false` then the current drag sequence is stopped.
`stopDown`	function	Should the down event be propagated to other interactions, or should be stopped?

Fires:

change (module:ol/events/Event~Event) - Generic change event. Triggered when the revision counter is increased.
change:active (module:ol/Object.ObjectEvent)
propertychange (module:ol/Object.ObjectEvent) - Triggered when a property is changed.

Subclasses

Extends

module:ol/interaction/Interaction~Interaction

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.

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.