Skip to main content

Class: NearestRepoFacilitySearchSession<F>

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

A session for searching for nearest facilities that uses the facility repository.

Type Parameters​

Type Parameter
F extends RepoFacilityType

Implements​

Constructors​

Constructor​

new NearestRepoFacilitySearchSession<F>(repo, sessionId): NearestRepoFacilitySearchSession<F>

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

Creates an instance of a NearestUserSearchSession.

Parameters​

ParameterTypeDescription
repoFacilityRepositoryThe facility repository in which to search.
sessionIdnumberThe ID of the session.

Returns​

NearestRepoFacilitySearchSession<F>

Methods​

searchNearest()​

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

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

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<string, string>>

The nearest search results.

Implementation of​

NearestSearchSession.searchNearest


setUserFacilityFilter()​

setUserFacilityFilter(filter?): void

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

Sets the filter for this search session.

Parameters​

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

Returns​

void