On this page
Properties

Type Alias MapLayerEventType

MapLayerEventType - a mapping between the event name and the event. !!! note These events are compatible with the optional layerId parameter. If layerId is included as the second argument in Map.on, the event listener will fire only when the event action contains a visible portion of the specified layer. The following example can be used for all the events.

// Initialize the map
let map = new Map({ // map options });
// Set an event listener for a specific layer
map.on('the-event-name', 'poi-label', (e) => {
  console.log('An event has occurred on a visible portion of the poi-label layer');
});
type MapLayerEventType = {
    click: MapLayerMouseEvent;
    contextmenu: MapLayerMouseEvent;
    dblclick: MapLayerMouseEvent;
    mousedown: MapLayerMouseEvent;
    mouseenter: MapLayerMouseEvent;
    mouseleave: MapLayerMouseEvent;
    mousemove: MapLayerMouseEvent;
    mouseout: MapLayerMouseEvent;
    mouseover: MapLayerMouseEvent;
    mouseup: MapLayerMouseEvent;
    touchcancel: MapLayerTouchEvent;
    touchend: MapLayerTouchEvent;
    touchstart: MapLayerTouchEvent;
}
Index

Properties

click contextmenu dblclick mousedown mouseenter mouseleave mousemove mouseout mouseover mouseup touchcancel touchend touchstart

Properties

click: MapLayerMouseEvent

Fired when a pointing device (usually a mouse) is pressed and released contains a visible portion of the specified layer.

contextmenu: MapLayerMouseEvent

Fired when the right button of the mouse is clicked or the context menu key is pressed within visible portion of the specified layer.

dblclick: MapLayerMouseEvent

Fired when a pointing device (usually a mouse) is pressed and released twice contains a visible portion of the specified layer.

!!! note Under normal conditions, this event will be preceded by two click events.

mousedown: MapLayerMouseEvent

Fired when a pointing device (usually a mouse) is pressed while inside a visible portion of the specified layer.

Create a draggable point

mouseenter: MapLayerMouseEvent

Fired when a pointing device (usually a mouse) enters a visible portion of a specified layer from outside that layer or outside the map canvas.

mouseleave: MapLayerMouseEvent

Fired when a pointing device (usually a mouse) leaves a visible portion of a specified layer, or leaves the map canvas.

mousemove: MapLayerMouseEvent

Fired when a pointing device (usually a mouse) is moved while the cursor is inside a visible portion of the specified layer. As you move the cursor across the layer, the event will fire every time the cursor changes position within that layer.

mouseout: MapLayerMouseEvent

Fired when a point device (usually a mouse) leaves the visible portion of the specified layer.

mouseover: MapLayerMouseEvent

Fired when a pointing device (usually a mouse) is moved inside a visible portion of the specified layer.

mouseup: MapLayerMouseEvent

Fired when a pointing device (usually a mouse) is released while inside a visible portion of the specified layer.

Create a draggable point

touchcancel: MapLayerTouchEvent

Fired when a touchstart event occurs within the visible portion of the specified layer.

Create a draggable point

touchend: MapLayerTouchEvent

Fired when a touchend event occurs within the visible portion of the specified layer.

Create a draggable point

touchstart: MapLayerTouchEvent

Fired when a touchstart event occurs within the visible portion of the specified layer.

Create a draggable point

Was this helpful?
SDK JS
Reference
MapLayerEventType