Class: NavIndicatorsCollection<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
NavIndicators
<SourceName
,IndicatorName
>
Constructors
constructor
• new NavIndicatorsCollection<SourceName
, IndicatorName
>(indicators?
): NavIndicatorsCollection
<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 , NavIndicator <SourceName >> | A map of this collection's nav indicators, keyed by name. |
Returns
NavIndicatorsCollection
<SourceName
, IndicatorName
>
Defined in
src/garminsdk/navreference/indicator/NavReferenceIndicator.ts:102
Methods
get
▸ get(name
): NavIndicator
<SourceName
>
Gets a nav indicator with a given name.
Parameters
Name | 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.
Implementation of
Defined in
src/garminsdk/navreference/indicator/NavReferenceIndicator.ts:107