MapComplete/Docs/builtin_units.md

Units

Table of contents

1. Units

• How to use

2. Rendering
3. Usage

• unit
  • power
    • MW
    • kW
    • W
    • GW
  • voltage
    • V
  • current
    • A
  • distance
    • m
    • cm
    • mm
    • ft
  • speed
    • kmh
    • mph
  • duration
    • minutes
    • hours
    • days
    • weeks
    • months
    • years

How to use

In some cases, a value is represented in a certain unit (such as meters for heigt/distance/..., km/h for speed, ...)

Sometimes, multiple denominations are possible (e.g. km/h vs mile/h; megawatt vs kilowatt vs gigawatt for power generators, ...)

This brings in some troubles, as there are multiple ways to write it (no denomitation, 'm' vs 'meter' 'metre', ...)

Not only do we want to write consistent data to OSM, we also want to present this consistently to the user. This is handled by defining units.

Rendering

To render a value with long (human) denomination, use {canonical(key)}

Usage

First of all, you define which keys have units applied, for example:

units: [
 appliesTo: ["maxspeed", "maxspeed:hgv", "maxspeed:bus"]
 applicableUnits: [
     ...
 ]
]

ApplicableUnits defines which is the canonical extension, how it is presented to the user, ...:

applicableUnits: [
{
    canonicalDenomination: "km/h",
    alternativeDenomination: ["km/u", "kmh", "kph"]
    default: true,
    human: {
        en: "kilometer/hour",
        nl: "kilometer/uur"
    },
    humanShort: {
        en: "km/h",
        nl: "km/u"
    }
},
{
    canoncialDenomination: "mph",
    ... similar for miles an hour ...
}
]

If this is defined, then every key which the denominations apply to (maxspeed, maxspeed:hgv and maxspeed:bus) will be rewritten at the metatagging stage: every value will be parsed and the canonical extension will be added add presented to the other parts of the code.

Also, if a freeform text field is used, an extra dropdown with applicable denominations will be given

Units

unit

power

MW

Alternative denominations:

• megawatts
• megawatt

kW

Alternative denominations:

• kilowatts
• kilowatt

W

Alternative denominations:

• watts
• watt

GW

Alternative denominations:

• gigawatts
• gigawatt

voltage

V

Alternative denominations:

• v
• volt
• voltage
• Volt

current

A

Alternative denominations:

• a
• amp
• amperage
• A

distance

m

Default denomination

Alternative denominations:

• meter
• meters

cm

Alternative denominations:

• centimeter
• centimeters
• cms

mm

Alternative denominations:

• millimeter
• millimeters

ft

Alternative denominations:

• feet
• voet

speed

kmh

Alternative denominations:

• km/u
• km/h
• kph

mph

Default denomination in the following countries:

• gb
• us

Alternative denominations:

• m/u
• mh
• m/ph

duration

minutes

Alternative denominations:

• m
• min
• mins
• minuten
• mns

hours

Alternative denominations:

• h
• hrs
• hours
• u
• uur
• uren

days

Alternative denominations:

• dys
• dagen
• dag

weeks

months

years

This document is autogenerated from assets/layers/unit/unit.json, src/Models/ThemeConfig/Json/UnitConfigJson.ts