Skip to main content

Interface: G3XMapCompassArcLayerProps

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Layers/G3XMapCompassArcLayer.tsx:49

Component props for G3XMapCompassArcLayer.

Extends​

Properties​

arcAngularWidth​

arcAngularWidth: number | Subscribable<number>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Layers/G3XMapCompassArcLayer.tsx:51

The angular width of the arc, in degrees.

arcOutlineColor?​

optional arcOutlineColor: string

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Layers/G3XMapCompassArcLayer.tsx:77

The color of the compass arc outline. Defaults to 'black'.

arcOutlineWidth?​

optional arcOutlineWidth: number

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Layers/G3XMapCompassArcLayer.tsx:74

The width, in pixels, of the compass arc outline. Defaults to 1 pixel.

arcStrokeColor?​

optional arcStrokeColor: string

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Layers/G3XMapCompassArcLayer.tsx:71

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

arcStrokeWidth?​

optional arcStrokeWidth: number

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Layers/G3XMapCompassArcLayer.tsx:68

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

arcTopMargin​

arcTopMargin: number | Subscribable<number>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Layers/G3XMapCompassArcLayer.tsx:57

The margin, in pixels, from the top of the arc (excluding the reference arrow and heading/track readout) to the top of the map's projected window.

bearingLabelFont​

bearingLabelFont: string

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Layers/G3XMapCompassArcLayer.tsx:86

The font type used for the bearing labels.

bearingLabelFontColor?​

optional bearingLabelFontColor: string

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Layers/G3XMapCompassArcLayer.tsx:89

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

bearingLabelMajorFontSize​

bearingLabelMajorFontSize: number

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Layers/G3XMapCompassArcLayer.tsx:92

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

bearingLabelMinorFontSize​

bearingLabelMinorFontSize: number

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Layers/G3XMapCompassArcLayer.tsx:95

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

bearingLabelOutlineColor?​

optional bearingLabelOutlineColor: string

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Layers/G3XMapCompassArcLayer.tsx:101

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

bearingLabelOutlineWidth?​

optional bearingLabelOutlineWidth: number

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Layers/G3XMapCompassArcLayer.tsx:98

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

bearingLabelRadialOffset?​

optional bearingLabelRadialOffset: number

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Layers/G3XMapCompassArcLayer.tsx:107

The radial offset, in pixels, of bearing labels from the arc. Positive values shift the labels toward the center of the arc. Defaults to 0 pixels.

bearingTickMajorLength​

bearingTickMajorLength: number

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Layers/G3XMapCompassArcLayer.tsx:80

The length, in pixels, of major bearing ticks.

bearingTickMinorLength​

bearingTickMinorLength: number

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Layers/G3XMapCompassArcLayer.tsx:83

The length, in pixels, of minor bearing ticks.

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

headingBugColor?​

optional headingBugColor: string

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Layers/G3XMapCompassArcLayer.tsx:150

The color of the selected heading bug. Defaults to 'cyan'.

headingBugHeight?​

optional headingBugHeight: number

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Layers/G3XMapCompassArcLayer.tsx:147

The height, in pixels, of the selected heading bug. Defaults to 12 pixels.

headingBugOutlineColor?​

optional headingBugOutlineColor: string

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Layers/G3XMapCompassArcLayer.tsx:158

The color of the selected heading bug's outline. Defaults to 'cyan'.

headingBugOutlineWidth?​

optional headingBugOutlineWidth: number

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Layers/G3XMapCompassArcLayer.tsx:155

The width, in pixels, of the selected heading bug's outline Defaults to 1 pixel.

headingBugWidth?​

optional headingBugWidth: number

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Layers/G3XMapCompassArcLayer.tsx:142

The width, in pixels, of the selected heading bug. Defaults to 24 pixels.

headingLineColor?​

optional headingLineColor: string

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Layers/G3XMapCompassArcLayer.tsx:131

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

headingLineDash?​

optional headingLineDash: readonly number[]

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Layers/G3XMapCompassArcLayer.tsx:137

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

headingLineWidth?​

optional headingLineWidth: number

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Layers/G3XMapCompassArcLayer.tsx:128

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<G3XMapCompassArcLayerModules>

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

A map model.

Inherited from​

MapLayerProps.model

readoutBorderSize?​

optional readoutBorderSize: Readonly<Omit<Float64Array<ArrayBufferLike>, "set" | "sort" | "copyWithin">> | Subscribable<Readonly<Omit<Float64Array<ArrayBufferLike>, "set" | "sort" | "copyWithin">>>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Layers/G3XMapCompassArcLayer.tsx:113

The size of the border of the digital heading/track readout, as [width, height] in pixels. Required to render the readout border.

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/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Layers/G3XMapCompassArcLayer.tsx:125

The height, in pixels, of the reference arrow. The reference arrow is not shown if the heading/track readout is shown. Defaults to the minor bearing tick length.

referenceArrowWidth?​

optional referenceArrowWidth: number

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Layers/G3XMapCompassArcLayer.tsx:119

The width, in pixels, of the reference arrow. The reference arrow is not shown if the heading/track readout is shown. Defaults to the reference arrow height.

supportHeadingSync?​

optional supportHeadingSync: boolean

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Layers/G3XMapCompassArcLayer.tsx:65

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. 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