TomTom Maps for JavaScript
    Preparing search index...

    Type Alias DistanceUnitsType

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

    Distance unit system types supported by the SDK formatters.

    Defines which measurement system to use when formatting distances. Each system uses region-appropriate units and conventions.

    Unit Systems:

    • metric: International System (SI)

      • Units: meters (m), kilometers (km)
      • Used in: Most of the world (Europe, Asia, Africa, South America, Australia)
      • Decimal-based, no fractions
    • imperial_us: United States customary units

      • Units: feet (ft), miles (mi)
      • Used in: United States
      • Uses fractions for miles (¼, ½, ¾)
      • Feet for short distances (< 0.125 mi)
    • imperial_uk: United Kingdom imperial units

      • Units: yards (yd), miles (mi)
      • Used in: United Kingdom
      • Uses fractions for miles (¼, ½, ¾)
      • Yards for short distances (< 0.125 mi)

    Differences:

    • US uses feet for short distances
    • UK uses yards for short distances
    • Both use miles with fractions for medium/long distances
    const system: DistanceUnitsType = 'metric';      // International
    const usSystem: DistanceUnitsType = 'imperial_us'; // United States
    const ukSystem: DistanceUnitsType = 'imperial_uk'; // United Kingdom