Class: NavDataBar
Defined in: src/garminsdk/components/navdatabar/NavDataBar.tsx:40
A navigation data bar. Displays zero or more navigation data fields.
The root element of the status bar contains the nav-data-bar
CSS class by default.
Extends
DisplayComponent
<NavDataBarProps
>
Constructors
Constructor
new NavDataBar(
props
):NavDataBar
Defined in: src/sdk/components/FSComponent.ts:73
Creates an instance of a DisplayComponent.
Parameters
Parameter | Type | Description |
---|---|---|
props | NavDataBarProps | The propertis of the component. |
Returns
NavDataBar
Inherited from
DisplayComponent<NavDataBarProps>.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:
NavDataBarProps
&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/garminsdk/components/navdatabar/NavDataBar.tsx:112
Returns
void
Inherit Doc
Overrides
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():
void
Defined in: src/garminsdk/components/navdatabar/NavDataBar.tsx:53
Returns
void
Inherit Doc
Overrides
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/navdatabar/NavDataBar.tsx:92
Returns
VNode
Inherit Doc
Overrides
DisplayComponent.render