Skip to main content

Interface: AltimeterProps

Defined in: src/garminsdk/components/nextgenpfd/altimeter/Altimeter.tsx:26

Component props for Altimeter.

Extends

Properties

altitudeAlertState?

optional altitudeAlertState: Subscribable<AltitudeAlertState>

Defined in: src/garminsdk/components/nextgenpfd/altimeter/Altimeter.tsx:34

The current altitude alert state. If not defined, then the altimeter will not support thye display of altitude alert indications.


children?

optional children: DisplayChildren[]

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

The children of the display component.

Inherited from

ComponentProps.children


class?

optional class: string | ToggleableClassNameRecord | SubscribableSet<string>

Defined in: src/garminsdk/components/nextgenpfd/altimeter/Altimeter.tsx:85

CSS class(es) to apply to the altimeter's root element.


dataProvider

dataProvider: AltimeterDataProvider

Defined in: src/garminsdk/components/nextgenpfd/altimeter/Altimeter.tsx:28

A data provider for the indicator.


declutter

declutter: Subscribable<boolean>

Defined in: src/garminsdk/components/nextgenpfd/altimeter/Altimeter.tsx:54

Whether the indicator should be decluttered due to unusual attitudes. When decluttered, the following features are hidden:

  • Selected altitude display
  • Baro setting display

isBaroTransitionAlertActive?

optional isBaroTransitionAlertActive: Subscribable<boolean>

Defined in: src/garminsdk/components/nextgenpfd/altimeter/Altimeter.tsx:46

Whether the barometric transition alert is active. If not defined, then the altimeter will not support the display of barometric transition alert indications.


minimumsAlertState?

optional minimumsAlertState: Subscribable<MinimumsAlertState>

Defined in: src/garminsdk/components/nextgenpfd/altimeter/Altimeter.tsx:40

The current minimums alert state. If not defined, then the altimeter will not support the display of minimums alert indications.


ref?

optional ref: NodeReference<any>

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

A reference to the display component.

Inherited from

ComponentProps.ref


showMetricAltitude?

optional showMetricAltitude: boolean | Subscribable<boolean>

Defined in: src/garminsdk/components/nextgenpfd/altimeter/Altimeter.tsx:79

Whether to show metric altitude indications. Defaults to false.


showMetricBaroSetting?

optional showMetricBaroSetting: boolean | Subscribable<boolean>

Defined in: src/garminsdk/components/nextgenpfd/altimeter/Altimeter.tsx:82

Whether to show metric units for the baro setting instead of imperial units. Defaults to false.


simplified?

optional simplified: boolean | Subscribable<boolean>

Defined in: src/garminsdk/components/nextgenpfd/altimeter/Altimeter.tsx:67

Whether the indicator should be shown in simplified mode. In simplified mode, the selected altitude display is replaced by an 'Altitude' label, and the following features are hidden:

  • Selected altitude bug
  • Minimums bug
  • Trend vector
  • Ground line
  • Baro setting display

Defaults to false.


supportBaroPreselect

supportBaroPreselect: boolean

Defined in: src/garminsdk/components/nextgenpfd/altimeter/Altimeter.tsx:76

Whether to support the display of the preselected barometric pressure setting.


tapeScaleOptions

tapeScaleOptions: Readonly<AltimeterTapeScaleOptions>

Defined in: src/garminsdk/components/nextgenpfd/altimeter/Altimeter.tsx:70

Scale options for the airspeed tape.


trendVectorOptions

trendVectorOptions: Readonly<AltimeterTrendVectorOptions>

Defined in: src/garminsdk/components/nextgenpfd/altimeter/Altimeter.tsx:73

Options for the trend vector.