Skip to main content

Interface: MapRangeCompassLayerProps

Component props for MapRangeCompassLayer.

Hierarchy​

Properties​

arcEndTickLength​

• Optional arcEndTickLength: number

The length, in pixels, of the tick marks at the ends of the compass arc. Defaults to the major bearing tick length.

Defined in​

src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:89

arcStrokeColor​

• Optional arcStrokeColor: string

The style of the compass arc stroke. Defaults to 'white'.

Defined in​

src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:80

arcStrokeWidth​

• Optional arcStrokeWidth: number

The width, in pixels, of the compass arc stroke. Defaults to 2 pixels.

Defined in​

src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:77

bearingLabelFont​

• bearingLabelFont: string

The bearing label font type.

Defined in​

src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:92

bearingLabelFontColor​

• Optional bearingLabelFontColor: string

The color of the bearing label font. Defaults to the arc stroke color.

Defined in​

src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:98

bearingLabelFontSize​

• bearingLabelFontSize: number

The size, in pixels, of the bearing label font.

Defined in​

src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:95

bearingLabelOutlineColor​

• Optional bearingLabelOutlineColor: string

The color of the bearing label outline. Defaults to 'black'.

Defined in​

src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:104

bearingLabelOutlineWidth​

• Optional bearingLabelOutlineWidth: number

The width, in pixels, of the bearing label font's outline. Defaults to 6 pixels.

Defined in​

src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:101

bearingLabelRadialOffset​

• Optional bearingLabelRadialOffset: number

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.

Defined in​

src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:110

bearingTickMajorLength​

• bearingTickMajorLength: number

The length, in pixels, of major bearing ticks.

Defined in​

src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:83

bearingTickMinorLength​

• bearingTickMinorLength: number

The length, in pixels, of minor bearing ticks.

Defined in​

src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:86

bus​

• bus: EventBus

The event bus.

Defined in​

src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:51

children​

• Optional children: DisplayChildren[]

The children of the display component.

Inherited from​

MapLayerProps.children

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​

MapLayerProps.class

Defined in​

src/sdk/components/map/MapLayer.ts:25

headingBugHeight​

• Optional headingBugHeight: number

The height, in pixels, of the selected heading bug.

Defined in​

src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:130

headingBugWidth​

• Optional headingBugWidth: number

The width, in pixels, of the selected heading bug.

Defined in​

src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:125

headingLineDash​

• Optional headingLineDash: readonly number[]

The dash array of the selected heading line. Defaults to [3 * width, 3 * width], where width is the width of the heading line.

Defined in​

src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:142

headingLineStyle​

• Optional headingLineStyle: string | CanvasPattern | CanvasGradient

The style of the selected heading line. Defaults to 'cyan'.

Defined in​

src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:136

headingLineWidth​

• Optional headingLineWidth: number

The width, in pixels, of the selected heading line. Defaults to the arc stroke width.

Defined in​

src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:133

mapProjection​

• mapProjection: MapProjection

A map projection model.

Inherited from​

MapLayerProps.mapProjection

Defined in​

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

model​

• model: MapModel<MapRangeCompassLayerModules>

A map model.

Inherited from​

MapLayerProps.model

Defined in​

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

ref​

• Optional ref: NodeReference<any>

A reference to the display component.

Inherited from​

MapLayerProps.ref

Defined in​

src/sdk/components/FSComponent.ts:125

referenceArrowHeight​

• Optional referenceArrowHeight: number

The height, in pixels, of the reference arrow.

Defined in​

src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:152

referenceArrowWidth​

• Optional referenceArrowWidth: number

The width, in pixels, of the reference arrow.

Defined in​

src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:147

referenceTickHeight​

• Optional referenceTickHeight: number

The height, in pixels, of the reference tick. Defaults to the minor bearing tick length.

Defined in​

src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:120

referenceTickWidth​

• Optional referenceTickWidth: number

The width, in pixels, of the reference tick. Defaults to the arc stroke width.

Defined in​

src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:115

renderLabel​

• Optional renderLabel: MapRangeCompassLabelRenderer

A function which renders labels for the rings. If not defined, a default label of type MapRangeDisplay will be rendered.

Defined in​

src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:60

showHeadingBug​

• showHeadingBug: boolean

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.

Defined in​

src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:66

showLabel​

• showLabel: boolean

Whether to show the range label.

Defined in​

src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:54

supportHeadingSync​

• Optional supportHeadingSync: boolean

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.

Defined in​

src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:74

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​

MapLayerProps.updateFreq

Defined in​

src/sdk/components/map/MapLayer.ts:22