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

    Type Alias DistanceUnitsType

    DistanceUnitsType: "metric" | "imperial_us" | "imperial_uk"

    The distance unit systems the SDK formatters support.

    It sets the measurement system for formatting distances. Each system uses region-appropriate units and conventions.

    • metric: International System (SI), used in most of the world (Europe, Asia, Africa, South America, Australia). It uses meters (m) and kilometers (km), decimal-based with no fractions.
    • imperial_us: United States customary units, used in the United States. It uses feet (ft) for short distances (< 0.125 mi), and miles (mi) with fractions (¼, ½, ¾) for longer ones.
    • imperial_uk: United Kingdom imperial units, used in the United Kingdom. It uses yards (yd) for short distances (< 0.125 mi), and miles (mi) with fractions (¼, ½, ¾) for longer ones.
    const system: DistanceUnitsType = 'metric';      // International
    const usSystem: DistanceUnitsType = 'imperial_us'; // United States
    const ukSystem: DistanceUnitsType = 'imperial_uk'; // United Kingdom