TomTom Maps SDK for JavaScript
This is the documentation of version 0.61.0. Go to the latest version, 1.0.0-rc.5.
TomTom Maps for JavaScript
    Preparing search index...

    Class TrafficFlowModule

    Traffic Flow Module for displaying and configuring real-time traffic flow information on the map.

    This module controls the vector tile traffic flow layers that visualize current traffic speed conditions using color-coded road segments.

    What this module owns: whether the style's traffic-flow layers are shown, and for which roads. Each flow level's colour and the line width are traffic.flow.* knobs on StylingModule. See Who owns what.

    Features:

    • Toggle traffic flow visibility on/off
    • Filter by road categories and types
    • Color-coded speed visualization (green = free flow, red = congestion)
    • Real-time traffic data from vector tiles
    • Filter road closures

    Visual Representation:

    • Green: Free-flowing traffic
    • Yellow/Orange: Slow traffic
    • Red: Heavy congestion
    • Dark gray: Road closures

    Basic usage:

    import { TrafficFlowModule } from '@tomtom-org/maps-sdk/map';

    // Get module (auto-add to style if needed)
    const trafficFlow = await TrafficFlowModule.get(map, {
      visible: true
    });

    // Toggle visibility
    trafficFlow.setVisible(false);
    trafficFlow.setVisible(true);

    Filter by road type:

    // Show only highway traffic
    trafficFlow.filter({
      any: [{
        roadCategories: {
          show: 'only',
          values: ['motorway', 'trunk']
        }
      }]
    });

    // Hide local streets
    trafficFlow.filter({
      any: [{
        roadCategories: {
          show: 'all-except',
          values: ['street']
        }
      }]
    });

    Show only road closures:

    trafficFlow.filter({
      any: [{
        showRoadClosures: 'only'
      }]
    });

    Hierarchy (View Summary)

    Index
    events sourceAndLayerIDs
    applyConfig filter getConfig getShown isVisible resetConfig setVisible updateConfig waitUntilModuleReady get
    • get sourceAndLayerIDs(): Record<keyof SOURCES_WITH_LAYERS, SourceWithLayerIDs>

      Gets the source and layer identifiers for all sources managed by this module.

      This property provides access to the MapLibre source and layer IDs that were created and are managed by this module. These IDs can be used to interact directly with MapLibre's API or to identify which layers belong to this module.

      Returns Record<keyof SOURCES_WITH_LAYERS, SourceWithLayerIDs>

      A record mapping each source name to its corresponding source ID and layer IDs. Each entry contains the MapLibre source identifier and an array of layer identifiers associated with that source.

      The returned IDs are useful when you need to:

      • Directly manipulate layers using MapLibre's native API
      • Identify which layers on the map belong to this module
      • Set layer ordering or positioning relative to other layers
      • Access source or layer properties through MapLibre methods
      const ids = myModule.sourceAndLayerIDs;
      console.log(ids);
      // {
      //   mySource: {
      //     sourceID: 'my-source-id',
      //     layerIDs: ['layer-1', 'layer-2']
      //   }
      // }

      // Use with MapLibre API
      const map = myModule.mapLibreMap;
      ids.mySource.layerIDs.forEach(layerId => {
        map.setLayoutProperty(layerId, 'visibility', 'visible');
      });

    • Applies a configuration to this module.

      This method updates the module's behavior and appearance based on the provided configuration. The configuration is stored internally and will be automatically reapplied if the map style changes.

      Parameters

      • config: TrafficFlowModuleConfig | undefined

        The configuration object to apply to the module. Pass undefined to reset the configuration to default values.

      Returns void

      When a configuration is applied, the module updates its visual representation and behavior accordingly. The configuration persists across map style changes, ensuring consistent module behavior even when the map's base style is modified.

      The given configuration replaces the current one rather than being merged into it. To change one part of it, use updateConfig.

      // Apply a new configuration
      myModule.applyConfig({ visible: true, opacity: 0.8 });

      // Reset to default configuration
      myModule.applyConfig(undefined);
      • resetConfig for a convenience method to reset configuration
      • getConfig to retrieve the current configuration

    • Applies filters to traffic flow display.

      Parameters

      • Optionalfilters: TrafficFlowFilters

        Filter configuration for road types, categories, and closures. Pass undefined to reset to defaults (show all).

      Returns void

      Filter Options:

      • roadCategories: Filter by road importance (motorway, trunk, primary, etc.)
      • roadSubCategories: Filter by specific street types
      • showRoadClosures: Show only closures or exclude them

      Available Road Categories:

      • motorway: Major highways
      • trunk: Major roads
      • primary: Primary roads
      • secondary: Secondary roads
      • tertiary: Tertiary roads
      • street: Local streets

      Filter Logic: Uses "any" (OR) logic - traffic matching any filter is shown.

      Show only major roads:

      trafficFlow.filter({
        any: [{
          roadCategories: {
            show: 'only',
            values: ['motorway', 'trunk', 'primary']
          }
        }]
      });

      Hide street-level traffic:

      trafficFlow.filter({
        any: [{
          roadCategories: {
            show: 'all-except',
            values: ['street']
          }
        }]
      });

      Multiple filter criteria:

      trafficFlow.filter({
        any: [
          {
            roadCategories: { show: 'only', values: ['motorway'] }
          },
          {
            showRoadClosures: 'only'
          }
        ]
      });

      Reset filters:

      trafficFlow.filter(undefined);

    • Retrieves a copy of the current module configuration.

      This method returns a shallow copy of the configuration object that is currently applied to the module. If no configuration has been applied, it returns undefined.

      Returns NonNullable<TrafficFlowModuleConfig> | undefined

      A shallow copy of the current configuration object, or undefined if no configuration is currently applied. The returned object is a copy to prevent unintended modifications to the internal state.

      The returned configuration object is a shallow copy, which means that while the top-level properties are copied, any nested objects or arrays are still referenced from the original configuration. This is sufficient for most use cases but should be kept in mind when dealing with complex configurations.

      // Apply a configuration
      myModule.applyConfig({ visible: true, opacity: 0.8 });

      // Later, retrieve the current configuration
      const currentConfig = myModule.getConfig();
      console.log(currentConfig); // { visible: true, opacity: 0.8 }

      // When no config is applied
      myModule.resetConfig();
      console.log(myModule.getConfig()); // undefined

    • Returns features currently visible in the viewport.

      Returns { trafficFlow: TrafficFlowModuleFeature[] }

      An object containing visible traffic flow features.

      The only way to read live flow values: Orbis traffic flow is vector tiles, with no service for a road, a point or an area. Results cover the current viewport and zoom, and a segment crossing a tile boundary appears once per tile. See TrafficFlowModuleFeature for what each carries.

      const shown = trafficFlow.getShown();
      console.log(`Visible flow segments: ${shown.trafficFlow.length}`);
      shown.trafficFlow.forEach(segment => {
        console.log('Road segment:', segment.properties);
      });

      Analyze congestion in viewport:

      const shown = trafficFlow.getShown();
      const congested = shown.trafficFlow.filter(
        segment => segment.properties.relativeSpeed < 0.5
      );
      console.log(`Congested segments: ${congested.length}`);

    • Whether traffic flow is set to be shown.

      Returns boolean

      The visible setting; false while nothing has set it, as traffic is hidden until shown.

    • Resets the configuration of this module to its default values.

      This is a convenience method that clears any previously applied configuration and restores the module to its initial state. This is equivalent to calling applyConfig(undefined).

      Returns void

      After calling this method, the module will behave as if no configuration was ever applied. Any custom settings, styling, or behavior modifications will be removed and replaced with default values.

      // Apply some configuration
      myModule.applyConfig({ visible: true, opacity: 0.5 });

      // Later, reset to defaults
      myModule.resetConfig();
      • applyConfig to apply a new configuration
      • getConfig to retrieve the current configuration before resetting

    • Sets the visibility of traffic flow layers.

      Parameters

      • visible: boolean

        true to show traffic flow, false to hide it.

      Returns void

      trafficFlow.setVisible(true);  // Show traffic
      trafficFlow.setVisible(false); // Hide traffic

    • Changes part of the configuration and keeps the rest.

      The given properties are laid over the current configuration — one level deep, so a nested object you pass replaces the nested object that was there — and the result is applied with applyConfig. This is the same on every module, whatever its applyConfig does with a whole configuration.

      Parameters

      • partial: Partial<NonNullable<CFG>>

        The properties to change.

      Returns void

      routing.applyConfig({ displayUnits: 'imperial', color: '#0a3653' });
      routing.updateConfig({ color: '#c2185b' }); // displayUnits stays imperial

      applyConfig to apply a whole configuration

    • Retrieves a TrafficFlowModule instance for the given map.

      Parameters

      • map: TomTomMap

        The TomTomMap instance to attach this module to.

      • Optionalconfig: TrafficFlowModuleConfig

        Optional configuration for initialization, visibility, and filters.

      Returns Promise<TrafficFlowModule>

      A promise that resolves to the initialized TrafficFlowModule.

      Configuration:

      • visible: Initial visibility state
      • ensureAddedToStyle: Auto-add traffic flow to style if missing
      • filters: Road category and type filters

      trafficFlowKnobCatalogue lists the plain-valued settings as data.

      Style Requirement: Traffic flow must be included in the map style or added via ensureAddedToStyle.

      Error if traffic flow source is not in style and ensureAddedToStyle is false

      Default initialization:

      const trafficFlowModule = await TrafficFlowModule.get(map);

      Auto-add to style:

      const trafficFlowModule = await TrafficFlowModule.get(map, {
        visible: true,
        filters: {
          any: [{
            roadCategories: {
              show: 'only',
              values: ['motorway', 'trunk', 'primary']
            }
          }]
        }
      });

    Settings
    Member Visibility

    On This Page
    Accessors
    Methods