Skip to main content

Interface: G3XMapMiniCompassLayerProps

Component props for G3XMapMiniCompassLayer.

Hierarchy​

Properties​

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

mapProjection​

• mapProjection: MapProjection

A map projection model.

Inherited from​

MapLayerProps.mapProjection

Defined in​

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

model​

• model: MapModel<G3XMapMiniCompassLayerModules>

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

supportOrientationToggle​

• Optional supportOrientationToggle: boolean

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.

Defined in​

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/Map/Layers/G3XMapMiniCompassLayer.tsx:40

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