Skip to main content

Class: MapNearestWaypointsLayerSearch<S>

Defined in: src/sdk/components/map/layers/MapNearestWaypointsLayer.tsx:518

A nearest facility search for MapAbstractNearestWaypointsLayer.

Type Parameters

Type ParameterDefault type
S extends NearestSearchSession<string, string>NearestSearchSession<string, string>

Constructors

Constructor

new MapNearestWaypointsLayerSearch<S>(session, refreshCallback): MapNearestWaypointsLayerSearch<S>

Defined in: src/sdk/components/map/layers/MapNearestWaypointsLayer.tsx:548

Constructor.

Parameters

ParameterTypeDescription
sessionSThe session used by this search.
refreshCallback(results) => voidA callback which is called every time the search refreshes.

Returns

MapNearestWaypointsLayerSearch<S>

Accessors

lastCenter

Get Signature

get lastCenter(): GeoPointReadOnly

Defined in: src/sdk/components/map/layers/MapNearestWaypointsLayer.tsx:531

The center of this search's last refresh.

Returns

GeoPointReadOnly


lastRadius

Get Signature

get lastRadius(): number

Defined in: src/sdk/components/map/layers/MapNearestWaypointsLayer.tsx:539

The radius of this search's last refresh, in great-arc radians.

Returns

number

Methods

scheduleRefresh()

scheduleRefresh(center, radius, maxItemCount, delay): void

Defined in: src/sdk/components/map/layers/MapNearestWaypointsLayer.tsx:562

Schedules a refresh of this search. If a refresh was previously scheduled but not yet executed, this new scheduled refresh will replace the old one.

Parameters

ParameterTypeDescription
centerLatLonInterfaceThe center of the search area.
radiusnumberThe radius of the search area, in great-arc radians.
maxItemCountnumberThe maximum number of results returned by the refresh.
delaynumberThe delay, in milliseconds, before the refresh is executed.

Returns

void


update()

update(elapsed): void

Defined in: src/sdk/components/map/layers/MapNearestWaypointsLayer.tsx:577

Updates this search. Executes any pending refreshes if their delay timers have expired.

Parameters

ParameterTypeDescription
elapsednumberThe elapsed time, in milliseconds, since the last update.

Returns

void