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)

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. This functions is also called during a drag sequence, so during a drag sequence both the handleDragEvent function and this function are called. If handleDownEvent is defined and it returns true this function will not be called during a drag sequence.

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:

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

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.

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}

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.

handleEvent(mapBrowserEvent){boolean}

Handles the map browser event and may call into other functions, if event sequences like e.g. 'drag' or 'down-up' etc. are detected.

Name Type Description
mapBrowserEvent module:ol/MapBrowserEvent~MapBrowserEvent

Map browser event.

Returns:
false to stop event propagation.

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.

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.