Type Alias RouteLayersConfig

Detailed configuration for the visual appearance of route layers on the map with the MapLibre specification.

Remarks

Provides fine-grained control over all route visualization layers, including main route lines, waypoints, route sections (ferry, tunnel, toll roads, etc.), turn-by-turn guidance instructions, and route summaries.

All fields are optional. When a field is not provided, the default styling will be used.

type RouteLayersConfig = {
    chargingStops?: {
        routeChargingStopSymbol?: Partial<
            ToBeAddedLayerSpecTemplate<SymbolLayerSpecification>,
        >;
    } & HasAdditionalLayersConfig;
    instructionArrows?: {
        routeInstructionArrowSymbol?: Partial<
            ToBeAddedLayerSpecTemplate<SymbolLayerSpecification>,
        >;
    } & HasAdditionalLayersConfig;
    instructionLines?: {
        routeInstructionLine?: Partial<
            ToBeAddedLayerSpecTemplate<LineLayerSpecification>,
        >;
        routeInstructionOutline?: Partial<
            ToBeAddedLayerSpecTemplate<LineLayerSpecification>,
        >;
    } & HasAdditionalLayersConfig;
    mainLines?: {
        routeDeselectedLine?: Partial<
            ToBeAddedLayerSpecTemplate<LineLayerSpecification>,
        >;
        routeDeselectedOutline?: Partial<
            ToBeAddedLayerSpecTemplate<LineLayerSpecification>,
        >;
        routeLine?: Partial<ToBeAddedLayerSpecTemplate<LineLayerSpecification>>;
        routeLineArrows?: Partial<
            ToBeAddedLayerSpecTemplate<SymbolLayerSpecification>,
        >;
        routeOutline?: Partial<ToBeAddedLayerSpecTemplate<LineLayerSpecification>>;
    } & HasAdditionalLayersConfig;
    sections?: {
        [T in GeneratedSectionType]?: {
            [K in SectionLineLayerName<T>]?: Partial<
                ToBeAddedLayerSpecTemplate<LineLayerSpecification>,
            >
        } & {
            [K in SectionSymbolLayerName<T>]?: Partial<
                ToBeAddedLayerSpecTemplate<SymbolLayerSpecification>,
            >
        } & {
            [K in SectionSignLayerName<T>]?: Partial<
                ToBeAddedLayerSpecTemplate<SymbolLayerSpecification>,
            >
        } & HasAdditionalLayersConfig
    } & {
        ferry?: {
            routeFerryLine?: Partial<
                ToBeAddedLayerSpecTemplate<LineLayerSpecification>,
            >;
            routeFerrySymbol?: Partial<
                ToBeAddedLayerSpecTemplate<SymbolLayerSpecification>,
            >;
        } & HasAdditionalLayersConfig;
        tollRoad?: {
            routeTollRoadOutline?: Partial<
                ToBeAddedLayerSpecTemplate<LineLayerSpecification>,
            >;
            routeTollRoadSymbol?: Partial<
                ToBeAddedLayerSpecTemplate<SymbolLayerSpecification>,
            >;
        } & HasAdditionalLayersConfig;
        traffic?: {
            routeIncidentBackgroundLine?: Partial<
                ToBeAddedLayerSpecTemplate<LineLayerSpecification>,
            >;
            routeIncidentCauseSymbol?: Partial<
                ToBeAddedLayerSpecTemplate<SymbolLayerSpecification>,
            >;
            routeIncidentDashedLine?: Partial<
                ToBeAddedLayerSpecTemplate<LineLayerSpecification>,
            >;
            routeIncidentJamSymbol?: Partial<
                ToBeAddedLayerSpecTemplate<SymbolLayerSpecification>,
            >;
        } & HasAdditionalLayersConfig;
        tunnel?: {
            routeTunnelLine?: Partial<
                ToBeAddedLayerSpecTemplate<LineLayerSpecification>,
            >;
        } & HasAdditionalLayersConfig;
        vehicleRestricted?: {
            routeVehicleRestrictedBackgroundLine?: Partial<
                ToBeAddedLayerSpecTemplate<LineLayerSpecification>,
            >;
            routeVehicleRestrictedForegroundLine?: Partial<
                ToBeAddedLayerSpecTemplate<LineLayerSpecification>,
            >;
        } & HasAdditionalLayersConfig;
    };
    summaryBubbles?: {
        routeSummaryBubbleSymbol?: Partial<
            ToBeAddedLayerSpecTemplate<SymbolLayerSpecification>,
        >;
    } & HasAdditionalLayersConfig;
    waypoints?: {
        routeWaypointLabel?: Partial<
            ToBeAddedLayerSpecTemplate<SymbolLayerSpecification>,
        >;
        routeWaypointSymbol?: Partial<
            ToBeAddedLayerSpecTemplate<SymbolLayerSpecification>,
        >;
    } & HasAdditionalLayersConfig;
}

Index

Properties

chargingStops? instructionArrows? instructionLines? mainLines? sections? summaryBubbles? waypoints?

Properties

`Optional`chargingStops

chargingStops?: {
    routeChargingStopSymbol?: Partial<
        ToBeAddedLayerSpecTemplate<SymbolLayerSpecification>,
    >;
} & HasAdditionalLayersConfig

Electric vehicle charging station section layers.

Type Declaration

OptionalrouteChargingStopSymbol?: Partial<ToBeAddedLayerSpecTemplate<SymbolLayerSpecification>>

Symbol layer for rendering charging stop icons on the map.

Remarks
Use this layer to control icon image, size, and placement for charging stops.

Remarks

Marks charging stop locations along routes calculated for electric vehicles.

Charging stops are individual points which are originally extracted from leg sections.

`Optional`instructionArrows

instructionArrows?: {
    routeInstructionArrowSymbol?: Partial<
        ToBeAddedLayerSpecTemplate<SymbolLayerSpecification>,
    >;
} & HasAdditionalLayersConfig

Turn-by-turn instruction arrow layers.

Type Declaration

OptionalrouteInstructionArrowSymbol?: Partial<ToBeAddedLayerSpecTemplate<SymbolLayerSpecification>>

Symbol layer for instruction/direction arrows placed along maneuver segments.

Remarks
Controls arrow icon, rotation, and placement relative to the instruction geometry.

Remarks

Directional arrows indicating the direction of travel for each maneuver.

`Optional`instructionLines

instructionLines?: {
    routeInstructionLine?: Partial<
        ToBeAddedLayerSpecTemplate<LineLayerSpecification>,
    >;
    routeInstructionOutline?: Partial<
        ToBeAddedLayerSpecTemplate<LineLayerSpecification>,
    >;
} & HasAdditionalLayersConfig

Turn-by-turn instruction line layers.

Type Declaration

OptionalrouteInstructionLine?: Partial<ToBeAddedLayerSpecTemplate<LineLayerSpecification>>

Line layer for the instruction segment itself.

Remarks
Represents the precise geometry of the maneuver for which an instruction is shown.
OptionalrouteInstructionOutline?: Partial<ToBeAddedLayerSpecTemplate<LineLayerSpecification>>

Line layer for the outline around instruction segments.

Remarks
Used to make instruction segments readable over complex map backgrounds.

Remarks

Visual representation of individual maneuver segments in the guidance instructions.

`Optional`mainLines

mainLines?: {
    routeDeselectedLine?: Partial<
        ToBeAddedLayerSpecTemplate<LineLayerSpecification>,
    >;
    routeDeselectedOutline?: Partial<
        ToBeAddedLayerSpecTemplate<LineLayerSpecification>,
    >;
    routeLine?: Partial<ToBeAddedLayerSpecTemplate<LineLayerSpecification>>;
    routeLineArrows?: Partial<
        ToBeAddedLayerSpecTemplate<SymbolLayerSpecification>,
    >;
    routeOutline?: Partial<ToBeAddedLayerSpecTemplate<LineLayerSpecification>>;
} & HasAdditionalLayersConfig

Main route line layer specifications.

Type Declaration

OptionalrouteDeselectedLine?: Partial<ToBeAddedLayerSpecTemplate<LineLayerSpecification>>

Styling for the deselected (inactive) route line.

Remarks
Used when multiple routes are shown and some are visually de-emphasized.
OptionalrouteDeselectedOutline?: Partial<ToBeAddedLayerSpecTemplate<LineLayerSpecification>>

Styling for the outline around the deselected route line.

Remarks
Matches routeDeselectedLine but provides an outer stroke for visibility.
OptionalrouteLine?: Partial<ToBeAddedLayerSpecTemplate<LineLayerSpecification>>

Styling for the primary, selected route line.

Remarks
Controls the visual appearance of the active route's line (color, width, dash pattern, etc.).
OptionalrouteLineArrows?: Partial<ToBeAddedLayerSpecTemplate<SymbolLayerSpecification>>

Symbol layer that renders directional arrows along the main route.

Remarks
Arrows can help indicate travel direction along routes with complex geometry.
OptionalrouteOutline?: Partial<ToBeAddedLayerSpecTemplate<LineLayerSpecification>>

Styling for the outline (stroke) around the primary route line.

Remarks
Typically used to create contrast between the route and map background.

Remarks

Defines the visual styling for the primary route path displayed on the map. Can include both line and symbol layers for enhanced visualization.

`Optional`sections

sections?: {
    [T in GeneratedSectionType]?: {
        [K in SectionLineLayerName<T>]?: Partial<
            ToBeAddedLayerSpecTemplate<LineLayerSpecification>,
        >
    } & {
        [K in SectionSymbolLayerName<T>]?: Partial<
            ToBeAddedLayerSpecTemplate<SymbolLayerSpecification>,
        >
    } & {
        [K in SectionSignLayerName<T>]?: Partial<
            ToBeAddedLayerSpecTemplate<SymbolLayerSpecification>,
        >
    } & HasAdditionalLayersConfig
} & {
    ferry?: {
        routeFerryLine?: Partial<
            ToBeAddedLayerSpecTemplate<LineLayerSpecification>,
        >;
        routeFerrySymbol?: Partial<
            ToBeAddedLayerSpecTemplate<SymbolLayerSpecification>,
        >;
    } & HasAdditionalLayersConfig;
    tollRoad?: {
        routeTollRoadOutline?: Partial<
            ToBeAddedLayerSpecTemplate<LineLayerSpecification>,
        >;
        routeTollRoadSymbol?: Partial<
            ToBeAddedLayerSpecTemplate<SymbolLayerSpecification>,
        >;
    } & HasAdditionalLayersConfig;
    traffic?: {
        routeIncidentBackgroundLine?: Partial<
            ToBeAddedLayerSpecTemplate<LineLayerSpecification>,
        >;
        routeIncidentCauseSymbol?: Partial<
            ToBeAddedLayerSpecTemplate<SymbolLayerSpecification>,
        >;
        routeIncidentDashedLine?: Partial<
            ToBeAddedLayerSpecTemplate<LineLayerSpecification>,
        >;
        routeIncidentJamSymbol?: Partial<
            ToBeAddedLayerSpecTemplate<SymbolLayerSpecification>,
        >;
    } & HasAdditionalLayersConfig;
    tunnel?: {
        routeTunnelLine?: Partial<
            ToBeAddedLayerSpecTemplate<LineLayerSpecification>,
        >;
    } & HasAdditionalLayersConfig;
    vehicleRestricted?: {
        routeVehicleRestrictedBackgroundLine?: Partial<
            ToBeAddedLayerSpecTemplate<LineLayerSpecification>,
        >;
        routeVehicleRestrictedForegroundLine?: Partial<
            ToBeAddedLayerSpecTemplate<LineLayerSpecification>,
        >;
    } & HasAdditionalLayersConfig;
}

Layer specifications for route sections, keyed by section type.

Type Declaration

Optionalferry?: {
    routeFerryLine?: Partial<
        ToBeAddedLayerSpecTemplate<LineLayerSpecification>,
    >;
    routeFerrySymbol?: Partial<
        ToBeAddedLayerSpecTemplate<SymbolLayerSpecification>,
    >;
} & HasAdditionalLayersConfig

Ferry crossing section layers.

Remarks
Styles the portions of the route that involve ferry transportation.
OptionaltollRoad?: {
    routeTollRoadOutline?: Partial<
        ToBeAddedLayerSpecTemplate<LineLayerSpecification>,
    >;
    routeTollRoadSymbol?: Partial<
        ToBeAddedLayerSpecTemplate<SymbolLayerSpecification>,
    >;
} & HasAdditionalLayersConfig

Layers for the tollRoad section type.

Remarks
Marks the stretches of the route that cost money to drive, by any charging scheme: per-use tolls, motorways that need a vignette, and urban road-charge zones.
Optionaltraffic?: {
    routeIncidentBackgroundLine?: Partial<
        ToBeAddedLayerSpecTemplate<LineLayerSpecification>,
    >;
    routeIncidentCauseSymbol?: Partial<
        ToBeAddedLayerSpecTemplate<SymbolLayerSpecification>,
    >;
    routeIncidentDashedLine?: Partial<
        ToBeAddedLayerSpecTemplate<LineLayerSpecification>,
    >;
    routeIncidentJamSymbol?: Partial<
        ToBeAddedLayerSpecTemplate<SymbolLayerSpecification>,
    >;
} & HasAdditionalLayersConfig

Traffic incident section layers.

Remarks
Highlights route segments affected by traffic incidents or disruptions.
Optionaltunnel?: {
    routeTunnelLine?: Partial<
        ToBeAddedLayerSpecTemplate<LineLayerSpecification>,
    >;
} & HasAdditionalLayersConfig

Tunnel section layers.

Remarks
Highlights route segments that pass through tunnels.
OptionalvehicleRestricted?: {
    routeVehicleRestrictedBackgroundLine?: Partial<
        ToBeAddedLayerSpecTemplate<LineLayerSpecification>,
    >;
    routeVehicleRestrictedForegroundLine?: Partial<
        ToBeAddedLayerSpecTemplate<LineLayerSpecification>,
    >;
} & HasAdditionalLayersConfig

Vehicle-restricted section layers.

Remarks
Indicates route segments with vehicle access restrictions.

Remarks

Each section is a subset of the route path, and every type the module draws has an entry here — the same vocabulary as the semantic sections config, one tier down. This is the escape hatch: use it when the knobs on sections are not enough and you need full MapLibre control over the layers a section is drawn with.

The generated types carry a line layer, and an icon layer once sections.<type>.icon asks for one. The remaining five draw themselves with the hand-written layers documented below.

`Optional`summaryBubbles

summaryBubbles?: {
    routeSummaryBubbleSymbol?: Partial<
        ToBeAddedLayerSpecTemplate<SymbolLayerSpecification>,
    >;
} & HasAdditionalLayersConfig

Route summary information bubble layers.

Type Declaration

OptionalrouteSummaryBubbleSymbol?: Partial<ToBeAddedLayerSpecTemplate<SymbolLayerSpecification>>

Symbol layer for the route summary bubble icon and label.

Remarks
Use this layer to style the small summary popups or badges shown on the route.

Remarks

Displays summary information (e.g., total distance, estimated time) for the route.

`Optional`waypoints

waypoints?: {
    routeWaypointLabel?: Partial<
        ToBeAddedLayerSpecTemplate<SymbolLayerSpecification>,
    >;
    routeWaypointSymbol?: Partial<
        ToBeAddedLayerSpecTemplate<SymbolLayerSpecification>,
    >;
} & HasAdditionalLayersConfig

Waypoint layer specifications.

Type Declaration

OptionalrouteWaypointLabel?: Partial<ToBeAddedLayerSpecTemplate<SymbolLayerSpecification>>

Symbol layer for waypoint labels displayed next to waypoint icons.

Remarks
Controls label text, font, and offset for waypoint annotations.
OptionalrouteWaypointSymbol?: Partial<ToBeAddedLayerSpecTemplate<SymbolLayerSpecification>>

Symbol layer for waypoint icons (origin, destination, stops).

Remarks
Customize icons, sizes, and placement for waypoints using this layer.

Remarks

Controls the appearance of waypoint icons (origin, destination, and intermediate stops) and their labels along the route.

Type Alias RouteLayersConfig

Remarks

Index

Properties

Properties

OptionalchargingStops

Type Declaration

OptionalrouteChargingStopSymbol?: Partial<ToBeAddedLayerSpecTemplate<SymbolLayerSpecification>>

Remarks

Remarks

OptionalinstructionArrows

Type Declaration

OptionalrouteInstructionArrowSymbol?: Partial<ToBeAddedLayerSpecTemplate<SymbolLayerSpecification>>

Remarks

Remarks

OptionalinstructionLines

Type Declaration

OptionalrouteInstructionLine?: Partial<ToBeAddedLayerSpecTemplate<LineLayerSpecification>>

Remarks

OptionalrouteInstructionOutline?: Partial<ToBeAddedLayerSpecTemplate<LineLayerSpecification>>

Remarks

Remarks

OptionalmainLines

Type Declaration

OptionalrouteDeselectedLine?: Partial<ToBeAddedLayerSpecTemplate<LineLayerSpecification>>

Remarks

OptionalrouteDeselectedOutline?: Partial<ToBeAddedLayerSpecTemplate<LineLayerSpecification>>

Remarks

OptionalrouteLine?: Partial<ToBeAddedLayerSpecTemplate<LineLayerSpecification>>

Remarks

OptionalrouteLineArrows?: Partial<ToBeAddedLayerSpecTemplate<SymbolLayerSpecification>>

Remarks

OptionalrouteOutline?: Partial<ToBeAddedLayerSpecTemplate<LineLayerSpecification>>

Remarks

Remarks

Optionalsections

Type Declaration

Optionalferry?: { routeFerryLine?: Partial< ToBeAddedLayerSpecTemplate<LineLayerSpecification>, >; routeFerrySymbol?: Partial< ToBeAddedLayerSpecTemplate<SymbolLayerSpecification>, >;} & HasAdditionalLayersConfig

Remarks

OptionaltollRoad?: { routeTollRoadOutline?: Partial< ToBeAddedLayerSpecTemplate<LineLayerSpecification>, >; routeTollRoadSymbol?: Partial< ToBeAddedLayerSpecTemplate<SymbolLayerSpecification>, >;} & HasAdditionalLayersConfig

Remarks

Remarks

Optionaltunnel?: { routeTunnelLine?: Partial< ToBeAddedLayerSpecTemplate<LineLayerSpecification>, >;} & HasAdditionalLayersConfig

Remarks

OptionalvehicleRestricted?: { routeVehicleRestrictedBackgroundLine?: Partial< ToBeAddedLayerSpecTemplate<LineLayerSpecification>, >; routeVehicleRestrictedForegroundLine?: Partial< ToBeAddedLayerSpecTemplate<LineLayerSpecification>, >;} & HasAdditionalLayersConfig

Remarks

Remarks

OptionalsummaryBubbles

Type Declaration

OptionalrouteSummaryBubbleSymbol?: Partial<ToBeAddedLayerSpecTemplate<SymbolLayerSpecification>>

Remarks

Remarks

Optionalwaypoints

Type Declaration

OptionalrouteWaypointLabel?: Partial<ToBeAddedLayerSpecTemplate<SymbolLayerSpecification>>

Remarks

OptionalrouteWaypointSymbol?: Partial<ToBeAddedLayerSpecTemplate<SymbolLayerSpecification>>

Remarks

Remarks

Settings

On This Page

`Optional`chargingStops

`Optional`routeChargingStopSymbol?: Partial<ToBeAddedLayerSpecTemplate<SymbolLayerSpecification>>

`Optional`instructionArrows

`Optional`routeInstructionArrowSymbol?: Partial<ToBeAddedLayerSpecTemplate<SymbolLayerSpecification>>

`Optional`instructionLines

`Optional`routeInstructionLine?: Partial<ToBeAddedLayerSpecTemplate<LineLayerSpecification>>

`Optional`routeInstructionOutline?: Partial<ToBeAddedLayerSpecTemplate<LineLayerSpecification>>

`Optional`mainLines

`Optional`routeDeselectedLine?: Partial<ToBeAddedLayerSpecTemplate<LineLayerSpecification>>

`Optional`routeDeselectedOutline?: Partial<ToBeAddedLayerSpecTemplate<LineLayerSpecification>>

`Optional`routeLine?: Partial<ToBeAddedLayerSpecTemplate<LineLayerSpecification>>

`Optional`routeLineArrows?: Partial<ToBeAddedLayerSpecTemplate<SymbolLayerSpecification>>

`Optional`routeOutline?: Partial<ToBeAddedLayerSpecTemplate<LineLayerSpecification>>

`Optional`sections

`Optional`ferry?: {
routeFerryLine?: Partial<
ToBeAddedLayerSpecTemplate<LineLayerSpecification>,
>;
routeFerrySymbol?: Partial<
ToBeAddedLayerSpecTemplate<SymbolLayerSpecification>,
>;
} & HasAdditionalLayersConfig

`Optional`tollRoad?: {
routeTollRoadOutline?: Partial<
ToBeAddedLayerSpecTemplate<LineLayerSpecification>,
>;
routeTollRoadSymbol?: Partial<
ToBeAddedLayerSpecTemplate<SymbolLayerSpecification>,
>;
} & HasAdditionalLayersConfig

`Optional`tunnel?: {
routeTunnelLine?: Partial<
ToBeAddedLayerSpecTemplate<LineLayerSpecification>,
>;
} & HasAdditionalLayersConfig

`Optional`vehicleRestricted?: {
routeVehicleRestrictedBackgroundLine?: Partial<
ToBeAddedLayerSpecTemplate<LineLayerSpecification>,
>;
routeVehicleRestrictedForegroundLine?: Partial<
ToBeAddedLayerSpecTemplate<LineLayerSpecification>,
>;
} & HasAdditionalLayersConfig

`Optional`summaryBubbles

`Optional`routeSummaryBubbleSymbol?: Partial<ToBeAddedLayerSpecTemplate<SymbolLayerSpecification>>

`Optional`waypoints

`Optional`routeWaypointLabel?: Partial<ToBeAddedLayerSpecTemplate<SymbolLayerSpecification>>

`Optional`routeWaypointSymbol?: Partial<ToBeAddedLayerSpecTemplate<SymbolLayerSpecification>>