Class: NavReferenceIndicatorsCollection<SourceName, IndicatorName>
A basic implementation of NavReferenceIndicators which stores the indicators in a Map.
Type parameters
| Name | Type | 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
NavReferenceIndicators<SourceName,IndicatorName>
Constructors
constructor
• new NavReferenceIndicatorsCollection<SourceName, IndicatorName>(indicators?): NavReferenceIndicatorsCollection<SourceName, IndicatorName>
Creates a new instance of NavReferenceIndicatorsCollection.
Type parameters
| Name | Type |
|---|---|
SourceName | extends string |
IndicatorName | extends string |
Parameters
| Name | Type | Description |
|---|---|---|
indicators | Map<IndicatorName, NavReferenceIndicator<SourceName>> | A map of this collection's nav indicators, keyed by name. |
Returns
NavReferenceIndicatorsCollection<SourceName, IndicatorName>
Defined in
src/garminsdk/navreference/indicator/NavReferenceIndicator.ts:102
Methods
get
▸ get(name): NavReferenceIndicator<SourceName>
Gets a nav indicator with a given name.
Parameters
| Name | Type | Description |
|---|---|---|
name | IndicatorName | The name of the indicator to get. |
Returns
NavReferenceIndicator<SourceName>
The specified nav indicator.
Throws
Error if an indicator with the specified name could not be found.
Implementation of
Defined in
src/garminsdk/navreference/indicator/NavReferenceIndicator.ts:107