Interface: NumberUnitDisplayProps<F>

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

Component props for NumberUnitDisplay.

Extends

• AbstractNumberUnitDisplayProps<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

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

---

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

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

---

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.

---

ref?

optional ref: NodeReference<any>

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

A reference to the display component.

Inherited from

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

---

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

AbstractNumberUnitDisplayProps.value