Class: NavIndicatorsCollection<SourceName, IndicatorName>
Defined in: src/garminsdk/navreference/indicator/NavReferenceIndicator.ts:97
A basic implementation of NavReferenceIndicators which stores the indicators in a Map.
Type Parameters
| Type Parameter | Description |
|---|---|
SourceName extends string | The names of the nav sources supported by the nav indicators contained in the collection. |
IndicatorName extends string | The names of the nav indicators contained in the collection. |
Implements
NavIndicators<SourceName,IndicatorName>
Constructors
Constructor
new NavIndicatorsCollection<
SourceName,IndicatorName>(indicators):NavReferenceIndicatorsCollection<SourceName,IndicatorName>
Defined in: src/garminsdk/navreference/indicator/NavReferenceIndicator.ts:102
Creates a new instance of NavReferenceIndicatorsCollection.
Parameters
| Parameter | Type | Description |
|---|---|---|
indicators | Map<IndicatorName, NavIndicator<SourceName>> | A map of this collection's nav indicators, keyed by name. |
Returns
NavReferenceIndicatorsCollection<SourceName, IndicatorName>
Methods
get()
get(
name):NavIndicator<SourceName>
Defined in: src/garminsdk/navreference/indicator/NavReferenceIndicator.ts:107
Gets a nav indicator with a given name.
Parameters
| Parameter | Type | Description |
|---|---|---|
name | IndicatorName | The name of the indicator to get. |
Returns
NavIndicator<SourceName>
The specified nav indicator.
Throws
Error if an indicator with the specified name could not be found.