Class: NearestBoundarySearchSession
Defined in: src/sdk/navigation/FacilityLoader.ts:861
A session for searching for nearest airspace boundaries.
Extends
CoherentNearestSearchSession<BoundaryFacility,number>
Constructors
Constructor
new NearestBoundarySearchSession(
sessionId):NearestBoundarySearchSession
Defined in: src/sdk/navigation/FacilityLoader.ts:727
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
protectedreadonlysessionId:number
Defined in: src/sdk/navigation/FacilityLoader.ts:727
The ID of the session.
Inherited from
CoherentNearestSearchSession.sessionId
Methods
onSearchCompleted()
onSearchCompleted(
results):void
Defined in: src/sdk/navigation/FacilityLoader.ts:746
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:730
Parameters
| Parameter | Type |
|---|---|
lat | number |
lon | number |
radius | number |
maxItems | number |
Returns
Promise<NearestSearchResults<BoundaryFacility, number>>
Inherit Doc
Inherited from
CoherentNearestSearchSession.searchNearest
setBoundaryFilter()
setBoundaryFilter(
classMask):void
Defined in: src/sdk/navigation/FacilityLoader.ts:866
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