Skip to main content

Interface: NearestCustomFilteredSearchSession<F, IcaoDataType>

Defined in: src/sdk/navigation/FacilityClient.ts:139

A nearest search session that can filter custom facilities.

Extends

Type Parameters

Type Parameter
F extends UserFacility | VisualFacility
IcaoDataType extends NearestIcaoSearchSessionDataType

Properties

icaoDataType

readonly icaoDataType: IcaoDataType

Defined in: src/sdk/navigation/FacilityClient.ts:77

The data type of the ICAOs provided by this session.

Inherited from

NearestIcaoSearchSession.icaoDataType

Methods

searchNearest()

searchNearest(lat, lon, radius, maxItems): Promise<NearestSearchResults<NearestIcaoSearchSessionDataTypeMap[IcaoDataType], NearestIcaoSearchSessionDataTypeMap[IcaoDataType]>>

Defined in: src/sdk/navigation/FacilityClient.ts:48

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.

Inherited from

NearestIcaoSearchSession.searchNearest


setFacilityFilter()

setFacilityFilter(filter?): void

Defined in: src/sdk/navigation/FacilityClient.ts:146

Sets the filter for this search session.

Parameters

ParameterTypeDescription
filter?GeoKdTreeSearchFilter<F>A function to filter the search results.

Returns

void