TomTom Maps for JavaScript
    Preparing search index...

    Class CombinedEvents<T, CFG, TShown, WHERE_SCOPE>

    Unified events interface that blends user interaction events and module lifecycle events under a single on / off surface.

    User event types (click, contextmenu, hover, long-hover) 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. Both user and module event types are also removable in bulk via off.

    Named scopes, where a module has them, hang off this object as properties and are themselves CombinedEvents — so a scope carries the lifecycle events that module actually scopes. where narrows ad hoc instead, and returns a plain UserEvents: a filter you build on the spot has no lifecycle of its own.

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

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

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

    // Cleanup
    unsub();
    unsubConfig();
    unsubShown();
    places.events.off('click'); // also valid for user events

    Type Parameters

    • T

      Feature type surfaced by user interaction handlers.

    • 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

      Module-specific scope object accepted by where, in addition to a feature predicate. never for modules that only support predicates. Unrelated to a module's named scopes, which are properties on this object rather than an argument to it.

    Index
    constructor
    off on where

    • Remove all handlers for the given event type at once.

      Accepts both user interaction types (click, contextmenu, hover, long-hover) and module lifecycle types (config-change, shown-features).

      Prefer the unsubscribe function returned by on when you need to remove a single handler. Use off for bulk teardown — e.g. when unmounting a component that registered multiple handlers of the same type.

      Parameters

      • type: EventType | "config-change" | "shown-features"

        The event type whose handlers should all be cleared.

      Returns void

      places.events.off('click');          // clear all click handlers
      places.events.off('config-change');  // clear all config-change handlers

    • Subscribe to a user interaction event (click, contextmenu, hover, long-hover).

      Parameters

      • type: EventType

        The user event type.

      • handler: UserEventHandler<T>

        Called with the feature, click/hover coordinates, all features at the point, and the source configuration.

      Returns () => void

      An unsubscribe function. Call it to remove only this handler.

      const unsub = places.events.on('click', (feature, lngLat) => {
        showPlaceDetails(feature.properties);
      });
      unsub(); // remove only this handler

    • Subscribe to config-change events.

      Fires after any configuration mutation — applyConfig, setVisible, or any module-specific setter. 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 config is cleared).

      Returns () => void

      An unsubscribe function. Call it to remove only this handler.

      const unsub = trafficFlow.events.on('config-change', (config) => {
        toggle.checked = config?.visible ?? false;
      });
      unsub();

    • Subscribe to shown-features events.

      Fires immediately after the module's show() method (or equivalent) has rendered new data on the map. Only available on modules that have a show method.

      Parameters

      Returns () => void

      An unsubscribe function. Call it to remove only this handler.

      const unsub = places.events.on('shown-features', (features) => {
        fitMapToResults(features);
      });
      unsub();

    • Narrows these events to part of what they cover — see UserEvents.where.

      Parameters

      • scope: EventScope<T, WHERE_SCOPE>

        See EventScope — a predicate over this module's feature type, or, where the module supports one, a scope object such as { layerGroups } on BaseMapModule.

      • Optionalconfig: EventHandlerCursorConfig

        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 (or named scope) they belong to.

      trafficIncidents.events.where((incident) => incident.properties.magnitude === 'major')
          .on('click', showIncidentDetails);

    Settings
    Member Visibility

    On This Page
    Constructors
    Methods