Class: NearestRepoFacilitySearchSession<F, IcaoDataType>
Defined in: src/sdk/navigation/FacilityLoader.ts:1215
A session for searching for nearest facilities that uses the facility repository.
Type Parameters
Type Parameter |
---|
F extends FacilityRepositorySearchableTypes |
IcaoDataType extends NearestIcaoSearchSessionDataType |
Implements
NearestCustomFilteredSearchSession
<FacilityTypeMap
[F
],IcaoDataType
>
Constructors
Constructor
new NearestRepoFacilitySearchSession<
F
,IcaoDataType
>(repo
,sessionId
,facilityType
,icaoDataType
):NearestRepoFacilitySearchSession
<F
,IcaoDataType
>
Defined in: src/sdk/navigation/FacilityLoader.ts:1231
Creates an instance of a NearestRepoFacilitySearchSession.
Parameters
Parameter | Type | Description |
---|---|---|
repo | FacilityRepository | The facility repository in which to search. |
sessionId | number | The ID of this session. |
facilityType | F | The type of facility for which this session searches. |
icaoDataType | IcaoDataType | The data type of the ICAOs provided by this session. |
Returns
NearestRepoFacilitySearchSession
<F
, IcaoDataType
>
Properties
icaoDataType
readonly
icaoDataType:IcaoDataType
Defined in: src/sdk/navigation/FacilityLoader.ts:1235
The data type of the ICAOs provided by this session.
Implementation of
NearestCustomFilteredSearchSession
.icaoDataType
Methods
searchNearest()
searchNearest(
lat
,lon
,radius
,maxItems
):Promise
<NearestSearchResults
<NearestIcaoSearchSessionDataTypeMap
[IcaoDataType
],NearestIcaoSearchSessionDataTypeMap
[IcaoDataType
]>>
Defined in: src/sdk/navigation/FacilityLoader.ts:1239
Searches for nearest facilities from the specified point.
Parameters
Parameter | Type | Description |
---|---|---|
lat | number | The latitude, in degrees. |
lon | number | The longitude, in degrees. |
radius | number | The radius around the point to search, in meters. |
maxItems | number | The maximum number of items. |
Returns
Promise
<NearestSearchResults
<NearestIcaoSearchSessionDataTypeMap
[IcaoDataType
], NearestIcaoSearchSessionDataTypeMap
[IcaoDataType
]>>
The nearest search results.
Implementation of
NearestCustomFilteredSearchSession
.searchNearest
setFacilityFilter()
setFacilityFilter(
filter?
):void
Defined in: src/sdk/navigation/FacilityLoader.ts:1307
Sets the filter for this search session.
Parameters
Parameter | Type | Description |
---|---|---|
filter? | GeoKdTreeSearchFilter <FacilityTypeMap [F ]> | A function to filter the search results. |
Returns
void