Class: NavDataNumberUnitField<T>

Defined in: src/garminsdk/components/navdatafield/NavDataField.tsx:113

A navigation data field which displays a value consisting of a number with unit type.

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.

Extends

• NavDataField<T, NavDataNumberUnitFieldProps<T>>

Type Parameters

Type Parameter
T extends NumberUnitInterface<string>

Constructors

Constructor

new NavDataNumberUnitField<T>(props): NavDataNumberUnitField<T>

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

Creates an instance of a DisplayComponent.

Parameters

Parameter	Type	Description
props	NavDataNumberUnitFieldProps	The propertis of the component.

Returns

NavDataNumberUnitField<T>

Inherited from

NavDataField.constructor

Properties

context?

optional context: [] = undefined

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

The context on this component, if any.

Inherited from

NavDataField.context

---

contextType?

readonly optional contextType: readonly [] = undefined

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

The type of context for this component, if any.

Inherited from

NavDataField.contextType

---

props

props: NavDataNumberUnitFieldProps<T> & ComponentProps

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

The properties of the component.

Inherited from

NavDataField.props

Methods

destroy()

destroy(): void

Defined in: src/garminsdk/components/navdatafield/NavDataField.tsx:131

Destroys this component.

Returns

void

Overrides

NavDataField.destroy

---

getContext()

protected getContext(context): never

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

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

NavDataField.getContext

---

onAfterRender()

onAfterRender(node): void

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

A callback that is called after the component is rendered.

Parameters

Parameter	Type	Description
node	VNode	The component's VNode.

Returns

void

Inherited from

NavDataField.onAfterRender

---

onBeforeRender()

onBeforeRender(): void

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

A callback that is called before the component is rendered.

Returns

void

Inherited from

NavDataField.onBeforeRender

---

render()

render(): VNode

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

Renders the component.

Returns

VNode

A JSX element to be rendered.

Inherited from

NavDataField.render

---

renderValue()

renderValue(): VNode

Defined in: src/garminsdk/components/navdatafield/NavDataField.tsx:117

Renders this data field's value component.

Returns

VNode

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

Overrides

NavDataField.renderValue