Skip to main content

Class: NavReferenceIndicatorsCollection<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 ParameterDescription
SourceName extends stringThe names of the nav sources supported by the nav indicators contained in the collection.
IndicatorName extends stringThe names of the nav indicators contained in the collection.

Implements

Constructors

Constructor

new NavReferenceIndicatorsCollection<SourceName, IndicatorName>(indicators): NavReferenceIndicatorsCollection<SourceName, IndicatorName>

Defined in: src/garminsdk/navreference/indicator/NavReferenceIndicator.ts:102

Creates a new instance of NavReferenceIndicatorsCollection.

Parameters

ParameterTypeDescription
indicatorsMap<IndicatorName, NavReferenceIndicator<SourceName>>A map of this collection's nav indicators, keyed by name.

Returns

NavReferenceIndicatorsCollection<SourceName, IndicatorName>

Methods

get()

get(name): NavReferenceIndicator<SourceName>

Defined in: src/garminsdk/navreference/indicator/NavReferenceIndicator.ts:107

Gets a nav indicator with a given name.

Parameters

ParameterTypeDescription
nameIndicatorNameThe 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

NavReferenceIndicators.get