Skip to main content

Class: DisplayPanesAliasedUserSettingManager

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/DisplayPanesAliasedUserSettingManager.ts:12

An aliased map user setting manager which can switch the true settings from which its aliased settings are sourced. The supported sources are:

  • Each set of display pane settings.

Implements

Constructors

Constructor

new DisplayPanesAliasedUserSettingManager(bus): DisplayPanesAliasedUserSettingManager

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/DisplayPanesAliasedUserSettingManager.ts:23

Constructor.

Parameters

ParameterTypeDescription
busEventBusThe event bus.

Returns

DisplayPanesAliasedUserSettingManager

Methods

getAllSettings()

getAllSettings(): UserSetting<UserSettingValue>[]

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/DisplayPanesAliasedUserSettingManager.ts:84

Returns

UserSetting<UserSettingValue>[]

Inherit Doc

Implementation of

UserSettingManager.getAllSettings


getSetting()

getSetting<K>(name): UserSetting<NonNullable<DisplayPaneSettings[K]>>

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/DisplayPanesAliasedUserSettingManager.ts:74

Type Parameters

Type Parameter
K extends "displayPaneVisible" | "displayPaneView" | "displayPaneDesignatedView" | "displayPaneDesignatedWeatherView" | "displayPaneController" | "displayPaneHalfSizeOnly" | "displayPaneMapPointerActive"

Parameters

ParameterType
nameK

Returns

UserSetting<NonNullable<DisplayPaneSettings[K]>>

Inherit Doc

Implementation of

UserSettingManager.getSetting


mapTo()

mapTo<M>(map): UserSettingManager<M & DisplayPaneSettings>

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/DisplayPanesAliasedUserSettingManager.ts:89

Type Parameters

Type Parameter
M extends UserSettingRecord

Parameters

ParameterType
mapUserSettingMap<M, DisplayPaneSettings>

Returns

UserSettingManager<M & DisplayPaneSettings>

Inherit Doc

Implementation of

UserSettingManager.mapTo


tryGetSetting()

tryGetSetting<K>(name): K extends keyof DisplayPaneSettings ? UserSetting<DisplayPaneSettings[K<K>]> : undefined

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/DisplayPanesAliasedUserSettingManager.ts:69

Type Parameters

Type Parameter
K extends string

Parameters

ParameterType
nameK

Returns

K extends keyof DisplayPaneSettings ? UserSetting<DisplayPaneSettings[K<K>]> : undefined

Inherit Doc

Implementation of

UserSettingManager.tryGetSetting


useDisplayPaneSettings()

useDisplayPaneSettings(index): DisplayPanesAliasedUserSettingManager

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/DisplayPanesAliasedUserSettingManager.ts:63

Switches the source of this manager's settings to a set of display pane settings.

Parameters

ParameterTypeDescription
indexDisplayPaneIndexThe index of the display pane.

Returns

DisplayPanesAliasedUserSettingManager

Itself.


whenSettingChanged()

whenSettingChanged<K>(name): Consumer<NonNullable<DisplayPaneSettings[K]>>

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/DisplayPanesAliasedUserSettingManager.ts:79

Type Parameters

Type Parameter
K extends "displayPaneVisible" | "displayPaneView" | "displayPaneDesignatedView" | "displayPaneDesignatedWeatherView" | "displayPaneController" | "displayPaneHalfSizeOnly" | "displayPaneMapPointerActive"

Parameters

ParameterType
nameK

Returns

Consumer<NonNullable<DisplayPaneSettings[K]>>

Inherit Doc

Implementation of

UserSettingManager.whenSettingChanged