Class: DisplayPanesAliasedUserSettingManager

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

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

• UserSettingManager<DisplayPaneSettings>

Constructors

Constructor

new DisplayPanesAliasedUserSettingManager(bus): DisplayPanesAliasedUserSettingManager

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

Constructor.

Parameters

Parameter	Type	Description
bus	EventBus	The event bus.

Returns

DisplayPanesAliasedUserSettingManager

Methods

getAllSettings()

getAllSettings(): UserSetting<UserSettingValue>[]

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

Gets an array of all settings of this manager.

Returns

UserSetting<UserSettingValue>[]

an array of all settings of this manager.

Implementation of

UserSettingManager.getAllSettings

---

getSetting()

getSetting<K>(name): UserSettingFromManager<DisplayPaneSettings, K>

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

Gets a setting from this manager.

Type Parameters

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

Parameters

Parameter	Type	Description
name	K	The name of the setting to get.

Returns

UserSettingFromManager<DisplayPaneSettings, K>

The requested setting.

Throws

Error if no setting with the specified name exists.

Implementation of

UserSettingManager.getSetting

---

mapTo()

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

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

Maps a subset of this manager's settings to ones with aliased names, and creates a new setting manager which supports accessing the settings using their aliases.

Type Parameters

Type Parameter
M extends UserSettingRecord

Parameters

Parameter	Type	Description
map	UserSettingMap<M, DisplayPaneSettings>	A map defining the aliases of a subset of this manager's settings, with aliased setting names as keys and original setting names as values.

Returns

UserSettingManager<M & DisplayPaneSettings>

A new setting manager which supports accessing a subset of this manager's settings using aliased names.

Implementation of

UserSettingManager.mapTo

---

tryGetSetting()

tryGetSetting<K>(name): OptionalUserSettingFromManager<DisplayPaneSettings, K>

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

Attempts to get a setting from this manager.

Type Parameters

Type Parameter
K extends string

Parameters

Parameter	Type	Description
name	K	The name of the setting to get.

Returns

OptionalUserSettingFromManager<DisplayPaneSettings, K>

The requested setting, or undefined if no such setting exists.

Implementation of

UserSettingManager.tryGetSetting

---

useDisplayPaneSettings()

useDisplayPaneSettings(index): DisplayPanesAliasedUserSettingManager

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

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

Parameters

Parameter	Type	Description
index	DisplayPaneIndex	The index of the display pane.

Returns

DisplayPanesAliasedUserSettingManager

Itself.

---

whenSettingChanged()

whenSettingChanged<K>(name): UserSettingConsumerFromManager<DisplayPaneSettings, K>

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

Gets a consumer which notifies handlers when the value of a setting changes.

Type Parameters

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

Parameters

Parameter	Type	Description
name	K	The name of a setting.

Returns

UserSettingConsumerFromManager<DisplayPaneSettings, K>

a consumer which notifies handlers when the value of the setting changes.

Throws

Error if no setting with the specified name exists.

Deprecated

Please use getSetting(name).sub() instead.

Implementation of

UserSettingManager.whenSettingChanged