InteractionsController


The Interactions controller allows you to observe interactions with the map

Extended by

Events

onPointerClick()

onPointerClick(params: { handler: (event: MapInteractionEvent) => void; }): VoidFunction

Allows you to be notified the user clicks on the map.

Parameters

Parameter
Type

params

{ handler: (event: MapInteractionEvent) => void; }

params.handler

(event: MapInteractionEvent) => void

Returns

VoidFunction

A function to unsubscribe from the listener

Example

const unsubscribe = felt.onPointerClick({
  handler: (event) => console.log(event.center, event.features),
});

// later on...
unsubscribe();

onPointerMove()

onPointerMove(params: { handler: (event: MapInteractionEvent) => void; }): VoidFunction

Allows you to be notified the user moves the mouse over the map.

Parameters

Parameter
Type
Description

params

{ handler: (event: MapInteractionEvent) => void; }

Params for the listener

params.handler

(event: MapInteractionEvent) => void

The handler function

Returns

VoidFunction

A function to unsubscribe from the listener

Example

// Track mouse movement and features under cursor
const unsubscribe = felt.onPointerMove({
  handler: (event) => {
    console.log("Mouse position:", event.center);
    console.log("Features under cursor:", event.features);
  }
});

// later on...
unsubscribe();

Last updated

Was this helpful?