On this page
Constructors
Properties
Accessors
Methods

Class MapMouseEvent

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

// 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 Summary)

Implements

Index

Constructors

constructor

Properties

lngLat originalEvent point target type

Accessors

defaultPrevented

Methods

preventDefault

Constructors

Properties

lngLat: LngLat

The geographic location on the map of the mouse cursor.

originalEvent: MouseEvent

The DOM event which caused the map event.

point: Point

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

target: MapLibreMap

The Map object that fired the event.

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

The event type

Accessors

  • get defaultPrevented(): boolean

    true if preventDefault has been called.

    Returns boolean

Methods

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

    Calling this method will prevent the following default map behaviors:

    Returns void

Was this helpful?
SDK JS
Reference
MapMouseEvent