Class: NearestBoundarySearchSession
Defined in: src/sdk/navigation/FacilityLoader.ts:1199
A session for searching for nearest airspace boundaries.
Extends
CoherentNearestSearchSession
<BoundaryFacility
,number
>
Implements
Constructors
Constructor
new NearestBoundarySearchSession(
sessionId
):NearestBoundarySearchSession
Defined in: src/sdk/navigation/FacilityLoader.ts:1004
Creates an instance of a CoherentNearestSearchSession.
Parameters
Parameter | Type | Description |
---|---|---|
sessionId | number | The ID of the session. |
Returns
NearestBoundarySearchSession
Inherited from
CoherentNearestSearchSession<BoundaryFacility, number>.constructor
Properties
sessionId
protected
readonly
sessionId:number
Defined in: src/sdk/navigation/FacilityLoader.ts:1004
The ID of the session.
Inherited from
CoherentNearestSearchSession.sessionId
Methods
onSearchCompleted()
onSearchCompleted(
results
):void
Defined in: src/sdk/navigation/FacilityLoader.ts:1024
A callback called by the facility loader when a nearest search has completed.
Parameters
Parameter | Type | Description |
---|---|---|
results | NearestSearchResults <BoundaryFacility , number > | The search results. |
Returns
void
Inherited from
CoherentNearestSearchSession.onSearchCompleted
searchNearest()
searchNearest(
lat
,lon
,radius
,maxItems
):Promise
<NearestSearchResults
<BoundaryFacility
,number
>>
Defined in: src/sdk/navigation/FacilityLoader.ts:1007
Searches for nearest facilities from the specified point.
Parameters
Parameter | Type | Description |
---|---|---|
lat | number | The latitude, in degrees. |
lon | number | The longitude, in degrees. |
radius | number | The radius around the point to search, in meters. |
maxItems | number | The maximum number of items. |
Returns
Promise
<NearestSearchResults
<BoundaryFacility
, number
>>
The nearest search results.
Implementation of
NearestBoundaryFilteredSearchSession
.searchNearest
Inherited from
CoherentNearestSearchSession.searchNearest
setBoundaryFilter()
setBoundaryFilter(
classMask
):void
Defined in: src/sdk/navigation/FacilityLoader.ts:1207
Sets the filter for the boundary nearest search.
Parameters
Parameter | Type | Description |
---|---|---|
classMask | number | A bitmask to determine which boundary classes to show. |
Returns
void