Interface: MapSystemWaypointsLayerProps
Props on the MapSystemWaypointsLayer component.
Hierarchy
MapLayerProps<MapSystemWaypointsLayerModules>↳
MapSystemWaypointsLayerProps
Properties
bus
• bus: EventBus
The event bus.
Defined in
src/sdk/components/mapsystem/layers/MapSystemWaypointsLayer.tsx:29
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
iconFactory
• iconFactory: MapSystemIconFactory
The icon factory to use with this component.
Defined in
src/sdk/components/mapsystem/layers/MapSystemWaypointsLayer.tsx:35
labelFactory
• labelFactory: MapSystemLabelFactory
The label factory to use with this component.
Defined in
src/sdk/components/mapsystem/layers/MapSystemWaypointsLayer.tsx:38
mapProjection
• mapProjection: MapProjection
A map projection model.
Inherited from
Defined in
src/sdk/components/map/MapLayer.ts:15
model
• model: MapModel<MapSystemWaypointsLayerModules>
A map model.
Inherited from
Defined in
src/sdk/components/map/MapLayer.ts:12
ref
• Optional ref: NodeReference<any>
A reference to the display component.
Inherited from
Defined in
src/sdk/components/FSComponent.ts:125
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
useMapTargetAsSearchCenter
• Optional useMapTargetAsSearchCenter: boolean
Whether to use the map's projection target as the center for facility searches instead of the map's center.
Defaults to false.
Defined in
src/sdk/components/mapsystem/layers/MapSystemWaypointsLayer.tsx:44
waypointCache
• Optional waypointCache: FacilityWaypointCache
An optional waypoint cache to use with this layer. Will default to DefaultFacilityWaypointCache if not supplied.
Defined in
src/sdk/components/mapsystem/layers/MapSystemWaypointsLayer.tsx:47
waypointRenderer
• waypointRenderer: MapSystemWaypointsRenderer
The waypoint renderer to use.
Defined in
src/sdk/components/mapsystem/layers/MapSystemWaypointsLayer.tsx:32