Skip to main content

Interface: MapSystemWaypointsLayerProps

Defined in: src/sdk/components/mapsystem/layers/MapSystemWaypointsLayer.tsx:27

Props on the MapSystemWaypointsLayer component.

Extends​

Properties​

bus​

bus: EventBus

Defined in: src/sdk/components/mapsystem/layers/MapSystemWaypointsLayer.tsx:29

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

iconFactory​

iconFactory: MapSystemIconFactory

Defined in: src/sdk/components/mapsystem/layers/MapSystemWaypointsLayer.tsx:35

The icon factory to use with this component.

labelFactory​

labelFactory: MapSystemLabelFactory

Defined in: src/sdk/components/mapsystem/layers/MapSystemWaypointsLayer.tsx:38

The label factory to use with this component.

mapProjection​

mapProjection: MapProjection

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

A map projection model.

Inherited from​

MapLayerProps.mapProjection

model​

model: MapModel<MapSystemWaypointsLayerModules>

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

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

useMapTargetAsSearchCenter?​

optional useMapTargetAsSearchCenter: boolean

Defined in: src/sdk/components/mapsystem/layers/MapSystemWaypointsLayer.tsx:44

Whether to use the map's projection target as the center for facility searches instead of the map's center. Defaults to false.

waypointCache?​

optional waypointCache: FacilityWaypointCache

Defined in: src/sdk/components/mapsystem/layers/MapSystemWaypointsLayer.tsx:47

An optional waypoint cache to use with this layer. Will default to DefaultFacilityWaypointCache if not supplied.

waypointRenderer​

waypointRenderer: MapSystemWaypointsRenderer

Defined in: src/sdk/components/mapsystem/layers/MapSystemWaypointsLayer.tsx:32

The waypoint renderer to use.