Class: DisplayUserSettingManager

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/DisplayUserSettings.ts:99

A manager for display user settings.

Implements

• UserSettingManager<DisplayAllUserSettingTypes>

Constructors

Constructor

new DisplayUserSettingManager(bus, gduCount): DisplayUserSettingManager

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/DisplayUserSettings.ts:115

Creates a new instance of DisplayUserSettingManager.

Parameters

Parameter	Type	Description
bus	EventBus	The event bus.
gduCount	number	The number of GDUs supported by this manager.

Returns

DisplayUserSettingManager

Properties

gduCount

readonly gduCount: number

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/DisplayUserSettings.ts:115

The number of GDUs supported by this manager.

Methods

getAliasedManager()

getAliasedManager(index): UserSettingManager<DisplayUserSettingTypes>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/DisplayUserSettings.ts:161

Gets a manager for aliased display user settings for an indexed GDU.

Parameters

Parameter	Type	Description
index	number	The index of the GDU for which to get an aliased setting manager.

Returns

UserSettingManager<DisplayUserSettingTypes>

A manager for aliased display user settings for the specified GDU.

Throws

RangeError if index is less than 1 or greater than the number of GDUs supported by this manager.

---

getAllSettings()

getAllSettings(): UserSetting<UserSettingValue>[]

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/DisplayUserSettings.ts:146

Returns

UserSetting<UserSettingValue>[]

Inherit Doc

Implementation of

UserSettingManager.getAllSettings

---

getSetting()

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

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/DisplayUserSettings.ts:136

Type Parameters

Type Parameter

K extends `displayStartupSplitMode_${number}_g3x` | `displayToggleSplitWithBack_${number}_g3x` | `displayPfdPaneSide_${number}_g3x` | `displayMfdSplitScreenPageKey_${number}_g3x` | `displayEisScreenSide_${number}_g3x` | `displayMapZoomButtonShow_${number}_g3x` | `displayKnobZoomReverse_${number}_g3x` | "displayEisLocation_g3x" | "displayComRadioLocation_g3x" | "displayNavRadioLocation_g3x" | "displayAudioPanelLocation_g3x" | "displayTransponderLocation_g3x"

Parameters

Parameter	Type
name	K

Returns

UserSetting<NonNullable<DisplayAllUserSettingTypes[K]>>

Inherit Doc

Implementation of

UserSettingManager.getSetting

---

mapTo()

mapTo<M>(map): UserSettingManager<M & DisplayIndexedUserSettingTypes<number> & DisplayNonIndexedUserSettingTypes>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/DisplayUserSettings.ts:151

Type Parameters

Type Parameter
M extends UserSettingRecord

Parameters

Parameter	Type
map	UserSettingMap<M, DisplayAllUserSettingTypes>

Returns

UserSettingManager<M & DisplayIndexedUserSettingTypes<number> & DisplayNonIndexedUserSettingTypes>

Inherit Doc

Implementation of

UserSettingManager.mapTo

---

tryGetSetting()

tryGetSetting<K>(name): K extends `displayStartupSplitMode_${number}_g3x` | `displayToggleSplitWithBack_${number}_g3x` | `displayPfdPaneSide_${number}_g3x` | `displayMfdSplitScreenPageKey_${number}_g3x` | `displayEisScreenSide_${number}_g3x` | `displayMapZoomButtonShow_${number}_g3x` | `displayKnobZoomReverse_${number}_g3x` | "displayEisLocation_g3x" | "displayComRadioLocation_g3x" | "displayNavRadioLocation_g3x" | "displayAudioPanelLocation_g3x" | "displayTransponderLocation_g3x" ? UserSetting<DisplayAllUserSettingTypes[K<K>]> : undefined

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/DisplayUserSettings.ts:131

Type Parameters

Type Parameter
K extends string

Parameters

Parameter	Type
name	K

Returns

K extends `displayStartupSplitMode_${number}_g3x` | `displayToggleSplitWithBack_${number}_g3x` | `displayPfdPaneSide_${number}_g3x` | `displayMfdSplitScreenPageKey_${number}_g3x` | `displayEisScreenSide_${number}_g3x` | `displayMapZoomButtonShow_${number}_g3x` | `displayKnobZoomReverse_${number}_g3x` | "displayEisLocation_g3x" | "displayComRadioLocation_g3x" | "displayNavRadioLocation_g3x" | "displayAudioPanelLocation_g3x" | "displayTransponderLocation_g3x" ? UserSetting<DisplayAllUserSettingTypes[K<K>]> : undefined

Inherit Doc

Implementation of

UserSettingManager.tryGetSetting

---

whenSettingChanged()

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

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/DisplayUserSettings.ts:141

Type Parameters

Type Parameter

K extends `displayStartupSplitMode_${number}_g3x` | `displayToggleSplitWithBack_${number}_g3x` | `displayPfdPaneSide_${number}_g3x` | `displayMfdSplitScreenPageKey_${number}_g3x` | `displayEisScreenSide_${number}_g3x` | `displayMapZoomButtonShow_${number}_g3x` | `displayKnobZoomReverse_${number}_g3x` | "displayEisLocation_g3x" | "displayComRadioLocation_g3x" | "displayNavRadioLocation_g3x" | "displayAudioPanelLocation_g3x" | "displayTransponderLocation_g3x"

Parameters

Parameter	Type
name	K

Returns

Consumer<NonNullable<DisplayAllUserSettingTypes[K]>>

Inherit Doc

Implementation of

UserSettingManager.whenSettingChanged