Class: NearestAirportSearchSession<IcaoDataType>
Defined in: src/sdk/navigation/FacilityLoader.ts:1086
A session for searching for nearest airports.
Extends
CoherentIcaoNearestSearchSession
<IcaoDataType
>
Type Parameters
Type Parameter |
---|
IcaoDataType extends NearestIcaoSearchSessionDataType |
Implements
NearestAirportFilteredSearchSession
<IcaoDataType
>
Constructors
Constructor
new NearestAirportSearchSession<
IcaoDataType
>(sessionId
,icaoDataType
):NearestAirportSearchSession
<IcaoDataType
>
Defined in: src/sdk/navigation/FacilityLoader.ts:1078
Creates an instance of a CoherentIcaoNearestSearchSession.
Parameters
Parameter | Type | Description |
---|---|---|
sessionId | number | The ID of the session. |
icaoDataType | IcaoDataType | The data type of the ICAOs provided by this session. |
Returns
NearestAirportSearchSession
<IcaoDataType
>
Inherited from
CoherentIcaoNearestSearchSession<IcaoDataType>.constructor
Properties
icaoDataType
readonly
icaoDataType:IcaoDataType
Defined in: src/sdk/navigation/FacilityLoader.ts:1078
The data type of the ICAOs provided by this session.
Implementation of
NearestAirportFilteredSearchSession
.icaoDataType
Inherited from
CoherentIcaoNearestSearchSession.icaoDataType
sessionId
protected
readonly
sessionId:number
Defined in: src/sdk/navigation/FacilityLoader.ts:1004
The ID of the session.
Inherited from
CoherentIcaoNearestSearchSession.sessionId
Defaults
readonly
static
Defaults:object
Defined in: src/sdk/navigation/FacilityLoader.ts:1093
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:1024
A callback called by the facility loader when a nearest search has completed.
Parameters
Parameter | Type | Description |
---|---|---|
results | NearestSearchResults <NearestIcaoSearchSessionDataTypeMap [IcaoDataType ], NearestIcaoSearchSessionDataTypeMap [IcaoDataType ]> | The search results. |
Returns
void
Inherited from
CoherentIcaoNearestSearchSession.onSearchCompleted
searchNearest()
searchNearest(
lat
,lon
,radius
,maxItems
):Promise
<NearestSearchResults
<NearestIcaoSearchSessionDataTypeMap
[IcaoDataType
],NearestIcaoSearchSessionDataTypeMap
[IcaoDataType
]>>
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
<NearestIcaoSearchSessionDataTypeMap
[IcaoDataType
], NearestIcaoSearchSessionDataTypeMap
[IcaoDataType
]>>
The nearest search results.
Implementation of
NearestAirportFilteredSearchSession
.searchNearest
Inherited from
CoherentIcaoNearestSearchSession.searchNearest
setAirportFilter()
setAirportFilter(
showClosed
,classMask
):void
Defined in: src/sdk/navigation/FacilityLoader.ts:1113
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
Implementation of
NearestAirportFilteredSearchSession
.setAirportFilter
setExtendedAirportFilters()
setExtendedAirportFilters(
surfaceTypeMask
,approachTypeMask
,toweredMask
,minRunwayLength
):void
Defined in: src/sdk/navigation/FacilityLoader.ts:1124
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
Implementation of
NearestAirportFilteredSearchSession
.setExtendedAirportFilters