TomTom Maps for JavaScript
    Preparing search index...

    Type Alias ImportantRoad

    ImportantRoad: Pick<ImportantRoadStretchProps, "index" | "streetName"> & {
        lengthInMeters: number;
        name?: string;
        roadNumbers: string[];
        sections: ImportantRoadStretchProps[];
    }

    A road a route takes, as its important road stretches name it.

    Type Declaration

    • lengthInMeters: number

      How far the route follows it, counting only the parts within the sections asked about.

    • Optionalname?: string

      What a driver calls it: its first road number, else its street name. Absent when it has neither.

    • roadNumbers: string[]

      Its road numbers, those of its stretches in turn, each sorted in descending order of display priority. Empty when it has none.

    • sections: ImportantRoadStretchProps[]

      The route's important road stretch sections on it, in order along the route.

    Its index is that of its most important stretch: the lower, the more important. Its streetName is the first one its stretches carry.