This is the documentation of version 1.0.0-rc.1. Go to the latest version, 1.0.0-rc.5.
TomTom Maps for JavaScript
    Preparing search index...

    Type Alias SectionsProps

    The sections of a route, the parts of it with specific characteristics, such as stretches on a ferry or motorway or with traffic incidents. With sections, you can show users where these lie on a planned route.

    Index
    carpool?: SectionProps[]

    Stretches reserved for carpool (high-occupancy) vehicles.

    carTrain?: SectionProps[]

    Stretches travelled on a car train, where the vehicle is carried by rail.

    One section per country the route passes through, each naming that country.

    ferry?: SectionProps[]

    Stretches travelled by ferry.

    importantRoadStretch?: ImportantRoadStretchProps[]

    Stretches whose street name or road numbers identify the course of the route.

    The lane configuration sections. They are present only when guidance was requested and, if sectionTypes was a list, only if it included lanes.

    One section per leg of the route, always present because every route has at least one leg.

    lowEmissionZone?: SectionProps[]

    Stretches inside a low-emission zone, which a vehicle may need to qualify to enter.

    motorway?: SectionProps[]

    Stretches on a motorway.

    pedestrian?: SectionProps[]

    Stretches travelled on foot.

    roadShields?: RoadShieldSectionProps[]

    Stretches carrying road shields, for rendering route numbers along the route.

    speedLimit?: SpeedLimitSectionProps[]

    Stretches with a known maximum speed limit.

    toll?: SectionProps[]

    Stretches where a per-use road toll is charged, on a ticket or barrier motorway or at a free-flow tolling point.

    It is a subset of tollRoad, so every stretch reported here is also reported there. Use toll for "will this route cost a toll to drive", and tollRoad for "does this route cost anything at all to drive". tollRoad also covers vignette-only motorways and urban charge zones, which carry no per-use toll.

    To request it, set sectionTypes: ['toll'].

    tollRoad?: SectionProps[]

    Stretches that cost money to drive by any charging scheme, meaning per-use tolls, motorways that need a vignette and urban road-charge zones.

    It is a superset of toll. On a ticket motorway, the two report the same stretches. A vignette-only motorway or a city charge zone appears here and not in toll.

    By default, it is included, since leaving sectionTypes unset requests it. A sectionTypes list has to name 'tollRoad' to keep it.

    tollVignette?: CountrySectionProps[]

    Stretches needing a vignette, one section per country requiring one.

    Stretches affected by a traffic incident, with its delay and cause.

    tunnel?: SectionProps[]

    Stretches inside a tunnel.

    unpaved?: SectionProps[]

    Stretches on an unpaved road.

    urban?: SectionProps[]

    Stretches on urban roads.

    vehicleRestricted?: SectionProps[]

    Stretches the requested vehicle is not permitted to use.