Class: MapBrowserEvent

ol/MapBrowserEvent~MapBrowserEvent


Events emitted as map browser events are instances of this type. See module:ol/PluggableMap~PluggableMap for which events trigger a map browser event.

Extends

Members

coordinate{module:ol/coordinate~Coordinate}

The coordinate corresponding to the original browser event. This will be in the user projection if one is set. Otherwise it will be in the view projection.

dragging{boolean}

Indicates if the map is currently being dragged. Only set for POINTERDRAG and POINTERMOVE events. Default is false.

frameState{module:ol/PluggableMap~FrameState}

The frame state at the time of the event.

map{module:ol/PluggableMap~PluggableMap}

The map where the event occurred.

originalEvent{EVENT}

The original browser event.

pixel{module:ol/pixel~Pixel}

The map pixel relative to the viewport corresponding to the original event.

target{Object}

The event target.

type{string}

The event type.

Methods

preventDefault()

MapBrowserEvent.js, line 89

Prevents the default browser action. See https://developer.mozilla.org/en-US/docs/Web/API/event.preventDefault.

stopPropagation()

MapBrowserEvent.js, line 99

Prevents further propagation of the current event. See https://developer.mozilla.org/en-US/docs/Web/API/event.stopPropagation.

Events

change inherited

events/EventType.js, line 10

Generic change event. Triggered when the revision counter is increased.

click

MapBrowserEventType.js, line 19

A click with no dragging. A double click will fire two of this.

dblclick

MapBrowserEventType.js, line 26

A true double click, with no dragging.

error inherited

events/EventType.js, line 17

Generic error event. Triggered when an error occurs.

moveend inherited

MapEventType.js, line 23

Triggered after the map is moved.

movestart inherited

MapEventType.js, line 16

Triggered when the map starts moving.

pointerdrag

MapBrowserEventType.js, line 33

Triggered when a pointer is dragged.

pointermove

MapBrowserEventType.js, line 40

Triggered when a pointer is moved. Note that on touch devices this is triggered when the map is panned, so is not the same as mousemove.

postrender inherited

MapEventType.js, line 9

Triggered after a map frame is rendered.

singleclick

MapBrowserEventType.js, line 11

A true single click with no dragging and no double click. Note that this event is delayed by 250 ms to ensure that it is not a double click.