Interface: MapRangeCompassLayerProps
Defined in: src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:49
Component props for MapRangeCompassLayer.
Extends
MapLayerProps
<MapRangeCompassLayerModules
>
Properties
arcEndTickLength?
optional
arcEndTickLength:number
Defined in: src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:89
The length, in pixels, of the tick marks at the ends of the compass arc. Defaults to the major bearing tick length.
arcStrokeColor?
optional
arcStrokeColor:string
Defined in: src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:80
The style of the compass arc stroke. Defaults to 'white'
.
arcStrokeWidth?
optional
arcStrokeWidth:number
Defined in: src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:77
The width, in pixels, of the compass arc stroke. Defaults to 2 pixels.
bearingLabelFont
bearingLabelFont:
string
Defined in: src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:92
The bearing label font type.
bearingLabelFontColor?
optional
bearingLabelFontColor:string
Defined in: src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:98
The color of the bearing label font. Defaults to the arc stroke color.
bearingLabelFontSize
bearingLabelFontSize:
number
Defined in: src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:95
The size, in pixels, of the bearing label font.
bearingLabelOutlineColor?
optional
bearingLabelOutlineColor:string
Defined in: src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:104
The color of the bearing label outline. Defaults to 'black'
.
bearingLabelOutlineWidth?
optional
bearingLabelOutlineWidth:number
Defined in: src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:101
The width, in pixels, of the bearing label font's outline. Defaults to 6 pixels.
bearingLabelRadialOffset?
optional
bearingLabelRadialOffset:number
Defined in: src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:110
The radial offset, in pixels, of bearing labels from its associated tick mark. Positive values shift the label away from the tick mark. Defaults to 0 pixels.
bearingTickMajorLength
bearingTickMajorLength:
number
Defined in: src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:83
The length, in pixels, of major bearing ticks.
bearingTickMinorLength
bearingTickMinorLength:
number
Defined in: src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:86
The length, in pixels, of minor bearing ticks.
bus
bus:
EventBus
Defined in: src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:51
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
headingBugHeight?
optional
headingBugHeight:number
Defined in: src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:130
The height, in pixels, of the selected heading bug.
headingBugWidth?
optional
headingBugWidth:number
Defined in: src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:125
The width, in pixels, of the selected heading bug.
headingLineDash?
optional
headingLineDash: readonlynumber
[]
Defined in: src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:142
The dash array of the selected heading line. Defaults to [3 * width, 3 * width]
, where width
is the width of
the heading line.
headingLineStyle?
optional
headingLineStyle:string
|CanvasPattern
|CanvasGradient
Defined in: src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:136
The style of the selected heading line. Defaults to 'cyan'
.
headingLineWidth?
optional
headingLineWidth:number
Defined in: src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:133
The width, in pixels, of the selected heading line. Defaults to the arc stroke width.
mapProjection
mapProjection:
MapProjection
Defined in: src/sdk/components/map/MapLayer.ts:15
A map projection model.
Inherited from
MapLayerProps.mapProjection
model
model:
MapModel
<MapRangeCompassLayerModules
>
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
referenceArrowHeight?
optional
referenceArrowHeight:number
Defined in: src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:152
The height, in pixels, of the reference arrow.
referenceArrowWidth?
optional
referenceArrowWidth:number
Defined in: src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:147
The width, in pixels, of the reference arrow.
referenceTickHeight?
optional
referenceTickHeight:number
Defined in: src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:120
The height, in pixels, of the reference tick. Defaults to the minor bearing tick length.
referenceTickWidth?
optional
referenceTickWidth:number
Defined in: src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:115
The width, in pixels, of the reference tick. Defaults to the arc stroke width.
renderLabel?
optional
renderLabel:MapRangeCompassLabelRenderer
Defined in: src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:60
A function which renders labels for the rings. If not defined, a default label of type MapRangeDisplay will be rendered.
showHeadingBug
showHeadingBug:
boolean
Defined in: src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:66
Whether to show the selected heading bug. Showing the selected heading bug requires a MapGarminAutopilotPropsModule to be added to the map under the key MapSystemKeys.AutopilotProps.
showLabel
showLabel:
boolean
Defined in: src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:54
Whether to show the range label.
supportHeadingSync?
optional
supportHeadingSync:boolean
Defined in: src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:74
Whether to support autopilot selected heading sync behavior. If true
, then
MapGarminAutopilotPropsModule.manualHeadingSelect will be used to determine when manual adjustments to
selected heading are made. If false
, then any change to selected heading is considered a manual adjustment.
Ignored if showHeadingBug
is false
. Defaults to false
.
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