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

    Type Alias SectionSignConfig

    The sign a section type posts its own value on.

    speedLimit is the one type that takes this, and a sign is the whole of what it draws — there is no line along the stretch, because a line would mark every stretch that carries a limit without ever saying what the limit is. SectionDisplayConfig.visible switches the signs themselves.

    The sign follows the road rather than the reader. Where the route also carries country sections, each sign takes the face, the unit and the numeral colour of the country its stretch runs through: the white disc most of Europe posts on, the yellow one Sweden, Finland and Iceland use, the SPEED LIMIT plaque of the United States, and Japan's blue numerals. A country with no entry posts the white disc in km/h.

    Where mph is posted the number is converted and rounded to the step signs come in. Without country sections the display units decide the face and the unit, and an explicit unit overrides both.

    Signs scale with the zoom, as the ferry and toll-road icons do; minzoom decides how early they appear at all.

    type SectionSignConfig = {
        minzoom?: number;
        priority?: SectionSignPriority;
        unit?: SectionSignUnit;
    }
    Index
    minzoom?: number

    The lowest zoom the signs are drawn at.

    9, the zoom at which a sign is about a stretch of road a reader can see. Over
    a whole country the stretches fall in the same few pixels, so the few signs that survive the
    collision are an arbitrary sample rather than the limits of the drive.

    Whether a sign gives way to the other icons the route draws, or takes precedence over them.

    'belowRouteIcons'

    The unit every sign reads in, whatever the road posts.

    Left out, each sign follows its own country, or the display units where the route carries no country sections.