Module: ol/interaction/Pointer

ol/interaction/Pointer


Classes

PointerInteraction

Methods

module:ol/interaction/Pointer~handleEvent(mapBrowserEvent){boolean}

interaction/Pointer.js, line 209

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

This:
Name Type Description
mapBrowserEvent module:ol/MapBrowserEvent~MapBrowserEvent

Map browser event.

Returns:
false to stop event propagation.

Type Definitions

Options{Object}

Properties:
Name Type Argument Description
handleDownEvent function <optional>

Function handling "down" events. If the function returns true then a drag sequence is started.

handleDragEvent function <optional>

Function handling "drag" events. This function is called on "move" events during a drag sequence.

handleEvent function <optional>

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

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

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?