Class TrafficAreaAnalyticsModule

Traffic Area Analytics visualization module.

Renders area-analytics data on the map in one of two modes:

hexgrid — 3D extruded hexagonal polygons coloured and raised by the active metric
heatmap — a MapLibre density-heatmap layer built from tile-centre points

Remarks

Quick start:

import { TrafficAreaAnalyticsModule } from '@tomtom-org/maps-sdk/map';
import { trafficAreaAnalytics } from '@tomtom-org/maps-sdk/services';

const module = await TrafficAreaAnalyticsModule.get(map);
const analytics = await trafficAreaAnalytics({ ... });
await module.show(analytics);

Hierarchy (View Summary)

AbstractMapModule<AreaAnalyticsSourcesWithLayers, TrafficAreaAnalyticsConfig>
- TrafficAreaAnalyticsModule

Index

Accessors

events sourceAndLayerIDs

Methods

applyConfig clear getConfig getShown isVisible resetConfig setColorScheme setMetric setMode setVisible show waitUntilModuleReady get

Accessors

events

get events(): EventsModule<AreaAnalyticsHexFeature>
Event interface for the hexgrid layer (hover / click on hexagonal cells).

Returns EventsModule<AreaAnalyticsHexFeature>
Example
```
module.events.on('hover', (feature, lngLat) => {
  console.log(feature.properties.congestionLevel);
});
```

sourceAndLayerIDs

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.
Remarks
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
Example
```
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');
});
```
Inherited from AbstractMapModule.sourceAndLayerIDs

Methods

applyConfig

applyConfig(config: TrafficAreaAnalyticsConfig | undefined): void
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: TrafficAreaAnalyticsConfig | undefined
  The configuration object to apply to the module. Pass undefined to reset the configuration to default values.
Returns void
Remarks
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.
Example
```
// Apply a new configuration
myModule.applyConfig({ visible: true, opacity: 0.8 });

// Reset to default configuration
myModule.applyConfig(undefined);
```
See
- resetConfig for a convenience method to reset configuration
- getConfig to retrieve the current configuration
Inherited from AbstractMapModule.applyConfig

clear

clear(): Promise<void>
Removes all area analytics data from the map.

Returns Promise<void>

getConfig

getConfig(): NonNullable<TrafficAreaAnalyticsConfig> | 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<TrafficAreaAnalyticsConfig> | 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.
Remarks
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.
Example
```
// 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
```
See
- applyConfig to modify the configuration
- resetConfig to clear the configuration
Inherited from AbstractMapModule.getConfig

getShown

getShown(): {
    heatmap: FeatureCollection<Point, AreaAnalyticsDisplayProperties>;
    hexgrid: FeatureCollection<Polygon, AreaAnalyticsDisplayProperties>;
}
Returns the currently displayed data for both visualisation modes.

Returns {
    heatmap: FeatureCollection<Point, AreaAnalyticsDisplayProperties>;
    hexgrid: FeatureCollection<Polygon, AreaAnalyticsDisplayProperties>;
}

isVisible

isVisible(): boolean
Whether any area analytics layer is currently visible.

Returns boolean

resetConfig

resetConfig(): void
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
Remarks
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.
Example
```
// Apply some configuration
myModule.applyConfig({ visible: true, opacity: 0.5 });

// Later, reset to defaults
myModule.resetConfig();
```
See
- applyConfig to apply a new configuration
- getConfig to retrieve the current configuration before resetting
Inherited from AbstractMapModule.resetConfig

setColorScheme

setColorScheme(scheme: AreaAnalyticsColorScheme): void
Changes the color scheme preset.
Parameters
- scheme: AreaAnalyticsColorScheme
  One of 'congestion', 'thermal', or 'monochrome'.
Returns void

setMetric

setMetric(metric: AreaAnalyticsMetricKey): void
Changes the active metric that drives colour and height.
Parameters
- metric: AreaAnalyticsMetricKey
  One of 'congestionLevel', 'speed', or 'travelTime'.
Returns void

setMode

setMode(mode: "heatmap" | "hexgrid"): void
Switches the visualisation mode.
Parameters
- mode: "heatmap" | "hexgrid"
  'heatmap' or 'hexgrid'.
Returns void

setVisible

setVisible(visible: boolean): void
Shows or hides all area analytics layers.
Parameters
- visible: boolean
Returns void

show

show(analytics: TrafficAreaAnalytics): Promise<void>
Displays area analytics data on the map.

Accepts the raw response from trafficAreaAnalytics(). Tile data is transformed internally to point features (heatmap) and hexagonal polygons (hexgrid) — no manual data preparation is needed.
Parameters
- analytics: TrafficAreaAnalytics
  The raw TrafficAreaAnalytics service response.
Returns Promise<void>
Example
```
const analytics = await trafficAreaAnalytics({ ... });
await module.show(analytics);
```

`Protected`waitUntilModuleReady

waitUntilModuleReady(): Promise<void>
Returns Promise<void>
Inherited from AbstractMapModule.waitUntilModuleReady

`Static`get

get(
tomtomMap: TomTomMap,
config?: TrafficAreaAnalyticsConfig,
): Promise<TrafficAreaAnalyticsModule>
Creates a new Traffic Area Analytics module.
Parameters
- tomtomMap: TomTomMap
  The TomTomMap instance.
- Optionalconfig: TrafficAreaAnalyticsConfig
  Optional initial configuration.
Returns Promise<TrafficAreaAnalyticsModule>
A promise that resolves with the initialised module.
Example
```
const module = await TrafficAreaAnalyticsModule.get(map, {
  mode: 'hexgrid',
  metric: 'congestionLevel',
});
```

Class TrafficAreaAnalyticsModule

Remarks

Hierarchy (View Summary)

Index

Accessors

Methods

Accessors

events

Returns EventsModule<AreaAnalyticsHexFeature>

Example

sourceAndLayerIDs

Returns Record<keyof SOURCES_WITH_LAYERS, SourceWithLayerIDs>

Remarks

Example

Methods

applyConfig

Parameters

Returns void

Remarks

Example

See

clear

Returns Promise<void>

getConfig

Returns NonNullable<TrafficAreaAnalyticsConfig> | undefined

Remarks

Example

See

getShown

Returns { heatmap: FeatureCollection<Point, AreaAnalyticsDisplayProperties>; hexgrid: FeatureCollection<Polygon, AreaAnalyticsDisplayProperties>;}

isVisible

Returns boolean

resetConfig

Returns void

Remarks

Example

See

setColorScheme

Parameters

Returns void

setMetric

Parameters

Returns void

setMode

Parameters

Returns void

setVisible

Parameters

Returns void

show

Parameters

Returns Promise<void>

Example

ProtectedwaitUntilModuleReady

Returns Promise<void>

Staticget

Parameters

Returns Promise<TrafficAreaAnalyticsModule>

Example

Settings

On This Page

Returns {
heatmap: FeatureCollection<Point, AreaAnalyticsDisplayProperties>;
hexgrid: FeatureCollection<Polygon, AreaAnalyticsDisplayProperties>;
}

`Protected`waitUntilModuleReady

`Static`get