Interface: NavDataTimeFieldProps

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

Component props for NavDataTimeField.

Extends

• NavDataFieldProps<number>

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

---

format

format: TimeDisplayFormat | Subscribable<TimeDisplayFormat>

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

The display format.

---

hideSuffixWhenNaN?

optional hideSuffixWhenNaN: boolean

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

Whether to hide the suffix when the displayed time is equal to NaN. Defaults to false.

---

localOffset

localOffset: number | Subscribable<number>

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

The local time offset, in milliseconds.

---

model

model: NavDataFieldModel<number>

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

The model data field's data model.

Inherited from

NavDataFieldProps.model

---

padHour?

optional padHour: boolean | Subscribable<boolean>

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

Whether to the pad the hour text with leading zeroes (up to two digits). Defaults to true.

---

ref?

optional ref: NodeReference<any>

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

A reference to the display component.

Inherited from

NavDataFieldProps.ref

---

suffixFormatter()?

optional suffixFormatter: (format, isAm) => string

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

A function which formats suffixes to append to the displayed time. If not defined, then the suffix will be will be formatted as 'UTC' if the display format is TimeDisplayFormat.UTC, 'LCL' if the display format is TimeDisplayFormat.Local24, and either 'AM' or 'PM' if the display format is TimeDisplayFormat.Local12.

Parameters

Parameter	Type
format	TimeDisplayFormat
isAm	boolean

Returns

string

---

title

title: string

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

The title of the data field.

Inherited from

NavDataFieldProps.title