Skip to content

Type alias: MapLayerEventType

Ƭ MapLayerEventType: Object

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.

Example

// Initialize the map
let map = new Map({ // map options });
// Set an event listener for a specific layer
map.on('the-event-name', 'poi-label', function(e) {
  console.log('An event has occurred on a visible portion of the poi-label layer');
});

Type declaration

Name Type Description
click MapLayerMouseEvent Fired when a pointing device (usually a mouse) is pressed and released contains a visible portion of the specified layer. See - Measure distances - Center the map on a clicked symbol
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. See 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. See - Center the map on a clicked symbol - Display a popup on click
mouseleave MapLayerMouseEvent Fired when a pointing device (usually a mouse) leaves a visible portion of a specified layer, or leaves the map canvas. See - Highlight features under the mouse pointer - Display a popup on click
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. See - Get coordinates of the mouse pointer - Highlight features under the mouse pointer - Display a popup on over
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. See - Get coordinates of the mouse pointer - Highlight features under the mouse pointer - Display a popup on hover
mouseup MapLayerMouseEvent Fired when a pointing device (usually a mouse) is released while inside a visible portion of the specified layer. See Create a draggable point
touchcancel MapLayerTouchEvent Fired when a touchstart event occurs within the visible portion of the specified layer. See Create a draggable point
touchend MapLayerTouchEvent Fired when a touchend event occurs within the visible portion of the specified layer. See Create a draggable point
touchstart MapLayerTouchEvent Fired when a touchstart event occurs within the visible portion of the specified layer. See Create a draggable point

Defined in

src/ui/events.ts:49