Interface: MapWaypointsLayerProps

Defined in: src/garminsdk/components/map/layers/MapWaypointsLayer.tsx:30

Component props for MapWaypointsLayer.

Extends

• MapLayerProps<MapWaypointsLayerModules>

Properties

airportFacilityDataFlags?

optional airportFacilityDataFlags: number

Defined in: src/garminsdk/components/map/layers/MapWaypointsLayer.tsx:49

Bitflags describing the requested data to be loaded in airport facilities retrieved by the layer. This controls what data are available from the airport waypoints that the layer registers with the waypoint renderer. If supportRunwayOutlines is true, then runway data (AirportFacilityDataFlags.Runways) will always be requested, regardless of the value of this option. Defaults to AirportFacilityDataFlags.All.

---

bus

bus: EventBus

Defined in: src/garminsdk/components/map/layers/MapWaypointsLayer.tsx:32

The event bus.

---

children?

optional children: DisplayChildren[]

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

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

---

facilityLoader?

optional facilityLoader: FacilityLoader

Defined in: src/garminsdk/components/map/layers/MapWaypointsLayer.tsx:35

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

---

mapProjection

mapProjection: MapProjection

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

A map projection model.

Inherited from

MapLayerProps.mapProjection

---

model

model: MapModel<MapWaypointsLayerModules>

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

A map model.

Inherited from

MapLayerProps.model

---

ref?

optional ref: NodeReference<any>

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

A reference to the display component.

Inherited from

MapLayerProps.ref

---

supportRunwayOutlines

supportRunwayOutlines: boolean

Defined in: src/garminsdk/components/map/layers/MapWaypointsLayer.tsx:41

Whether to support the rendering of runway outlines.

---

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

---

userFacilityScopeFilter()?

optional userFacilityScopeFilter: (scope) => boolean

Defined in: src/garminsdk/components/map/layers/MapWaypointsLayer.tsx:57

A function that filters user facilities to be displayed by the layer based on their scopes. If not defined, then user facilities will not be filtered based on scope.

Parameters

Parameter	Type	Description
scope	string	A user facility scope.

Returns

boolean

Whether to display the user facility with the specified scope.

---

waypointRenderer

waypointRenderer: MapWaypointRenderer

Defined in: src/garminsdk/components/map/layers/MapWaypointsLayer.tsx:38

The waypoint renderer to use.