Skip to main content

Class: NearestVorSearchSession

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

A session for searching for nearest VORs.

Extends

  • CoherentNearestSearchSession<string, string>

Constructors

Constructor

new NearestVorSearchSession(sessionId): NearestVorSearchSession

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

Creates an instance of a CoherentNearestSearchSession.

Parameters

ParameterTypeDescription
sessionIdnumberThe ID of the session.

Returns

NearestVorSearchSession

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:832

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:746

A callback called by the facility loader when a nearest search has completed.

Parameters

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

ParameterType
latnumber
lonnumber
radiusnumber
maxItemsnumber

Returns

Promise<NearestSearchResults<string, string>>

Inherit Doc

Inherited from

CoherentNearestSearchSession.searchNearest


setVorFilter()

setVorFilter(classMask, typeMask): void

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

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