Class: NavDataDurationField<T>
Defined in: src/garminsdk/components/navdatafield/NavDataField.tsx:160
A navigation data field which displays a value consisting of a formatted duration.
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
Type Parameters
Type Parameter |
---|
T extends NumberUnitInterface <UnitFamily.Duration > |
Constructors
Constructor
new NavDataDurationField<
T
>(props
):NavDataDurationField
<T
>
Defined in: src/sdk/components/FSComponent.ts:73
Creates an instance of a DisplayComponent.
Parameters
Parameter | Type | Description |
---|---|---|
props | NavDataDurationFieldProps | The propertis of the component. |
Returns
NavDataDurationField
<T
>
Inherited from
Properties
context?
optional
context: [] =undefined
Defined in: src/sdk/components/FSComponent.ts:64
The context on this component, if any.
Inherited from
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
props
props:
NavDataDurationFieldProps
<T
> &ComponentProps
Defined in: src/sdk/components/FSComponent.ts:61
The properties of the component.
Inherited from
Methods
destroy()
destroy():
void
Defined in: src/garminsdk/components/navdatafield/NavDataField.tsx:175
Destroys this component.
Returns
void
Overrides
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
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
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
render()
render():
VNode
Defined in: src/garminsdk/components/navdatafield/NavDataField.tsx:34
Returns
VNode
Inherit Doc
Inherited from
renderValue()
renderValue():
VNode
Defined in: src/garminsdk/components/navdatafield/NavDataField.tsx:164
Renders this data field's value component.
Returns
VNode
This data field's value component, as a VNode.