Class: NearestBoundarySearchSession
A session for searching for nearest airspace boundaries.
Hierarchy
CoherentNearestSearchSession<BoundaryFacility,number>↳
NearestBoundarySearchSession
Constructors
constructor
• new NearestBoundarySearchSession(sessionId): NearestBoundarySearchSession
Creates an instance of a CoherentNearestSearchSession.
Parameters
| Name | Type | Description |
|---|---|---|
sessionId | number | The ID of the session. |
Returns
Inherited from
CoherentNearestSearchSession<BoundaryFacility, number>.constructor
Defined in
src/sdk/navigation/FacilityLoader.ts:727
Properties
sessionId
• Protected Readonly sessionId: number
The ID of the session.
Inherited from
CoherentNearestSearchSession.sessionId
Defined in
src/sdk/navigation/FacilityLoader.ts:727
Methods
onSearchCompleted
▸ onSearchCompleted(results): void
A callback called by the facility loader when a nearest search has completed.
Parameters
| Name | Type | Description |
|---|---|---|
results | NearestSearchResults<BoundaryFacility, number> | The search results. |
Returns
void
Inherited from
CoherentNearestSearchSession.onSearchCompleted
Defined in
src/sdk/navigation/FacilityLoader.ts:746
searchNearest
▸ searchNearest(lat, lon, radius, maxItems): Promise<NearestSearchResults<BoundaryFacility, number>>
Parameters
| Name | Type |
|---|---|
lat | number |
lon | number |
radius | number |
maxItems | number |
Returns
Promise<NearestSearchResults<BoundaryFacility, number>>
Inherit Doc
Inherited from
CoherentNearestSearchSession.searchNearest
Defined in
src/sdk/navigation/FacilityLoader.ts:730
setBoundaryFilter
▸ setBoundaryFilter(classMask): void
Sets the filter for the boundary nearest search.
Parameters
| Name | Type | Description |
|---|---|---|
classMask | number | A bitmask to determine which boundary classes to show. |
Returns
void
Defined in
src/sdk/navigation/FacilityLoader.ts:866