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', function(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

  • Event$1
    • MapMouseEvent

Implements

  • MapLibreEvent<MouseEvent>

Constructors

constructor

Properties

_defaultPrevented lngLat originalEvent point target type

Accessors

defaultPrevented

Methods

preventDefault

Constructors

constructor

  • Parameters

    • type: string
    • map: Map$1
    • originalEvent: MouseEvent
    • Optional data: any

    Returns MapMouseEvent

Properties

_defaultPrevented

_defaultPrevented: boolean

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$1

The Map object that fired the event.

type

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

The event type

Accessors

defaultPrevented

  • get defaultPrevented(): boolean

  • true if preventDefault has been called.

    Returns boolean

Methods

preventDefault

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

    Calling this method will prevent the following default map behaviors:

    • On mousedown events, the behavior of DragPanHandler
    • On mousedown events, the behavior of DragRotateHandler
    • On mousedown events, the behavior of BoxZoomHandler
    • On dblclick events, the behavior of DoubleClickZoomHandler

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc