Interface: NavDataNumberUnitFieldProps<T>

Defined in: src/garminsdk/components/navdatafield/NavDataField.tsx:87

Component props for NavDataNumberUnitField.

Extends

• NavDataFieldProps<T>

Type Parameters

Type Parameter
T extends NumberUnitInterface<string>

Properties

children?

optional children: DisplayChildren[]

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

The children of the display component.

Inherited from

NavDataFieldProps.children

---

class?

optional class: string

Defined in: src/garminsdk/components/navdatafield/NavDataField.tsx:22

CSS class(es) to apply to the root of the component.

Inherited from

NavDataFieldProps.class

---

displayUnit

displayUnit: null | Unit<FamilyOfUnit<UnitOfNumber<T>>> | Subscribable<null | Unit<FamilyOfUnit<UnitOfNumber<T>>>>

Defined in: src/garminsdk/components/navdatafield/NavDataField.tsx:89

A subscribable which provides the display unit type.

---

formatter()

formatter: (number) => string

Defined in: src/garminsdk/components/navdatafield/NavDataField.tsx:92

A function which formats numbers.

Parameters

Parameter	Type
number	number

Returns

string

---

hideUnitWhenNaN?

optional hideUnitWhenNaN: boolean

Defined in: src/garminsdk/components/navdatafield/NavDataField.tsx:103

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

---

model

model: NavDataFieldModel<T>

Defined in: src/garminsdk/components/navdatafield/NavDataField.tsx:19

The model data field's data model.

Inherited from

NavDataFieldProps.model

---

ref?

optional ref: NodeReference<any>

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

A reference to the display component.

Inherited from

NavDataFieldProps.ref

---

title

title: string

Defined in: src/garminsdk/components/navdatafield/NavDataField.tsx:16

The title of the data field.

Inherited from

NavDataFieldProps.title

---

unitFormatter()?

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

Defined in: src/garminsdk/components/navdatafield/NavDataField.tsx:100

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<FamilyOfUnit<UnitOfNumber<T>>>
number	number

Returns

void