Class: NearestIntersectionSearchSession<IcaoDataType>
Defined in: src/sdk/navigation/FacilityLoader.ts:1133
A session for searching for nearest intersections.
Extends
CoherentIcaoNearestSearchSession
<IcaoDataType
>
Type Parameters
Type Parameter |
---|
IcaoDataType extends NearestIcaoSearchSessionDataType |
Implements
NearestIntersectionFilteredSearchSession
<IcaoDataType
>
Constructors
Constructor
new NearestIntersectionSearchSession<
IcaoDataType
>(sessionId
,icaoDataType
):NearestIntersectionSearchSession
<IcaoDataType
>
Defined in: src/sdk/navigation/FacilityLoader.ts:1078
Creates an instance of a CoherentIcaoNearestSearchSession.
Parameters
Parameter | Type | Description |
---|---|---|
sessionId | number | The ID of the session. |
icaoDataType | IcaoDataType | The data type of the ICAOs provided by this session. |
Returns
NearestIntersectionSearchSession
<IcaoDataType
>
Inherited from
CoherentIcaoNearestSearchSession<IcaoDataType>.constructor
Properties
icaoDataType
readonly
icaoDataType:IcaoDataType
Defined in: src/sdk/navigation/FacilityLoader.ts:1078
The data type of the ICAOs provided by this session.
Implementation of
NearestIntersectionFilteredSearchSession
.icaoDataType
Inherited from
CoherentIcaoNearestSearchSession.icaoDataType
sessionId
protected
readonly
sessionId:number
Defined in: src/sdk/navigation/FacilityLoader.ts:1004
The ID of the session.
Inherited from
CoherentIcaoNearestSearchSession.sessionId
Defaults
readonly
static
Defaults:object
Defined in: src/sdk/navigation/FacilityLoader.ts:1140
Default filters for the nearest intersections search session.
TypeMask
TypeMask:
number
Methods
onSearchCompleted()
onSearchCompleted(
results
):void
Defined in: src/sdk/navigation/FacilityLoader.ts:1024
A callback called by the facility loader when a nearest search has completed.
Parameters
Parameter | Type | Description |
---|---|---|
results | NearestSearchResults <NearestIcaoSearchSessionDataTypeMap [IcaoDataType ], NearestIcaoSearchSessionDataTypeMap [IcaoDataType ]> | The search results. |
Returns
void
Inherited from
CoherentIcaoNearestSearchSession.onSearchCompleted
searchNearest()
searchNearest(
lat
,lon
,radius
,maxItems
):Promise
<NearestSearchResults
<NearestIcaoSearchSessionDataTypeMap
[IcaoDataType
],NearestIcaoSearchSessionDataTypeMap
[IcaoDataType
]>>
Defined in: src/sdk/navigation/FacilityLoader.ts:1007
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
NearestIntersectionFilteredSearchSession
.searchNearest
Inherited from
CoherentIcaoNearestSearchSession.searchNearest
setIntersectionFilter()
setIntersectionFilter(
typeMask
,showTerminalWaypoints
):void
Defined in: src/sdk/navigation/FacilityLoader.ts:1155
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
Implementation of
NearestIntersectionFilteredSearchSession
.setIntersectionFilter