Skip to main content

Class: NavIndicators<T, U>

Holds the nav indicators.

Type parameters

NameType
Textends readonly string[]
Uextends readonly string[]

Implements

  • Instrument

Constructors

constructor

new NavIndicators<T, U>(indicators?): NavIndicators<T, U>

NavIndicators constructor.

Type parameters

NameType
Textends readonly string[]
Uextends readonly string[]

Parameters

NameTypeDescription
indicatorsMap<U[number], NavIndicator<T>>The nav indicators to hold.

Returns

NavIndicators<T, U>

Defined in

workingtitle-instruments-wt21/shared/Navigation/NavIndicators/NavIndicators.ts:83

Methods

get

get(key): NavIndicator<T>

Gets a nav indicator.

Parameters

NameTypeDescription
keyU[number]The name of the indicator to get.

Returns

NavIndicator<T>

The indicator.

Throws

Error if indicator not found.

Defined in

workingtitle-instruments-wt21/shared/Navigation/NavIndicators/NavIndicators.ts:102


init

init(): void

Returns

void

Inherit Doc

Implementation of

Instrument.init

Defined in

workingtitle-instruments-wt21/shared/Navigation/NavIndicators/NavIndicators.ts:88


onUpdate

onUpdate(): void

Returns

void

Inherit Doc

Implementation of

Instrument.onUpdate

Defined in

workingtitle-instruments-wt21/shared/Navigation/NavIndicators/NavIndicators.ts:93