Interface: ProximityResult

Defined in: spec/types.proximity.ts:27

One place a ProximitySearch found.

Properties

categoryId?

optional categoryId?: string

Defined in: spec/types.proximity.ts:39

The ProximityCategory.id the place belongs to, which gives its pin a colour and an icon. Omitted, or naming no declared category, the pin is drawn in the neutral colour with no icon.

---

id

id: string | number

Defined in: spec/types.proximity.ts:29

Unique among the answers of one search; keys the result on screen.

---

lngLat

lngLat: [number, number]

Defined in: spec/types.proximity.ts:31

Where the place is, [lng, lat].

---

name

name: string

Defined in: spec/types.proximity.ts:33

The place's name, shown when the reader opens its card.