Interface: MapAbstractNearestWaypointsLayerProps<R>
Defined in: src/sdk/components/map/layers/MapNearestWaypointsLayer.tsx:28
Component props for MapAbstractNearestWaypointsLayer.
Extends
MapLayerProps
<any
>
Type Parameters
Type Parameter | Default type |
---|---|
R extends MapWaypointRenderer <any > | MapWaypointRenderer |
Properties
bus
bus:
EventBus
Defined in: src/sdk/components/map/layers/MapNearestWaypointsLayer.tsx:31
The event bus.
children?
optional
children:DisplayChildren
[]
Defined in: src/sdk/components/FSComponent.ts:122
The children of the display component.
Inherited from
class?
optional
class:string
|SubscribableSet
<string
>
Defined in: src/sdk/components/map/MapLayer.ts:25
The CSS class(es) to apply to the root of this layer.
Inherited from
deregisterWaypoint()
deregisterWaypoint: (
waypoint
,renderer
) =>void
Defined in: src/sdk/components/map/layers/MapNearestWaypointsLayer.tsx:43
A function which deregisters a waypoint with this layer's waypoint renderer.
Parameters
Parameter | Type |
---|---|
waypoint | MapWaypointRendererType <R > |
renderer | R |
Returns
void
getSearchCenter()?
optional
getSearchCenter: (mapProjection
) =>LatLonInterface
Defined in: src/sdk/components/map/layers/MapNearestWaypointsLayer.tsx:49
A function which gets the search center. If not defined, the search center defaults to the center of the map.
Parameters
Parameter | Type |
---|---|
mapProjection | MapProjection |
Returns
initRenderer()?
optional
initRenderer: (waypointRenderer
,canvasLayer
) =>void
Defined in: src/sdk/components/map/layers/MapNearestWaypointsLayer.tsx:46
A function which initializes this layer's waypoint renderer.
Parameters
Parameter | Type |
---|---|
waypointRenderer | R |
canvasLayer | MapSyncedCanvasLayer |
Returns
void
mapProjection
mapProjection:
MapProjection
Defined in: src/sdk/components/map/MapLayer.ts:15
A map projection model.
Inherited from
model
model:
MapModel
<any
>
Defined in: src/sdk/components/map/MapLayer.ts:12
A map model.
Inherited from
onSessionsStarted()?
optional
onSessionsStarted: (airportSession
,vorSession
,ndbSession
,intSession
,userSession
) =>void
Defined in: src/sdk/components/map/layers/MapNearestWaypointsLayer.tsx:64
A callback called when the search sessions are started.
Parameters
Parameter | Type |
---|---|
airportSession | NearestAirportSearchSession |
vorSession | NearestVorSearchSession |
ndbSession | NearestSearchSession <string , string > |
intSession | NearestIntersectionSearchSession |
userSession | NearestRepoFacilitySearchSession <UserFacility > |
Returns
void
ref?
optional
ref:NodeReference
<any
>
Defined in: src/sdk/components/FSComponent.ts:125
A reference to the display component.
Inherited from
registerWaypoint()
registerWaypoint: (
waypoint
,renderer
) =>void
Defined in: src/sdk/components/map/layers/MapNearestWaypointsLayer.tsx:40
A function which registers a waypoint with this layer's waypoint renderer.
Parameters
Parameter | Type |
---|---|
waypoint | MapWaypointRendererType <R > |
renderer | R |
Returns
void
searchDebounceDelay?
optional
searchDebounceDelay:number
Defined in: src/sdk/components/map/layers/MapNearestWaypointsLayer.tsx:61
The debounce delay for facility searches, in milliseconds. Defaults to 500 milliseconds.
searchItemLimit()?
optional
searchItemLimit: (searchType
,center
,radius
) =>number
Defined in: src/sdk/components/map/layers/MapNearestWaypointsLayer.tsx:55
A function which gets the item limit for facility searches.
Parameters
Parameter | Type |
---|---|
searchType | MapNearestWaypointsLayerSearchTypes |
center | LatLonInterface |
radius | number |
Returns
number
searchRadiusLimit()?
optional
searchRadiusLimit: (searchType
,center
,radius
) =>number
Defined in: src/sdk/components/map/layers/MapNearestWaypointsLayer.tsx:58
A function which gets the radius limit for facility searches, in great-arc radians.
Parameters
Parameter | Type |
---|---|
searchType | MapNearestWaypointsLayerSearchTypes |
center | LatLonInterface |
radius | number |
Returns
number
shouldRefreshSearch()?
optional
shouldRefreshSearch: (searchType
,center
,radius
) =>boolean
Defined in: src/sdk/components/map/layers/MapNearestWaypointsLayer.tsx:52
A function which checks if a search should be refreshed. Defaults to true
if not defined.
Parameters
Parameter | Type |
---|---|
searchType | MapNearestWaypointsLayerSearchTypes |
center | LatLonInterface |
radius | number |
Returns
boolean
updateFreq?
optional
updateFreq:Subscribable
<number
>
Defined in: src/sdk/components/map/MapLayer.ts:22
A subscribable which provides the maximum update frequency of the layer, in hertz. Note that the actual update frequency will not exceed the update frequency of the layer's parent map. If not defined, the frequency will default to that of the layer's parent map.
Inherited from
waypointForFacility()
waypointForFacility: (
facility
) =>MapWaypointRendererType
<R
>
Defined in: src/sdk/components/map/layers/MapNearestWaypointsLayer.tsx:37
A function which retrieves a waypoint for a facility.
Parameters
Parameter | Type |
---|---|
facility | Facility |
Returns
waypointRenderer
waypointRenderer:
R
Defined in: src/sdk/components/map/layers/MapNearestWaypointsLayer.tsx:34
The waypoint renderer to use.