Skip to main content

Class: DisplayUserSettingManager

A manager for display user settings.

Implements

Constructors

constructor

new DisplayUserSettingManager(bus, gduCount): DisplayUserSettingManager

Creates a new instance of DisplayUserSettingManager.

Parameters

NameTypeDescription
busEventBusThe event bus.
gduCountnumberThe number of GDUs supported by this manager.

Returns

DisplayUserSettingManager

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Settings/DisplayUserSettings.ts:115

Properties

gduCount

Readonly gduCount: number

The number of GDUs supported by this manager.

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Settings/DisplayUserSettings.ts:115

Methods

getAliasedManager

getAliasedManager(index): UserSettingManager<DisplayUserSettingTypes>

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

Parameters

NameTypeDescription
indexnumberThe 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.

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Settings/DisplayUserSettings.ts:161


getAllSettings

getAllSettings(): UserSetting<UserSettingValue>[]

Returns

UserSetting<UserSettingValue>[]

Inherit Doc

Implementation of

UserSettingManager.getAllSettings

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Settings/DisplayUserSettings.ts:146


getSetting

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

Type parameters

NameType
Kextends `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

NameType
nameK

Returns

UserSetting<NonNullable<DisplayAllUserSettingTypes[K]>>

Inherit Doc

Implementation of

UserSettingManager.getSetting

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Settings/DisplayUserSettings.ts:136


mapTo

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

Type parameters

NameType
Mextends UserSettingRecord

Parameters

NameType
mapUserSettingMap<M, DisplayAllUserSettingTypes>

Returns

UserSettingManager<M & DisplayIndexedUserSettingTypes<number> & DisplayNonIndexedUserSettingTypes>

Inherit Doc

Implementation of

UserSettingManager.mapTo

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Settings/DisplayUserSettings.ts:151


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]> : undefined

Type parameters

NameType
Kextends string

Parameters

NameType
nameK

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]> : undefined

Inherit Doc

Implementation of

UserSettingManager.tryGetSetting

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Settings/DisplayUserSettings.ts:131


whenSettingChanged

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

Type parameters

NameType
Kextends `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

NameType
nameK

Returns

Consumer<NonNullable<DisplayAllUserSettingTypes[K]>>

Inherit Doc

Implementation of

UserSettingManager.whenSettingChanged

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Settings/DisplayUserSettings.ts:141