Class RoutingModule

Map module for displaying and managing route visualizations.

The RoutingModule provides comprehensive functionality for displaying routes on the map, including route lines, alternative routes, turn-by-turn guidance, and interactive waypoints. It integrates seamlessly with the TomTom Routing API.

Remarks

Features:

Display route lines with customizable styling
Show alternative routes with different styling
Interactive waypoint markers (drag, add, remove)
Turn-by-turn guidance instructions
Route section highlighting
Distance and duration information
Support for multiple routes simultaneously

Common Use Cases:

Turn-by-turn navigation displays
Route planning and comparison
Multi-stop route optimization
Interactive route editing
Fleet management route visualization

Example

// Create the module
const routingModule = await RoutingModule.getInstance(map, {
  displayUnits: {
    distance: { type: 'metric' }
  }
});

// Calculate and display a route
const result = await calculateRoute({
  key: 'your-api-key',
  locations: [
    [4.9041, 52.3676],  // Amsterdam
    [4.4777, 51.9244]   // Rotterdam
  ],
  routeOptions: {
    travelMode: 'car',
    routeType: 'fastest'
  }
});

await routingModule.showRoutes(result);

See

Routing Guide

Hierarchy (View Summary)

AbstractMapModule<RoutingSourcesWithLayers, RoutingModuleConfig>
- RoutingModule

Index

Accessors

events sourceAndLayerIDs

Methods

applyConfig clearRoutes clearWaypoints getConfig getLayerToRenderLinesUnder resetConfig selectRoute showRoutes showWaypoints waitUntilModuleReady get

Accessors

events

get events(): {
    chargingStops: EventsModule<RouteSection>;
    ferries: EventsModule<RouteSection>;
    incidents: EventsModule<RouteSections<DisplayTrafficSectionProps>>;
    instructionLines: EventsModule<DisplayInstruction>;
    mainLines: EventsModule<Route<DisplayRouteProps>>;
    summaryBubbles: EventsModule<DisplayRouteSummary>;
    tollRoads: EventsModule<RouteSection>;
    tunnels: EventsModule<RouteSection>;
    vehicleRestricted: EventsModule<RouteSection>;
    waypoints: EventsModule<Waypoint<WaypointDisplayProps>>;
}
Create the events on/off for this module

Returns {
    chargingStops: EventsModule<RouteSection>;
    ferries: EventsModule<RouteSection>;
    incidents: EventsModule<RouteSections<DisplayTrafficSectionProps>>;
    instructionLines: EventsModule<DisplayInstruction>;
    mainLines: EventsModule<Route<DisplayRouteProps>>;
    summaryBubbles: EventsModule<DisplayRouteSummary>;
    tollRoads: EventsModule<RouteSection>;
    tunnels: EventsModule<RouteSection>;
    vehicleRestricted: EventsModule<RouteSection>;
    waypoints: EventsModule<Waypoint<WaypointDisplayProps>>;
}
An instance of EventsModule

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: RoutingModuleConfig | 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: RoutingModuleConfig | 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

clearRoutes

clearRoutes(): Promise<void>
Clears any previously shown routes from the map.

Returns Promise<void>
Remarks
- Clears all route-related layers (lines, sections, guidance, summaries)
- Does NOT clear waypoints (use clearWaypoints)
- Module remains initialized and ready for new routes
Example
```
await routing.clearRoutes();
```

clearWaypoints

clearWaypoints(): Promise<void>
Clears any previously shown waypoints from the map.
- If nothing was shown before, nothing happens.
Returns Promise<void>

getConfig

getConfig(): NonNullable<RoutingModuleConfig> | 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<RoutingModuleConfig> | 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

getLayerToRenderLinesUnder

getLayerToRenderLinesUnder(): string
Returns the map style layer under which route lines are rendered.
- Useful if you want to render extra layers just above the route ones but not on top of everything else.
- It might differ depending on the loaded style/version.
Returns string

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

selectRoute

selectRoute(index: number): Promise<void>
Changes which route appears as selected.
Parameters
- index: number
  Zero-based index of the route to select.
Returns Promise<void>
Remarks
Visual Changes:
- Selected route appears more prominent (thicker, brighter)
- Previously selected route becomes deselected style
- Updates all route-related features (sections, guidance)
Requirements:
- Route must already be displayed via showRoutes
- Index must be within range of displayed routes
Example
```
// Show multiple routes
await routingModule.showRoutes(routes);

// User clicks alternative route
await routingModule.selectRoute(1);

// Switch back to first route
await routingModule.selectRoute(0);
```

showRoutes

showRoutes(routes: Route | Routes, options?: ShowRoutesOptions): Promise<void>
Displays the given routes on the map.
Parameters
- routes: Route | Routes
  Route data from Routing API or custom routes.
- Optionaloptions: ShowRoutesOptions
  Optional configuration for route selection and display.
  - selectedIndex
    Index of the route to display as selected (default: 0).
Returns Promise<void>
Remarks
Behavior:
- Replaces any previously shown routes
- Shows all route-related features: lines, sections, summaries, guidance
- First route is selected by default (appears more prominent)
- Waypoints are NOT shown automatically (use showWaypoints)
Route Features:
- Main route lines (selected and deselected styles)
- Traffic sections with delays
- Ferry, tunnel, and toll sections
- EV charging stations (for EV routes)
- Turn-by-turn instruction lines and arrows
- Summary bubbles with distance/time/traffic info
Example
Show single route:
```
await routing.showRoutes(response.routes);
```
Example
Show multiple routes with specific selection:
```
await routing.showRoutes(response.routes, { selectedIndex: 1 });
```
Example
Complete routing workflow:
```
import { routing as routingAPI } from '@tomtom-international/maps-sdk-js/services';

// Calculate route
const response = await routingAPI.calculateRoute({
  locations: [[4.9, 52.4], [4.5, 51.9]],
  traffic: true,
  travelMode: 'car'
});

// Display on map
const routing = await RoutingModule.get(map);
await routing.showRoutes(response.routes);
await routing.showWaypoints(response.routes[0].legs[0].points);
```

showWaypoints

showWaypoints(waypoints: Waypoints | PlanningWaypoint[]): Promise<void>
Shows the given waypoints on the map.
Parameters
- waypoints: Waypoints | PlanningWaypoint[]
  The waypoint-like inputs to show.
Returns Promise<void>

`Protected`waitUntilModuleReady

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

`Static`get

get(tomtomMap: TomTomMap, config?: RoutingModuleConfig): Promise<RoutingModule>
Make sure the map is ready before create an instance of the module and any other interaction with the map
Parameters
- tomtomMap: TomTomMap
  The TomTomMap instance.
- Optionalconfig: RoutingModuleConfig
  The module optional configuration
Returns Promise<RoutingModule>
Returns a promise with a new instance of this module
Remarks
Configuration Options:
- displayUnits: Distance units (metric/imperial)
- waypointsSource: Waypoint entry point options
- layers: Complete layer styling configuration
Default Styling: If no custom layers are provided, uses defaultRoutingLayers.
Example
Default initialization:
```
const routingModule = await RoutingModule.get(map);
```
Example
With custom configuration:
```
const routingModule = await RoutingModule.get(map, {
  displayUnits: 'imperial',
  waypointsSource: {
    entryPoints: 'main-when-available'
  }
});
```

Class RoutingModule

Remarks

Example

See

Hierarchy (View Summary)

Index

Accessors

Methods

Accessors

events

sourceAndLayerIDs

Returns Record<keyof SOURCES_WITH_LAYERS, SourceWithLayerIDs>

Remarks

Example

Methods

applyConfig

Parameters

Returns void

Remarks

Example

See

clearRoutes

Returns Promise<void>

Remarks

Example

clearWaypoints

Returns Promise<void>

getConfig

Returns NonNullable<RoutingModuleConfig> | undefined

Remarks

Example

See

getLayerToRenderLinesUnder

Returns string

resetConfig

Returns void

Remarks

Example

See

selectRoute

Parameters

Returns Promise<void>

Remarks

Example

showRoutes

Parameters

selectedIndex

Returns Promise<void>

Remarks

Example

Example

Example

showWaypoints

Parameters

Returns Promise<void>

ProtectedwaitUntilModuleReady

Returns Promise<void>

Staticget

Parameters

Returns Promise<RoutingModule>

Remarks

Example

Example

Settings

On This Page

`Protected`waitUntilModuleReady

`Static`get