TomTom Maps for JavaScript
    Preparing search index...

    Type Alias RouteProps

    Properties object for a calculated route.

    Contains all route information including summary statistics, sections, guidance instructions, and progress data.

    type RouteProps = {
        guidance?: Guidance;
        index: number;
        progress?: RouteProgress;
        sections: SectionsProps;
        summary: RouteSummary;
    }
    Index

    Properties

    guidance?: Guidance

    Turn-by-turn navigation instructions.

    Only present when guidance was requested and is available. Includes maneuvers, road names, and instruction text.

    index: number

    Index of this route in the collection of alternatives.

    The first route (index 0) is typically the recommended/best route. Subsequent indices represent alternative routes.

    progress?: RouteProgress

    Distance and time progress at key points along the route.

    Only present when extended route representations are requested. Useful for displaying progress information or calculating intermediate times.

    sections: SectionsProps

    Route sections with specific characteristics.

    Sections represent portions of the route with distinct properties such as:

    • Countries traversed
    • Traffic incidents
    • Route legs (segments between waypoints)
    • Special road types (tunnels, ferries, toll roads)
    summary: RouteSummary

    Summary statistics for the entire route.

    Contains departure/arrival times, total length, duration, and consumption estimates.