Class: NavDataFieldTextRenderer<T>
Renders navigation data fields which display a text value.
Type parameters
Name | Type |
---|---|
T | extends NavDataFieldType |
Implements
Constructors
constructor
• new NavDataFieldTextRenderer<T
>(options
): NavDataFieldTextRenderer
<T
>
Creates a new instance of NavDataFieldDestRenderer.
Type parameters
Name | Type |
---|---|
T | extends NavDataFieldType |
Parameters
Name | Type | Description |
---|---|---|
options | Readonly <NavDataFieldTextRendererOptions <TypeOfNavDataFieldModel <NavDataFieldTypeModelMap [T ]>>> | Options with which to configure the renderer. |
Returns
Defined in
src/garminsdk/components/navdatafield/NavDataFieldTypeRenderers.tsx:217
Properties
formatter
• Protected
Readonly
formatter: (value
: TypeOfNavDataFieldModel
<NavDataFieldTypeModelMap
[T
]>) => string
Type declaration
▸ (value
): string
Parameters
Name | Type |
---|---|
value | TypeOfNavDataFieldModel <NavDataFieldTypeModelMap [T ]> |
Returns
string
Defined in
src/garminsdk/components/navdatafield/NavDataFieldTypeRenderers.tsx:211
options
• Protected
Readonly
options: Readonly
<NavDataFieldTextRendererOptions
<TypeOfNavDataFieldModel
<NavDataFieldTypeModelMap
[T
]>>>
Options with which to configure the renderer.
Defined in
src/garminsdk/components/navdatafield/NavDataFieldTypeRenderers.tsx:218
Methods
render
▸ render(model
): VNode
Renders a navigation data field of this renderer's data field type.
Parameters
Name | Type | Description |
---|---|---|
model | NavDataFieldTypeModelMap [T ] | The data model to use for the data field. |
Returns
VNode
A navigation data field of this renderer's data field type, as a VNode.
Implementation of
NavDataFieldTypeRenderer.render
Defined in
src/garminsdk/components/navdatafield/NavDataFieldTypeRenderers.tsx:223