Interface: TimeDisplayProps

Defined in: src/garminsdk/components/common/TimeDisplay.tsx:21

Component props for TimeDisplay.

Extends

• ComponentProps

Extended by

• G3XTimeDisplayProps

Properties

children?

optional children: DisplayChildren[]

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

The children of the display component.

Inherited from

ComponentProps.children

---

class?

optional class: string | ToggleableClassNameRecord | SubscribableSet<string>

Defined in: src/garminsdk/components/common/TimeDisplay.tsx:46

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

---

format

format: TimeDisplayFormat | Subscribable<TimeDisplayFormat>

Defined in: src/garminsdk/components/common/TimeDisplay.tsx:26

The display format.

---

hideSuffixWhenNaN?

optional hideSuffixWhenNaN: boolean

Defined in: src/garminsdk/components/common/TimeDisplay.tsx:43

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/common/TimeDisplay.tsx:29

The local time offset, in milliseconds.

---

padHour?

optional padHour: boolean | Subscribable<boolean>

Defined in: src/garminsdk/components/common/TimeDisplay.tsx:32

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

ComponentProps.ref

---

suffixFormatter()?

optional suffixFormatter: (format, isAm) => string

Defined in: src/garminsdk/components/common/TimeDisplay.tsx:40

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

---

time

time: number | Subscribable<number>

Defined in: src/garminsdk/components/common/TimeDisplay.tsx:23

The time to display, as a UNIX timestamp in milliseconds.