Events

The different types of events that Mapbox GL JS can raise.

You can also find additional event documentation for: Map, Marker, Popup, and GeolocationControl.

Evented

src/util/evented.js

Methods mixed in to other classes for event capabilities.

Instance Members

Was this section on Evented helpful?

MapMouseEvent

src/ui/events.js

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

Extends Object.

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);
});

Instance Members

Was this section on MapMouseEvent helpful?

MapTouchEvent

src/ui/events.js

MapTouchEvent is the event type for touch-related map events.

Extends Object.

Instance Members

Was this section on MapTouchEvent helpful?

MapBoxZoomEvent

src/ui/events.js

A MapBoxZoomEvent is the event type for the boxzoom-related map events emitted by the BoxZoomHandler.

Properties

originalEvent(MouseEvent): The DOM event that triggered the boxzoom event. Can be a MouseEvent or KeyboardEvent
type(string): The type of boxzoom event. One of boxzoomstart , boxzoomend or boxzoomcancel
target(Map): The Map instance that triggerred the event
Was this section on MapBoxZoomEvent helpful?

MapDataEvent

src/ui/events.js

A MapDataEvent object is emitted with the Map.event:data and Map.event:dataloading events. Possible values for dataTypes are:

  • 'source': The non-tile data associated with any source
  • 'style': The style used by the map

Properties

type(string): The event type.
dataType(string): The type of data that has changed. One of 'source' , 'style' .
isSourceLoaded(boolean?): True if the event has a dataType of source and the source has no outstanding network requests.
source(Object?): The style spec representation of the source if the event has a dataType of source .
sourceDataType(string?): Included if the event has a dataType of source and the event signals that internal data has been received or changed. Possible values are metadata and content .
tile(Object?): The tile being loaded or changed, if the event has a dataType of source and the event is related to loading of a tile.
coord(Coordinate?): The coordinate of the tile if the event has a dataType of source and the event is related to loading of a tile.

Example

// The sourcedata event is an example of MapDataEvent.
// Set up an event listener on the map.
map.on('sourcedata', function(e) {
if (e.isSourceLoaded) {
// Do something when the source has finished loading
}
});
Was this section on MapDataEvent helpful?

MapWheelEvent

src/ui/events.js

MapWheelEvent is the event type for the wheel map event.

Extends Object.

Instance Members

Was this section on MapWheelEvent helpful?