TomTom Maps for JavaScript
    Preparing search index...

    Type Alias RoutingModuleConfig

    RoutingModuleConfig: MapModuleCommonConfig & {
        chargingStops?: ChargingStopsConfig;
        displayUnits?: DisplayUnits;
        layers?: RouteLayersConfig;
        summaryBubbles?: { visible?: boolean };
        theme?: RouteTheme;
        waypoints?: WaypointsConfig;
    }

    Configuration options for the routing module.

    Type Declaration

    • OptionalchargingStops?: ChargingStopsConfig

      Configuration for the charging stops source and layers to display them on the map.

      Controls how charging stops source data and/or layer configs are processed to rendering them the map.

    • OptionaldisplayUnits?: DisplayUnits

      Units for displaying distances in route summaries and instructions.

      Overrides the global configuration setting for display units. Affects distance values shown in route summaries and turn-by-turn instructions.

      Available options:

      • metric - Kilometers and meters
      • imperial - Miles and feet

      "metric"

    • Optionallayers?: RouteLayersConfig

      Custom layer styling configuration.

      • Overrides the default layer styling with custom specifications.
      • You must provide complete layer specifications for any layers you wish to customize.
      • You can still reuse the default configurations if you want incremental changes. See: defaultRoutingLayers.
      • Any layer not specified will continue to use its default styling.
      • Use this only if you need fine MapLibre control on how some parts of the route are displayed.
    • OptionalsummaryBubbles?: { visible?: boolean }

      Configuration for the route summary bubbles displayed on the map.

      Summary bubbles show key route information (distance, duration, traffic delay) as visual overlays positioned along the route.

      • Optionalvisible?: boolean

        Controls the visibility of route summary bubbles on the map.

        true
    • Optionaltheme?: RouteTheme

      Main styling configuration for the route visualization.

      • Provides high-level styling options that affect the overall appearance of the route, such as the primary color used for route lines and waypoints.
      • Can be overwritten by more specific layer styling configurations.
    • Optionalwaypoints?: WaypointsConfig

      Configuration for the waypoints source and layers to display them on the map.

      Controls how waypoint source data and/or layer configs are processed to rendering them the map.

    Provides customization options for route visualization and behavior, including display units, waypoint handling, and layer styling.

    Settings

    Member Visibility