Interface: G3XTimeDisplayProps
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Common/G3XTimeDisplay.tsx:10
Component props for G3XTimeDisplay.
Extends
TimeDisplayProps
Properties
children?
optional
children:DisplayChildren
[]
Defined in: src/sdk/components/FSComponent.ts:122
The children of the display component.
Inherited from
TimeDisplayProps.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.
Inherited from
TimeDisplayProps.class
format
format:
TimeDisplayFormat
|Subscribable
<TimeDisplayFormat
>
Defined in: src/garminsdk/components/common/TimeDisplay.tsx:26
The display format.
Inherited from
TimeDisplayProps.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
.
Inherited from
TimeDisplayProps.hideSuffixWhenNaN
localOffset
localOffset:
number
|Subscribable
<number
>
Defined in: src/garminsdk/components/common/TimeDisplay.tsx:29
The local time offset, in milliseconds.
Inherited from
TimeDisplayProps.localOffset
onlyShowAmPmSuffix?
optional
onlyShowAmPmSuffix:boolean
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Common/G3XTimeDisplay.tsx:21
Whether to only show the 'AM/PM' suffix. Ignored if suffixFormatter
is defined. Defaults to false
.
padHour?
optional
padHour:boolean
|Subscribable
<boolean
>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Common/G3XTimeDisplay.tsx:15
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
ref?
optional
ref:NodeReference
<any
>
Defined in: src/sdk/components/FSComponent.ts:125
A reference to the display component.
Inherited from
TimeDisplayProps.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
Inherited from
TimeDisplayProps.suffixFormatter
time
time:
number
|Subscribable
<number
>
Defined in: src/garminsdk/components/common/TimeDisplay.tsx:23
The time to display, as a UNIX timestamp in milliseconds.
Inherited from
TimeDisplayProps.time
useVerticalSuffix?
optional
useVerticalSuffix:boolean
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Common/G3XTimeDisplay.tsx:18
Whether to use vertical suffix formatting instead of standard suffix formatting. Defaults to false
.