Class: NearestIntersectionSearchSession

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

A session for searching for nearest intersections.

Extends

• CoherentNearestSearchSession<string, string>

Constructors

Constructor

new NearestIntersectionSearchSession(sessionId): NearestIntersectionSearchSession

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

Creates an instance of a CoherentNearestSearchSession.

Parameters

Parameter	Type	Description
sessionId	number	The ID of the session.

Returns

NearestIntersectionSearchSession

Inherited from

CoherentNearestSearchSession<string, string>.constructor

Properties

sessionId

protected readonly sessionId: number

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

The ID of the session.

Inherited from

CoherentNearestSearchSession.sessionId

---

Defaults

static Defaults: object

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

Default filters for the nearest intersections search session.

TypeMask

TypeMask: number

Methods

onSearchCompleted()

onSearchCompleted(results): void

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

A callback called by the facility loader when a nearest search has completed.

Parameters

Parameter	Type	Description
results	NearestSearchResults<string, string>	The search results.

Returns

void

Inherited from

CoherentNearestSearchSession.onSearchCompleted

---

searchNearest()

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

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

Parameters

Parameter	Type
lat	number
lon	number
radius	number
maxItems	number

Returns

Promise<NearestSearchResults<string, string>>

Inherit Doc

Inherited from

CoherentNearestSearchSession.searchNearest

---

setIntersectionFilter()

setIntersectionFilter(typeMask, showTerminalWaypoints): void

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

Sets the filter for the intersection nearest search.

Parameters

Parameter	Type	Default value	Description
typeMask	number	undefined	A bitmask to determine which JS intersection types to show.
showTerminalWaypoints	boolean	true	Whether or not to show terminal waypoints. Defaults to true.

Returns

void