Class: NearestAirportSearchSession
Defined in: src/sdk/navigation/FacilityLoader.ts:758
A session for searching for nearest airports.
Extends
CoherentNearestSearchSession
<string
,string
>
Constructors
Constructor
new NearestAirportSearchSession(
sessionId
):NearestAirportSearchSession
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
NearestAirportSearchSession
Inherited from
CoherentNearestSearchSession<string, string>.constructor
Properties
sessionId
protected
readonly
sessionId:number
Defined in: src/sdk/navigation/FacilityLoader.ts:727
The ID of the session.
Inherited from
CoherentNearestSearchSession.sessionId
Defaults
static
Defaults:object
Defined in: src/sdk/navigation/FacilityLoader.ts:762
Default filters for the nearest airports search session.
ApproachTypeMask
ApproachTypeMask:
number
=2147483647
ClassMask
ClassMask:
number
MinimumRunwayLength
MinimumRunwayLength:
number
=0
ShowClosed
ShowClosed:
boolean
=false
SurfaceTypeMask
SurfaceTypeMask:
number
=2147483647
ToweredMask
ToweredMask:
number
=3
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 <string , string > | The search results. |
Returns
void
Inherited from
CoherentNearestSearchSession.onSearchCompleted
searchNearest()
searchNearest(
lat
,lon
,radius
,maxItems
):Promise
<NearestSearchResults
<string
,string
>>
Defined in: src/sdk/navigation/FacilityLoader.ts:730
Parameters
Parameter | Type |
---|---|
lat | number |
lon | number |
radius | number |
maxItems | number |
Returns
Promise
<NearestSearchResults
<string
, string
>>
Inherit Doc
Inherited from
CoherentNearestSearchSession.searchNearest
setAirportFilter()
setAirportFilter(
showClosed
,classMask
):void
Defined in: src/sdk/navigation/FacilityLoader.ts:782
Sets the filter for the airport nearest search.
Parameters
Parameter | Type | Description |
---|---|---|
showClosed | boolean | Whether or not to show closed airports. |
classMask | number | A bitmask to determine which JS airport classes to show. |
Returns
void
setExtendedAirportFilters()
setExtendedAirportFilters(
surfaceTypeMask
,approachTypeMask
,toweredMask
,minRunwayLength
):void
Defined in: src/sdk/navigation/FacilityLoader.ts:793
Sets the extended airport filters for the airport nearest search.
Parameters
Parameter | Type | Description |
---|---|---|
surfaceTypeMask | number | A bitmask of allowable runway surface types. |
approachTypeMask | number | A bitmask of allowable approach types. |
toweredMask | number | A bitmask of untowered (1) or towered (2) bits. |
minRunwayLength | number | The minimum allowable runway length, in meters. |
Returns
void