Skip to main content

Interface: NearestBoundaryFilteredSearchSession

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

A nearest search session that can filter boundaries

Extends

Methods

searchNearest()

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

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

The nearest search results.

Inherited from

NearestSearchSession.searchNearest


setBoundaryFilter()

setBoundaryFilter(classMask): void

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

Sets the filter for the boundary nearest search.

Parameters

ParameterTypeDescription
classMasknumberA bitmask to determine which boundary classes to show.

Returns

void