The Interactions module allows you to be notified when the user interacts with the map.

Interactions include clicking and hovering on points and features.

Index

Interfaces

• MapInteractionEvent

Controller

• InteractionsController

The Interactions controller allows you to observe interactions with the map

Extended by

• FeltController

Events

onPointerClick()

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

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

Parameters

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

Returns

VoidFunction

A function to unsubscribe from the listener

Example

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

// later on...
unsubscribe();

The event object passed to the interaction listeners.

Properties

coordinate

coordinate: LatLng

The cursor position in world coordinates.

features

features: Feature[]

The vector features that are under the cursor.

rasterValues

rasterValues: RasterValue[]

The raster pixel values that are under the cursor.