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