Interface: MapAbstractNearestWaypointsLayerProps<R>

Defined in: src/sdk/components/map/layers/MapNearestWaypointsLayer.tsx:32

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:35

The event bus.

---

children?

optional children: DisplayChildren[]

Defined in: src/sdk/components/FSComponent.ts:125

The children of the display component.

Inherited from

MapLayerProps.children

---

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

MapLayerProps.class

---

deregisterWaypoint()

deregisterWaypoint: (waypoint, renderer) => void

Defined in: src/sdk/components/map/layers/MapNearestWaypointsLayer.tsx:61

A function which deregisters a waypoint with this layer's waypoint renderer.

Parameters

Parameter	Type
waypoint	MapWaypointRendererType<R>
renderer	R

Returns

void

---

facilityForIcao()?

optional facilityForIcao: (facilityLoader, icao) => Promise<Facility | null>

Defined in: src/sdk/components/map/layers/MapNearestWaypointsLayer.tsx:52

A function which retrieves a facility for a given ICAO. If not defined, then the layer will use its facility loader's tryGetFacility() method to retrieve facilities, using the facility type defined by the ICAO and requesting all possible data for airport facilities.

Parameters

Parameter	Type	Description
facilityLoader	FacilityLoader	The facility loader used by the layer.
icao	IcaoValue	The ICAO for which to retrieve a facility.

Returns

Promise<Facility | null>

A Promise which is fulfilled with the facility for the specified ICAO, or null if a facility could not be retrieved.

---

facilityLoader?

optional facilityLoader: FacilityLoader

Defined in: src/sdk/components/map/layers/MapNearestWaypointsLayer.tsx:38

The facility loader to use. If not defined, then a default instance will be created.

---

getSearchCenter()?

optional getSearchCenter: (mapProjection) => Readonly<LatLonInterface>

Defined in: src/sdk/components/map/layers/MapNearestWaypointsLayer.tsx:67

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

Readonly<LatLonInterface>

---

initRenderer()?

optional initRenderer: (waypointRenderer, canvasLayer) => void

Defined in: src/sdk/components/map/layers/MapNearestWaypointsLayer.tsx:64

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

MapLayerProps.mapProjection

---

model

model: MapModel<any>

Defined in: src/sdk/components/map/MapLayer.ts:12

A map model.

Inherited from

MapLayerProps.model

---

onSessionsStarted()?

optional onSessionsStarted: (airportSession, vorSession, ndbSession, intSession, userSession) => void

Defined in: src/sdk/components/map/layers/MapNearestWaypointsLayer.tsx:82

A callback called when the search sessions are started.

Parameters

Parameter	Type
airportSession	NearestAirportSearchSession<Struct>
vorSession	NearestVorSearchSession<Struct>
ndbSession	NearestIcaoSearchSession<Struct>
intSession	NearestIntersectionSearchSession<Struct>
userSession	NearestRepoFacilitySearchSession<USR, Struct>

Returns

void

---

ref?

optional ref: NodeReference<any>

Defined in: src/sdk/components/FSComponent.ts:128

A reference to the display component.

Inherited from

MapLayerProps.ref

---

registerWaypoint()

registerWaypoint: (waypoint, renderer) => void

Defined in: src/sdk/components/map/layers/MapNearestWaypointsLayer.tsx:58

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:79

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:73

A function which gets the item limit for facility searches.

Parameters

Parameter	Type
searchType	MapNearestWaypointsLayerSearchTypes
center	Readonly<LatLonInterface>
radius	number

Returns

number

---

searchRadiusLimit()?

optional searchRadiusLimit: (searchType, center, radius) => number

Defined in: src/sdk/components/map/layers/MapNearestWaypointsLayer.tsx:76

A function which gets the radius limit for facility searches, in great-arc radians.

Parameters

Parameter	Type
searchType	MapNearestWaypointsLayerSearchTypes
center	Readonly<LatLonInterface>
radius	number

Returns

number

---

shouldRefreshSearch()?

optional shouldRefreshSearch: (searchType, center, radius) => boolean

Defined in: src/sdk/components/map/layers/MapNearestWaypointsLayer.tsx:70

A function which checks if a search should be refreshed. Defaults to true if not defined.

Parameters

Parameter	Type
searchType	MapNearestWaypointsLayerSearchTypes
center	Readonly<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

MapLayerProps.updateFreq

---

waypointForFacility()

waypointForFacility: (facility) => MapWaypointRendererType<R>

Defined in: src/sdk/components/map/layers/MapNearestWaypointsLayer.tsx:55

A function which retrieves a waypoint for a facility.

Parameters

Parameter	Type
facility	Facility

Returns

MapWaypointRendererType<R>

---

waypointRenderer

waypointRenderer: R

Defined in: src/sdk/components/map/layers/MapNearestWaypointsLayer.tsx:41

The waypoint renderer to use.