Skip to main content

Class: NavIndicators<T, U>

Defined in: workingtitle-instruments-epic2/shared/Navigation/NavIndicators/NavIndicators.ts:82

Holds the nav indicators.

Type Parameters​

Type Parameter
T extends readonly string[]
U extends readonly string[]

Implements​

  • Instrument

Constructors​

Constructor​

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

Defined in: workingtitle-instruments-epic2/shared/Navigation/NavIndicators/NavIndicators.ts:85

NavIndicators constructor.

Parameters​

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

Returns​

NavIndicators<T, U>

Methods​

get()​

get(key): NavIndicator<T>

Defined in: workingtitle-instruments-epic2/shared/Navigation/NavIndicators/NavIndicators.ts:104

Gets a nav indicator.

Parameters​

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

Returns​

NavIndicator<T>

The indicator.

Throws​

Error if indicator not found.


init()​

init(): void

Defined in: workingtitle-instruments-epic2/shared/Navigation/NavIndicators/NavIndicators.ts:90

Returns​

void

Inherit Doc​

Implementation of​

Instrument.init


onUpdate()​

onUpdate(): void

Defined in: workingtitle-instruments-epic2/shared/Navigation/NavIndicators/NavIndicators.ts:95

Returns​

void

Inherit Doc​

Implementation of​

Instrument.onUpdate