Interface: NavDataBearingFieldProps<T>
Component props for NavDataBearingField.
Type parameters
| Name | Type |
|---|---|
T | extends NumberUnitInterface<NavAngleUnitFamily, NavAngleUnit> |
Hierarchy
↳
NavDataBearingFieldProps
Properties
children
• Optional children: DisplayChildren[]
The children of the display component.
Inherited from
Defined in
src/sdk/components/FSComponent.ts:122
class
• Optional class: string
CSS class(es) to apply to the root of the component.
Inherited from
Defined in
src/garminsdk/components/navdatafield/NavDataField.tsx:22
displayUnit
• displayUnit: null | NavAngleUnit | Subscribable<null | NavAngleUnit>
A subscribable which provides the display unit type.
Defined in
src/garminsdk/components/navdatafield/NavDataField.tsx:243
formatter
• formatter: (number: number) => string
A function which formats numbers.
Type declaration
▸ (number): string
A function which formats numbers.
Parameters
| Name | Type |
|---|---|
number | number |
Returns
string
Defined in
src/garminsdk/components/navdatafield/NavDataField.tsx:246
model
• model: NavDataFieldModel<T>
The model data field's data model.
Inherited from
Defined in
src/garminsdk/components/navdatafield/NavDataField.tsx:19
ref
• Optional ref: NodeReference<any>
A reference to the display component.
Inherited from
Defined in
src/sdk/components/FSComponent.ts:125
title
• title: string
The title of the data field.
Inherited from
Defined in
src/garminsdk/components/navdatafield/NavDataField.tsx:16
unitFormatter
• Optional unitFormatter: (out: [string, string], unit: NavAngleUnit, number: number) => void
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 such that bigText is always the degree symbol (°) and smallText is empty for magnetic
bearing or 'T' for true bearing.
Type declaration
▸ (out, unit, number): void
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 such that bigText is always the degree symbol (°) and smallText is empty for magnetic
bearing or 'T' for true bearing.
Parameters
| Name | Type |
|---|---|
out | [string, string] |
unit | NavAngleUnit |
number | number |
Returns
void
Defined in
src/garminsdk/components/navdatafield/NavDataField.tsx:255
use360
• Optional use360: boolean
Whether to display 360 in place of 0. True by default.
Defined in
src/garminsdk/components/navdatafield/NavDataField.tsx:258