Class: TimeDisplay

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

Displays time in HH:MM:SS format.

Extends

• DisplayComponent<TimeDisplayProps>

Constructors

Constructor

new TimeDisplay(props): TimeDisplay

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

Creates an instance of a DisplayComponent.

Parameters

Parameter	Type	Description
props	TimeDisplayProps	The propertis of the component.

Returns

TimeDisplay

Inherited from

DisplayComponent<TimeDisplayProps>.constructor

Properties

context?

optional context: [] = undefined

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

The context on this component, if any.

Inherited from

DisplayComponent.context

---

contextType?

readonly optional contextType: readonly [] = undefined

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

The type of context for this component, if any.

Inherited from

DisplayComponent.contextType

---

props

props: TimeDisplayProps & ComponentProps

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

The properties of the component.

Inherited from

DisplayComponent.props

Methods

destroy()

destroy(): void

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

Returns

void

Inherit Doc

Overrides

DisplayComponent.destroy

---

getContext()

protected getContext(context): never

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

Gets a context data subscription from the context collection.

Parameters

Parameter	Type	Description
context	never	The context to get the subscription for.

Returns

never

The requested context.

Throws

An error if no data for the specified context type could be found.

Inherited from

DisplayComponent.getContext

---

getSuffix()

protected getSuffix(format, isAm): string

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

Gets the suffix to append to the time display.

Parameters

Parameter	Type	Description
format	TimeDisplayFormat	The format of the time display.
isAm	boolean	Whether or not the current time is AM.

Returns

string

The time display suffix.

---

onAfterRender()

onAfterRender(): void

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

Returns

void

Inherit Doc

Overrides

DisplayComponent.onAfterRender

---

onBeforeRender()

onBeforeRender(): void

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

A callback that is called before the component is rendered.

Returns

void

Inherited from

DisplayComponent.onBeforeRender

---

render()

render(): VNode

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

Returns

VNode

Inherit Doc

Overrides

DisplayComponent.render

---

updateDisplayedTime()

protected updateDisplayedTime(): void

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

Updates the displayed time.

Returns

void

---

DEFAULT_SUFFIX_FORMATTER()

readonly static DEFAULT_SUFFIX_FORMATTER(format, isAm): string

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

A function which formats suffixes for TimeDisplay.

Parameters

Parameter	Type	Description
format	TimeDisplayFormat	The current format used to display the time.
isAm	boolean	Whether or not the current time is AM.

Returns

string

The suffix to append to the displayed time.