Class: NavDataTimeField

A navigation data field which displays a value consisting of a formatted time.

The root element of the field contains the nav-data-field CSS class by default.

The root element contains a child title element with the CSS class nav-data-field-title.

Hierarchy

• NavDataField<number, NavDataTimeFieldProps>

  ↳ NavDataTimeField

Constructors

constructor

• new NavDataTimeField(props): NavDataTimeField

Creates an instance of a DisplayComponent.

Parameters

Name	Type	Description
props	NavDataTimeFieldProps	The propertis of the component.

Returns

NavDataTimeField

Inherited from

NavDataField.constructor

Defined in

src/sdk/components/FSComponent.ts:73

Properties

context

• Optional context: [] = undefined

The context on this component, if any.

Inherited from

NavDataField.context

Defined in

src/sdk/components/FSComponent.ts:64

---

contextType

• Optional Readonly contextType: readonly [] = undefined

The type of context for this component, if any.

Inherited from

NavDataField.contextType

Defined in

src/sdk/components/FSComponent.ts:67

---

props

• props: NavDataTimeFieldProps & ComponentProps

The properties of the component.

Inherited from

NavDataField.props

Defined in

src/sdk/components/FSComponent.ts:61

Methods

destroy

▸ destroy(): void

Destroys this component.

Returns

void

Overrides

NavDataField.destroy

Defined in

src/garminsdk/components/navdatafield/NavDataField.tsx:232

---

getContext

▸ getContext(context): never

Gets a context data subscription from the context collection.

Parameters

Name	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

NavDataField.getContext

Defined in

src/sdk/components/FSComponent.ts:106

---

onAfterRender

▸ onAfterRender(node): void

A callback that is called after the component is rendered.

Parameters

Name	Type	Description
node	VNode	The component's VNode.

Returns

void

Inherited from

NavDataField.onAfterRender

Defined in

src/sdk/components/FSComponent.ts:87

---

onBeforeRender

▸ onBeforeRender(): void

A callback that is called before the component is rendered.

Returns

void

Inherited from

NavDataField.onBeforeRender

Defined in

src/sdk/components/FSComponent.ts:80

---

render

▸ render(): VNode

Returns

VNode

Inherit Doc

Inherited from

NavDataField.render

Defined in

src/garminsdk/components/navdatafield/NavDataField.tsx:34

---

renderValue

▸ renderValue(): VNode

Renders this data field's value component.

Returns

VNode

This data field's value component, as a VNode.

Overrides

NavDataField.renderValue

Defined in

src/garminsdk/components/navdatafield/NavDataField.tsx:217