Class MapMouseEvent

MapMouseEvent is the event type for mouse-related map events.

Example

// The `click` event is an example of a `MapMouseEvent`.
// Set up an event listener on the map.
map.on('click', (e) => {
  // The event object (e) contains information like the
  // coordinates of the point on the map that was clicked.
  console.log('A click event has occurred at ' + e.lngLat);
});

Hierarchy (view full)

Implements

Properties

lngLat originalEvent point target type

Accessors

defaultPrevented

Methods

preventDefault

Properties

lngLat

lngLat: LngLat

The geographic location on the map of the mouse cursor.

originalEvent

originalEvent: MouseEvent

The DOM event which caused the map event.

point

point: Point

The pixel coordinates of the mouse cursor, relative to the map and measured from the top left corner.

target

target: Map

The Map object that fired the event.

type

type: "click" | "contextmenu" | "dblclick" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup"

The event type

Accessors

defaultPrevented

  • get defaultPrevented(): boolean

  • true if preventDefault has been called.

    Returns boolean

Methods

preventDefault

  • preventDefault(): void

  • Prevents subsequent default processing of the event by the map.

    Calling this method will prevent the following default map behaviors:

    Returns void

Settings

Member Visibility

Theme

On This Page

lngLatoriginalEventpointtargettypedefaultPreventedpreventDefault