Reference · Markers on the globe
chooseHereCityfunction
The city to draw: the nearest of the coarse hit and the towns, and only when it is within maxKm. A town closer than the big city wins.
Import it
import { chooseHereCity } from "@johnmorrisdotca/chikyu-earth/markers";Definition
function chooseHereCity(point: { lat: number; lon: number; }, coarse: { city: { id: string; name: { en: string; ja?: string; jaShort?: string; }; }; km: number; } | null, towns: readonly HereTown[], maxKm: number): { id: string; name: HereTown["name"]; km: number; } | nullParameters
| Name | Type | Description |
|---|---|---|
point | { lat: number; lon: number; } | The place. |
coarse | { city: { id: string; name: { en: string; ja?: string; jaShort?: string; }; }; km: number; } | null | The nearest city of the three tiers inside the limit, or null. |
towns | readonly HereTown[] | The cities of the one or two countries read for this place. |
maxKm | number | The limit, in kilometres. |
Returns
{ id: string; name: HereTown["name"]; km: number; } | null
The city and its distance, or null when none is close enough.
Examples
import { chooseHereCity } from "@johnmorrisdotca/chikyu-earth/markers";
const town = { id: "v", name: { en: "Village" }, lat: 0.05, lon: 0 };
const chosen = chooseHereCity({ lat: 0, lon: 0 }, { city: { id: "c", name: { en: "City" } }, km: 40 }, [town], 100);
console.log(chosen?.id);vWhat it prints (run when this page was built)