Class: MapNearestWaypointsLayerSearch<S>
Defined in: src/sdk/components/map/layers/MapNearestWaypointsLayer.tsx:518
A nearest facility search for MapAbstractNearestWaypointsLayer.
Type Parameters
| Type Parameter | Default 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
| Parameter | Type | Description |
|---|---|---|
session | S | The session used by this search. |
refreshCallback | (results) => void | A 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
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
| Parameter | Type | Description |
|---|---|---|
center | LatLonInterface | The center of the search area. |
radius | number | The radius of the search area, in great-arc radians. |
maxItemCount | number | The maximum number of results returned by the refresh. |
delay | number | The 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
| Parameter | Type | Description |
|---|---|---|
elapsed | number | The elapsed time, in milliseconds, since the last update. |
Returns
void