Class: NearestIntersectionSearchSession
A session for searching for nearest intersections.
Hierarchy
CoherentNearestSearchSession<string,string>↳
NearestIntersectionSearchSession
Constructors
constructor
• new NearestIntersectionSearchSession(sessionId): NearestIntersectionSearchSession
Creates an instance of a CoherentNearestSearchSession.
Parameters
| Name | Type | Description |
|---|---|---|
sessionId | number | The ID of the session. |
Returns
NearestIntersectionSearchSession
Inherited from
CoherentNearestSearchSession<string, string>.constructor
Defined in
src/sdk/navigation/FacilityLoader.ts:727
Properties
sessionId
• Protected Readonly sessionId: number
The ID of the session.
Inherited from
CoherentNearestSearchSession.sessionId
Defined in
src/sdk/navigation/FacilityLoader.ts:727
Defaults
▪ Static Defaults: Object
Default filters for the nearest intersections search session.
Type declaration
| Name | Type |
|---|---|
TypeMask | number |
Defined in
src/sdk/navigation/FacilityLoader.ts:805
Methods
onSearchCompleted
▸ onSearchCompleted(results): void
A callback called by the facility loader when a nearest search has completed.
Parameters
| Name | Type | Description |
|---|---|---|
results | NearestSearchResults<string, string> | The search results. |
Returns
void
Inherited from
CoherentNearestSearchSession.onSearchCompleted
Defined in
src/sdk/navigation/FacilityLoader.ts:746
searchNearest
▸ searchNearest(lat, lon, radius, maxItems): Promise<NearestSearchResults<string, string>>
Parameters
| Name | Type |
|---|---|
lat | number |
lon | number |
radius | number |
maxItems | number |
Returns
Promise<NearestSearchResults<string, string>>
Inherit Doc
Inherited from
CoherentNearestSearchSession.searchNearest
Defined in
src/sdk/navigation/FacilityLoader.ts:730
setIntersectionFilter
▸ setIntersectionFilter(typeMask, showTerminalWaypoints?): void
Sets the filter for the intersection nearest search.
Parameters
| Name | 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
Defined in
src/sdk/navigation/FacilityLoader.ts:820