Skip to main content

Class: NearestVorSearchSession<IcaoDataType>

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

A session for searching for nearest VORs.

Extends​

  • CoherentIcaoNearestSearchSession<IcaoDataType>

Type Parameters​

Type Parameter
IcaoDataType extends NearestIcaoSearchSessionDataType

Implements​

Constructors​

Constructor​

new NearestVorSearchSession<IcaoDataType>(sessionId, icaoDataType): NearestVorSearchSession<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​

NearestVorSearchSession<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​

NearestVorFilteredSearchSession.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:1170

Default filters for the nearest VORs search session.

ClassMask​

ClassMask: number

TypeMask​

TypeMask: number

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​

NearestVorFilteredSearchSession.searchNearest

Inherited from​

CoherentIcaoNearestSearchSession.searchNearest


setVorFilter()​

setVorFilter(classMask, typeMask): void

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

Sets the filter for the VOR nearest search.

Parameters​

ParameterTypeDescription
classMasknumberA bitmask to determine which JS VOR classes to show.
typeMasknumberA bitmask to determine which JS VOR types to show.

Returns​

void

Implementation of​

NearestVorFilteredSearchSession.setVorFilter