Class: GenericNavDataBarFieldModelFactory
Defined in: src/garminsdk/components/navdatabar/GenericNavDataBarFieldModelFactory.ts:12
A generic implementation of a factory for navigation data bar field data models. For each data field type, a single-type model factory can be registered. Once registered, the single-type model factory is used to create data models for its assigned data field type.
Implements
Constructors
Constructor
new GenericNavDataBarFieldModelFactory(
gpsValidity
):GenericNavDataBarFieldModelFactory
Defined in: src/garminsdk/components/navdatabar/GenericNavDataBarFieldModelFactory.ts:19
Creates an instance of aGenericNavDataBarFieldModelFactory.
Parameters
Parameter | Type | Description |
---|---|---|
gpsValidity | Subscribable <NavDataFieldGpsValidity > | The subscribable that provides the validity of the GPS data for the models. |
Returns
GenericNavDataBarFieldModelFactory
Methods
create()
create<
T
>(type
):NavDataBarFieldTypeModelMap
[T
]
Defined in: src/garminsdk/components/navdatabar/GenericNavDataBarFieldModelFactory.ts:45
Creates a navigation data bar field data model for a given type of field.
Type Parameters
Type Parameter |
---|
T extends NavDataFieldType |
Parameters
Parameter | Type | Description |
---|---|---|
type | T | A data bar field type. |
Returns
NavDataBarFieldTypeModelMap
[T
]
A navigation data bar field data model for the given field type.
Throws
Error if an unsupported field type is specified.
Implementation of
NavDataBarFieldModelFactory
.create
deregister()
deregister<
T
>(type
):boolean
Defined in: src/garminsdk/components/navdatabar/GenericNavDataBarFieldModelFactory.ts:35
Deregisters a single-type model factory from this factory.
Type Parameters
Type Parameter |
---|
T extends NavDataFieldType |
Parameters
Parameter | Type | Description |
---|---|---|
type | T | The data field type of the single-type model factory to deregister. |
Returns
boolean
Whether a single-type model factory was deregistered.
register()
register<
T
>(type
,factory
):void
Defined in: src/garminsdk/components/navdatabar/GenericNavDataBarFieldModelFactory.ts:26
Registers a single-type model factory with this factory.
Type Parameters
Type Parameter |
---|
T extends NavDataFieldType |
Parameters
Parameter | Type | Description |
---|---|---|
type | T | The data field type of the single-type model factory to register. |
factory | NavDataBarFieldTypeModelFactory <T > | The single-type model factory to register. |
Returns
void