Class: MapNearestWaypointsLayerSearch<S>
A nearest facility search for MapAbstractNearestWaypointsLayer.
Type parameters
| Name | Type |
|---|---|
S | extends NearestSearchSession<string, string> = NearestSearchSession<string, string> |
Constructors
constructor
• new MapNearestWaypointsLayerSearch<S>(session, refreshCallback): MapNearestWaypointsLayerSearch<S>
Constructor.
Type parameters
| Name | Type |
|---|---|
S | extends NearestSearchSession<string, string> = NearestSearchSession<string, string> |
Parameters
| Name | Type | Description |
|---|---|---|
session | S | The session used by this search. |
refreshCallback | (results: NearestSearchResults<string, string>) => void | A callback which is called every time the search refreshes. |
Returns
MapNearestWaypointsLayerSearch<S>
Defined in
src/sdk/components/map/layers/MapNearestWaypointsLayer.tsx:548
Accessors
lastCenter
• get lastCenter(): GeoPointReadOnly
The center of this search's last refresh.
Returns
Defined in
src/sdk/components/map/layers/MapNearestWaypointsLayer.tsx:531
lastRadius
• get lastRadius(): number
The radius of this search's last refresh, in great-arc radians.
Returns
number
Defined in
src/sdk/components/map/layers/MapNearestWaypointsLayer.tsx:539
Methods
scheduleRefresh
▸ scheduleRefresh(center, radius, maxItemCount, delay): void
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
| Name | 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
Defined in
src/sdk/components/map/layers/MapNearestWaypointsLayer.tsx:562
update
▸ update(elapsed): void
Updates this search. Executes any pending refreshes if their delay timers have expired.
Parameters
| Name | Type | Description |
|---|---|---|
elapsed | number | The elapsed time, in milliseconds, since the last update. |
Returns
void
Defined in
src/sdk/components/map/layers/MapNearestWaypointsLayer.tsx:577