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
↳ MapMouseEvent
Implements
MapLibreEvent<MouseEvent>
Accessors
defaultPrevented
• get defaultPrevented(): boolean
true if preventDefault has been called.
Returns
boolean
Defined in
Methods
preventDefault
▸ preventDefault(): void
Prevents subsequent default processing of the event by the map.
Calling this method will prevent the following default map behaviors:
- On
mousedownevents, the behavior of DragPanHandler - On
mousedownevents, the behavior of DragRotateHandler - On
mousedownevents, the behavior of BoxZoomHandler - On
dblclickevents, the behavior of DoubleClickZoomHandler
Returns
void
Defined in
Properties
lngLat
• lngLat: LngLat
The geographic location on the map of the mouse cursor.
Defined in
originalEvent
• originalEvent: MouseEvent
The DOM event which caused the map event.
Implementation of
MapLibreEvent.originalEvent
Defined in
point
• point: Point
The pixel coordinates of the mouse cursor, relative to the map and measured from the top left corner.
Defined in
target
• target: Map
The Map object that fired the event.
Implementation of
MapLibreEvent.target
Defined in
type
• type: "click" | "contextmenu" | "dblclick" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup"
The event type
Implementation of
MapLibreEvent.type
Overrides
Event.type