Skip to main content

Class: NearestBoundarySearchSession

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

A session for searching for nearest airspace boundaries.

Extends​

Implements​

Constructors​

Constructor​

new NearestBoundarySearchSession(sessionId): NearestBoundarySearchSession

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

Creates an instance of a CoherentNearestSearchSession.

Parameters​

ParameterTypeDescription
sessionIdnumberThe ID of the session.

Returns​

NearestBoundarySearchSession

Inherited from​

CoherentNearestSearchSession<BoundaryFacility, number>.constructor

Properties​

sessionId​

protected readonly sessionId: number

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

The ID of the session.

Inherited from​

CoherentNearestSearchSession.sessionId

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<BoundaryFacility, number>The search results.

Returns​

void

Inherited from​

CoherentNearestSearchSession.onSearchCompleted


searchNearest()​

searchNearest(lat, lon, radius, maxItems): Promise<NearestSearchResults<BoundaryFacility, number>>

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<BoundaryFacility, number>>

The nearest search results.

Implementation of​

NearestBoundaryFilteredSearchSession.searchNearest

Inherited from​

CoherentNearestSearchSession.searchNearest


setBoundaryFilter()​

setBoundaryFilter(classMask): void

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

Sets the filter for the boundary nearest search.

Parameters​

ParameterTypeDescription
classMasknumberA bitmask to determine which boundary classes to show.

Returns​

void

Implementation of​

NearestBoundaryFilteredSearchSession.setBoundaryFilter