Skip to main content

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

Constructors

Constructor

new NearestAirportSearchSession<IcaoDataType>(sessionId, icaoDataType): NearestAirportSearchSession<IcaoDataType>

Defined in: src/sdk/navigation/FacilityLoader.ts:1078

Creates an instance of a CoherentIcaoNearestSearchSession.

Parameters

ParameterTypeDescription
sessionIdnumberThe ID of the session.
icaoDataTypeIcaoDataTypeThe 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

ParameterTypeDescription
resultsNearestSearchResults<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

ParameterTypeDescription
latnumberThe latitude, in degrees.
lonnumberThe longitude, in degrees.
radiusnumberThe radius around the point to search, in meters.
maxItemsnumberThe 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

ParameterTypeDescription
showClosedbooleanWhether or not to show closed airports.
classMasknumberA 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

ParameterTypeDescription
surfaceTypeMasknumberA bitmask of allowable runway surface types.
approachTypeMasknumberA bitmask of allowable approach types.
toweredMasknumberA bitmask of untowered (1) or towered (2) bits.
minRunwayLengthnumberThe minimum allowable runway length, in meters.

Returns

void

Implementation of

NearestAirportFilteredSearchSession.setExtendedAirportFilters