Class: NavDataBearingField<T>
A navigation data field which displays a bearing value.
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.
Type parameters
| Name | Type |
|---|---|
T | extends NumberUnitInterface<NavAngleUnitFamily, NavAngleUnit> |
Hierarchy
NavDataField<T,NavDataBearingFieldProps<T>>↳
NavDataBearingField
Constructors
constructor
• new NavDataBearingField<T>(props): NavDataBearingField<T>
Creates an instance of a DisplayComponent.
Type parameters
| Name | Type |
|---|---|
T | extends NumberUnitInterface<"navangle", NavAngleUnit> |
Parameters
| Name | Type | Description |
|---|---|---|
props | NavDataBearingFieldProps<T> | The propertis of the component. |
Returns
Inherited from
Defined in
src/sdk/components/FSComponent.ts:73
Properties
context
• Optional context: [] = undefined
The context on this component, if any.
Inherited from
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
Defined in
src/sdk/components/FSComponent.ts:67
props
• props: NavDataBearingFieldProps<T> & ComponentProps
The properties of the component.
Inherited from
Defined in
src/sdk/components/FSComponent.ts:61
Methods
destroy
▸ destroy(): void
Destroys this component.
Returns
void
Overrides
Defined in
src/garminsdk/components/navdatafield/NavDataField.tsx:286
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
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
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
Defined in
src/sdk/components/FSComponent.ts:80
render
▸ render(): VNode
Returns
VNode
Inherit Doc
Inherited from
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
Defined in
src/garminsdk/components/navdatafield/NavDataField.tsx:272