Class CombinedEvents<T, CFG, TShown, WHERE_SCOPE>

A module's user interaction and lifecycle events under a single on / off surface.

User event types (click, contextmenu, hover, hover-move, long-hover, dragstart, drag, dragend) are handled by the underlying UserEvents instance and removed with off.

Module lifecycle event types (config-change, shown-features) are handled by the underlying ModuleEvents instance. Each on call returns an unsubscribe function. off also removes both user and module event types in bulk.

Named scopes, where a module has them, hang off this object as properties. Each is a UserEventsWithStates, with user events and event states only, since lifecycle events stay here. where narrows ad hoc instead, and returns a plain UserEvents.

Example

// User interaction
const unsubscribe = places.events.on('click', (feature, lngLat) => {
  console.log('Clicked place:', feature.properties.title);
});

// Module lifecycle
const unsubscribeConfig = places.events.on('config-change', (config) => {
  console.log('Config updated:', config);
});

const unsubscribeShown = places.events.on('shown-features', (features) => {
  console.log('Shown:', features);
});

// Cleanup
unsubscribe();
unsubscribeConfig();
unsubscribeShown();
places.events.off('click'); // also valid for user events

Type Parameters

T
Feature type that user interaction handlers receive.
CFG
Module configuration type passed to config-change handlers.
TShown = never
Data type passed to shown-features handlers. Use never for modules that have no show method.
WHERE_SCOPE = never
The module-specific scope object where accepts besides a feature predicate, or never for modules that only support predicates. It is unrelated to a module's named scopes, which are properties on this object rather than an argument to it.

Index

Constructors

constructor

Methods

off on where

Constructors

constructor

new CombinedEvents<T, CFG, TShown = never, WHERE_SCOPE = never>(
userEvents: UserEvents<T, WHERE_SCOPE>,
moduleEvents: ModuleEvents<CFG, TShown>,
): CombinedEvents<T, CFG, TShown, WHERE_SCOPE>
Type Parameters
- T
  Feature type that user interaction handlers receive.
- CFG
  Module configuration type passed to config-change handlers.
- TShown = never
  Data type passed to shown-features handlers. Use never for modules that have no show method.
- WHERE_SCOPE = never
  The module-specific scope object where accepts besides a feature predicate, or never for modules that only support predicates. It is unrelated to a module's named scopes, which are properties on this object rather than an argument to it.
Parameters
- userEvents: UserEvents<T, WHERE_SCOPE>
- moduleEvents: ModuleEvents<CFG, TShown>
Returns CombinedEvents<T, CFG, TShown, WHERE_SCOPE>

Methods

off

off(type: EventType | "config-change" | ShownFeaturesType<TShown>): void
Removes all handlers for the given event type at once.

It accepts both user interaction types (click, contextmenu, hover, hover-move, long-hover, dragstart, drag, dragend) and module lifecycle types (config-change, and shown-features on a module that has a show method).

To remove a single handler, call the unsubscribe function that on returns instead, which is also how a component cleans up on unmount: off also removes the handlers other code put on the module, such as a plugin's.
Parameters
- type: EventType | "config-change" | ShownFeaturesType<TShown>
  The event type whose handlers should all be cleared.
Returns void
Example
```
places.events.off('click');          // clear all click handlers
places.events.off('config-change');  // clear all config-change handlers
```

on

on(type: EventType, handler: UserEventHandler<T>): () => void
Subscribes to a user interaction event (click, contextmenu, hover, hover-move, long-hover, dragstart, drag, dragend).
Parameters
- type: EventType
  The user event type.
- handler: UserEventHandler<T>
  Called with the feature, click/hover coordinates, the features at the point from the source that drew it (under where(), the ones in its scope), and that source with its layers.
Returns () => void
An unsubscribe function. Call it to remove only this handler.
Example
```
const unsubscribe = places.events.on('click', (feature, lngLat) => {
  showPlaceDetails(feature.properties);
});
unsubscribe(); // remove only this handler
```
on(
type: "config-change",
handler: (config: CFG | undefined) => void,
): () => void
Subscribes to config-change events.

It fires after every change to the module's configuration, which What triggers config-change lists. The handler receives the module's full updated configuration.
Parameters
- type: "config-change"
  'config-change'
- handler: (config: CFG | undefined) => void
  Receives the module's config, or undefined when the config is cleared.
Returns () => void
An unsubscribe function. Call it to remove only this handler.
Example
```
const unsubscribe = trafficFlow.events.on('config-change', (config) => {
  toggle.checked = config?.visible ?? false;
});
unsubscribe();
```
on(
type: ShownFeaturesType<TShown>,
handler: (features: TShown) => void,
): () => void
Subscribes to shown-features events.

It fires right after the module's show() method, or its equivalent, renders new data on the map. Only modules that have a show method offer it.
Parameters
- type: ShownFeaturesType<TShown>
  'shown-features'
- handler: (features: TShown) => void
  Receives what the module shows: the data passed to show(), or, from a module that shows several kinds, an object naming which, such as PlacesModule's { places } or { connections }.
Returns () => void
An unsubscribe function. Call it to remove only this handler.
Example
```
const unsubscribe = places.events.on('shown-features', (shown) => {
  if ('places' in shown) fitMapToResults(shown.places);
});
unsubscribe();
```

where

where(
scope: EventScope<T, WHERE_SCOPE>,
config?: EventHandlerConfig,
): UserEvents<T, WHERE_SCOPE>
Narrows these events to part of what they cover, as UserEvents.where does.
Parameters
- scope: EventScope<T, WHERE_SCOPE>
  A predicate over this module's feature type or, where the module supports one, a scope object such as { layerGroups } on BaseMapModule.
- Optionalconfig: EventHandlerConfig
  Event configuration for handlers registered through the returned instance, so each scope can have its own hover cursor.
Returns UserEvents<T, WHERE_SCOPE>
A UserEvents covering only the narrowed set. Lifecycle events stay on the module.
Example
```
trafficIncidents.events.where((incident) => incident.properties.magnitudeOfDelay === 'major')
    .on('click', showIncidentDetails);
```

Class CombinedEvents<T, CFG, TShown, WHERE_SCOPE>

Example

Type Parameters

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns CombinedEvents<T, CFG, TShown, WHERE_SCOPE>

Methods

off

Parameters

Returns void

Example

on

Parameters

Returns () => void

Example

Parameters

Returns () => void

Example

Parameters

Returns () => void

Example

where

Parameters

Returns UserEvents<T, WHERE_SCOPE>

Example

Settings

On This Page