Skip to main content

Interface: ProximityQueryParams

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

What ProximitySearch.query is asked: the point the reader searched from and the ring to search, in metres.

The first search asks for the whole disc (radiusMin is 0); widening the radius afterwards asks only for the ring the earlier answers do not cover, from the radius already searched (radiusMin) out to the new one, so a service never comes back twice.

Properties​

lat​

lat: number

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

Latitude of the searched point.

lng​

lng: number

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

Longitude of the searched point.

radius​

radius: number

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

Outer edge of the ring, in metres.

radiusMin​

radiusMin: number

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

Inner edge of the ring, in metres: 0 for the first search.

signal​

signal: AbortSignal

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

Aborted when the search this answer belongs to is no longer current — the reader cleared it or started another — so the request can be cancelled.