Skip to main content

Interface: G3XMapMiniCompassLayerProps

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

Component props for G3XMapMiniCompassLayer.

Extends​

Properties​

children?​

optional children: DisplayChildren[]

Defined in: src/sdk/components/FSComponent.ts:125

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

mapProjection​

mapProjection: MapProjection

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

A map projection model.

Inherited from​

MapLayerProps.mapProjection

model​

model: MapModel<G3XMapMiniCompassLayerModules>

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:128

A reference to the display component.

Inherited from​

MapLayerProps.ref

supportOrientationToggle?​

optional supportOrientationToggle: boolean

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

Whether the compass should support the orientation toggle feature. If defined, then the compass will function as a touchscreen button. If not defined, then the compass will not function as a button. The orientation toggle feature requires the following modules:

  • [GarminMapKeys.Orientation]: MapOrientationModule
  • [G3XMapKeys.OrientationOverride]: MapOrientationOverrideModule

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