Skip to main content

Interface: NavDataBearingFieldProps<T>

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

Component props for NavDataBearingField.

Extends

Type Parameters

Type Parameter
T extends NumberUnitInterface<NavAngleUnitFamily, NavAngleUnit>

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 | NavAngleUnit | Subscribable<null | NavAngleUnit>

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

A subscribable which provides the display unit type.


formatter()

formatter: (number) => string

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

A function which formats numbers.

Parameters

ParameterType
numbernumber

Returns

string


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:255

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

ParameterType
out[string, string]
unitNavAngleUnit
numbernumber

Returns

void


use360?

optional use360: boolean

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

Whether to display 360 in place of 0. True by default.