Skip to main content

Class: NavIndicators<T, U>

Defined in: workingtitle-instruments-wt21/shared/Navigation/NavIndicators/NavIndicators.ts:80

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-wt21/shared/Navigation/NavIndicators/NavIndicators.ts:83

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-wt21/shared/Navigation/NavIndicators/NavIndicators.ts:102

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-wt21/shared/Navigation/NavIndicators/NavIndicators.ts:88

Returns

void

Inherit Doc

Implementation of

Instrument.init


onUpdate()

onUpdate(): void

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

Returns

void

Inherit Doc

Implementation of

Instrument.onUpdate