Interface: G3XNumberUnitDisplayProps<F>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Common/G3XNumberUnitDisplay.tsx:12

Component props for G3XNumberUnitDisplay.

Extends

• NumberUnitDisplayProps<F>

Type Parameters

Type Parameter
F extends string

Properties

children?

optional children: DisplayChildren[]

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

The children of the display component.

Inherited from

NumberUnitDisplayProps.children

---

class?

optional class: string | ToggleableClassNameRecord | SubscribableSet<string>

Defined in: src/garminsdk/components/common/NumberUnitDisplay.tsx:27

CSS class(es) to add to the root of the icon component.

Inherited from

NumberUnitDisplayProps.class

---

displayUnit

displayUnit: null | Unit<F> | Subscribable<null | Unit<F>>

Defined in: src/sdk/components/common/AbstractNumberUnitDisplay.tsx:18

The unit type in which to display the value, or a subscribable which provides it. If the unit is null, then the native type of the value is used instead.

Inherited from

NumberUnitDisplayProps.displayUnit

---

formatter()

formatter: (number) => string

Defined in: src/garminsdk/components/common/NumberUnitDisplay.tsx:13

A function which formats numbers.

Parameters

Parameter	Type
number	number

Returns

string

Inherited from

NumberUnitDisplayProps.formatter

---

hideUnitWhenNaN?

optional hideUnitWhenNaN: boolean

Defined in: src/garminsdk/components/common/NumberUnitDisplay.tsx:24

Whether to hide the unit text when the displayed value is equal to NaN. Defaults to false.

Inherited from

NumberUnitDisplayProps.hideUnitWhenNaN

---

ref?

optional ref: NodeReference<any>

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

A reference to the display component.

Inherited from

NumberUnitDisplayProps.ref

---

unitFormatter()?

optional unitFormatter: (out, unit, number) => void

Defined in: src/garminsdk/components/common/NumberUnitDisplay.tsx:21

A function which formats units. The formatted unit text should be written to the 2-tuple passed to the out parameter, as [bigText, smallText]. bigText and smallText will be rendered into separate <span> elements representing the big and small components of the rendered unit text, respectively. If not defined, then units will be formatted based on the text generated by the UnitFormatter class.

Parameters

Parameter	Type
out	[string, string]
unit	Unit<F>
number	number

Returns

void

Inherited from

NumberUnitDisplayProps.unitFormatter

---

useBasicUnitFormat?

optional useBasicUnitFormat: boolean

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Common/G3XNumberUnitDisplay.tsx:17

Whether to use basic unit text formatting instead of G3X-style unit text formatting. Ignored if unitFormatter is defined. Defaults to false.

---

useVsArrows?

optional useVsArrows: boolean

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Common/G3XNumberUnitDisplay.tsx:23

Whether to format unit text with up and down vertical speed arrows for supported unit types. Ignored if unitFormatter is defined or useStandardUnitFormat is true. Defaults to false.

---

value

value: NumberUnitInterface<F, Unit<F>> | Subscribable<NumberUnitInterface<F, Unit<F>>>

Defined in: src/sdk/components/common/AbstractNumberUnitDisplay.tsx:12

The NumberUnitInterface value to display, or a subscribable which provides it.

Inherited from

NumberUnitDisplayProps.value