On/Off

Event detection

on / off

Adds or removes a listener for a specific event on a given layer.

// Adds a listener
mapInstance.on(type, layerId, listener);

// Removes a listener
mapInstance.off(type, layerId, listener);

Parameter

Parameter

Description

Type

type

specifies which event to listen to.

String

Supported types:

"mouseup", "mousedown", "click", "dblclick", "mousemove", "mouseenter", "mouseleave, "mouseover", "mouseout", "contextmenu", "touchstart", touchend" or "touchcancel". "mouseenter" and "mouseover" events are triggered when the cursor enters a visible portion of the specified layer or map canvas from outside and vice versa for "mouseleave" and "mouseout".

layerId (Optional)

ID of a style layer. Only layer that matches the given parameter will trigger the event listener.

String

listener

A callback function that detects the event and triggers further procedures.

Function

Example

// Event listener on click
mapInstance.on("click", function (e) {
    console.log("Click >>>>>>>", e)  
})

// Event listener on mouseover
mapInstance.on("mouseover", "fatosmarker", function (e) P
    if(e.originalEvent.toElement.id){
       console.log("Mouseover>>>>>>>", e)
    }
})

// Removes an event listener on click
mapInstance.off("click", function (e) {
    console.log("Click >>>>>>>", e)  
})

// Removes an event listener on mouseover
mapInstance.off("mouseover", "fatosmarker", function (e) P
    if(e.originalEvent.toElement.id){
       console.log("Mouseover>>>>>>>", e)
    }
})

Last updated

Was this helpful?