Skip to main content

Interface: G3XTimeDisplayProps

Component props for G3XTimeDisplay.

Hierarchy​

  • TimeDisplayProps

    ↳ G3XTimeDisplayProps

Properties​

children​

• Optional children: DisplayChildren[]

The children of the display component.

Inherited from​

TimeDisplayProps.children

Defined in​

src/sdk/components/FSComponent.ts:122

class​

• Optional class: string | ToggleableClassNameRecord | SubscribableSet<string>

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

Inherited from​

TimeDisplayProps.class

Defined in​

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

format​

• format: TimeDisplayFormat | Subscribable<TimeDisplayFormat>

The display format.

Inherited from​

TimeDisplayProps.format

Defined in​

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

hideSuffixWhenNaN​

• Optional hideSuffixWhenNaN: boolean

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

Inherited from​

TimeDisplayProps.hideSuffixWhenNaN

Defined in​

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

localOffset​

• localOffset: number | Subscribable<number>

The local time offset, in milliseconds.

Inherited from​

TimeDisplayProps.localOffset

Defined in​

src/garminsdk/components/common/TimeDisplay.tsx:29

onlyShowAmPmSuffix​

• Optional onlyShowAmPmSuffix: boolean

Whether to only show the 'AM/PM' suffix. Ignored if suffixFormatter is defined. Defaults to false.

Defined in​

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/Common/G3XTimeDisplay.tsx:21

padHour​

• Optional padHour: boolean | Subscribable<boolean>

Whether to the pad the hour text with leading zeroes (up to two digits). Defaults to false when the display format is equal to TimeDisplayFormat.Local12 and to true when when the display format is any other value.

Overrides​

TimeDisplayProps.padHour

Defined in​

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/Common/G3XTimeDisplay.tsx:15

ref​

• Optional ref: NodeReference<any>

A reference to the display component.

Inherited from​

TimeDisplayProps.ref

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​
NameType
formatTimeDisplayFormat
isAmboolean
Returns​

string

Inherited from​

TimeDisplayProps.suffixFormatter

Defined in​

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

time​

• time: number | Subscribable<number>

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

Inherited from​

TimeDisplayProps.time

Defined in​

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

useVerticalSuffix​

• Optional useVerticalSuffix: boolean

Whether to use vertical suffix formatting instead of standard suffix formatting. Defaults to false.

Defined in​

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/Common/G3XTimeDisplay.tsx:18