Abstract Class: NavDataField<T, P>
Defined in: src/garminsdk/components/navdatafield/NavDataField.tsx:32
A navigation data field, consisting of a title and a 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
.
Extends
DisplayComponent
<P
>
Extended by
NavDataGenericField
NavDataNumberUnitField
NavDataDurationField
NavDataTimeField
NavDataBearingField
Type Parameters
Type Parameter | Default type |
---|---|
T | - |
P extends NavDataFieldProps <T > | NavDataFieldProps <T > |
Constructors
Constructor
new NavDataField<
T
,P
>(props
):NavDataField
<T
,P
>
Defined in: src/sdk/components/FSComponent.ts:73
Creates an instance of a DisplayComponent.
Parameters
Parameter | Type | Description |
---|---|---|
props | P | The propertis of the component. |
Returns
NavDataField
<T
, P
>
Inherited from
DisplayComponent<P>.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:
P
&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/sdk/components/FSComponent.ts:98
Destroys this component.
Returns
void
Inherited from
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
onAfterRender()
onAfterRender(
node
):void
Defined in: src/sdk/components/FSComponent.ts:87
A callback that is called after the component is rendered.
Parameters
Parameter | Type | Description |
---|---|---|
node | VNode | The component's VNode. |
Returns
void
Inherited from
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/navdatafield/NavDataField.tsx:34
Returns
VNode
Inherit Doc
Overrides
DisplayComponent.render
renderValue()
abstract
protected
renderValue():VNode
Defined in: src/garminsdk/components/navdatafield/NavDataField.tsx:47
Renders this data field's value component.
Returns
VNode
This data field's value component, as a VNode.