Interface: NavDataTimeFieldProps
Component props for NavDataTimeField.
Hierarchy
NavDataFieldProps<number>↳
NavDataTimeFieldProps
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
format
• format: TimeDisplayFormat | Subscribable<TimeDisplayFormat>
The display format.
Defined in
src/garminsdk/components/navdatafield/NavDataField.tsx:186
hideSuffixWhenNaN
• Optional hideSuffixWhenNaN: boolean
Whether to hide the suffix when the displayed time is equal to NaN. Defaults to false.
Defined in
src/garminsdk/components/navdatafield/NavDataField.tsx:203
localOffset
• localOffset: number | Subscribable<number>
The local time offset, in milliseconds.
Defined in
src/garminsdk/components/navdatafield/NavDataField.tsx:189
model
• model: NavDataFieldModel<number>
The model data field's data model.
Inherited from
Defined in
src/garminsdk/components/navdatafield/NavDataField.tsx:19
padHour
• Optional padHour: boolean | Subscribable<boolean>
Whether to the pad the hour text with leading zeroes (up to two digits). Defaults to true.
Defined in
src/garminsdk/components/navdatafield/NavDataField.tsx:192
ref
• Optional ref: NodeReference<any>
A reference to the display component.
Inherited from
Defined in
src/sdk/components/FSComponent.ts:125
suffixFormatter
• Optional suffixFormatter: (format: TimeDisplayFormat, isAm: boolean) => string
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.
Type declaration
▸ (format, isAm): string
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
| Name | Type |
|---|---|
format | TimeDisplayFormat |
isAm | boolean |
Returns
string
Defined in
src/garminsdk/components/navdatafield/NavDataField.tsx:200
title
• title: string
The title of the data field.
Inherited from
Defined in
src/garminsdk/components/navdatafield/NavDataField.tsx:16