Events¶

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

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

MapMouseEvent¶

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

Extends Event.

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¶

lngLat¶

The geographic location on the map of the mouse cursor.

originalEvent¶

The DOM event which caused the map event.

point¶

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

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

target¶

The Map object that fired the event.

type¶

The event type (one of Map.event:mousedown, Map.event:mouseup, Map.event:click, Map.event:dblclick, Map.event:mousemove, Map.event:mouseover, Map.event:mouseenter, Map.event:mouseleave, Map.event:mouseout, Map.event:contextmenu).

MapTouchEvent¶

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

Extends Event.

Instance Members¶

lngLat¶

The geographic location on the map of the center of the touch event points.

lngLats¶

The geographical locations on the map corresponding to a touch event's touches property.

originalEvent¶

The DOM event which caused the map event.

point¶

The pixel coordinates of the center of the touch event points, relative to the map and measured from the top left corner.

points¶

The array of pixel coordinates corresponding to a touch event's touches property.

preventDefault()¶

Prevents subsequent default processing of the event by the map.

Calling this method will prevent the following default map behaviors:

On touchstart events, the behavior of DragPanHandler
On touchstart events, the behavior of TouchZoomRotateHandler

target¶

The Map object that fired the event.

type¶

The event type.

vietmapZoomEvent¶

A vietmapZoomEvent 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

MapDataEvent¶

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 , content and visibility .

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(Coordinates?): 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
}
});

MapWheelEvent¶

MapWheelEvent is the event type for the wheel map event.

Extends Object.

Instance Members¶

originalEvent¶

The DOM event which caused the map event.

preventDefault()¶

Prevents subsequent default processing of the event by the map.

Calling this method will prevent the the behavior of ScrollZoomHandler.

target¶

The Map object that fired the event.

type¶

The event type.