Class: PfdUserSettingManager
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/PfdUserSettings.ts:176
A manager for PFD user settings.
Implements
Constructors
Constructor
new PfdUserSettingManager(
bus,gduCount):PfdUserSettingManager
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/PfdUserSettings.ts:204
Creates a new instance of PfdUserSettingManager.
Parameters
| Parameter | Type | Description |
|---|---|---|
bus | EventBus | The event bus. |
gduCount | number | The number of GDUs supported by this manager. |
Returns
PfdUserSettingManager
Properties
gduCount
readonlygduCount:number
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/PfdUserSettings.ts:204
The number of GDUs supported by this manager.
Methods
getAliasedManager()
getAliasedManager(
index):UserSettingManager<PfdUserSettingTypes>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/PfdUserSettings.ts:249
Gets a manager for aliased PFD 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<PfdUserSettingTypes>
A manager for aliased PFD 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/PfdUserSettings.ts:234
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<PfdAllUserSettingTypes,K>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/PfdUserSettings.ts:224
Gets a setting from this manager.
Type Parameters
| Type Parameter |
|---|
K extends `flightDirectorFormat_${number}_g3x` | `svtEnabled_${number}_g3x` | `svtTrafficShow_${number}_g3x` | `svtFpmShow_${number}_g3x` | `pfdStandardRateTurnPointerShow_${number}_g3x` | `aoaDisplayMode_${number}_g3x` | `windDisplayMode_${number}_g3x` | `pfdInsetLeftKey_${number}_g3x` | `pfdInsetRightKey_${number}_g3x` | `pfdBearingPointer1Source_${number}_g3x` | `pfdBearingPointer2Source_${number}_g3x` | `pfdHsiOrientationMode_${number}_g3x` | `pfdHsiShowUpperDeviationIndicator_${number}_g3x` | `pfdKnobSplitScreenSideAction_${number}_g3x` | `pfdKnobPressToToggleAction_${number}_g3x` |
Parameters
| Parameter | Type | Description |
|---|---|---|
name | K | The name of the setting to get. |
Returns
UserSettingFromManager<PfdAllUserSettingTypes, K>
The requested setting.
Throws
Error if no setting with the specified name exists.
Implementation of
mapTo()
mapTo<
M>(map):UserSettingManager<M&PfdAllUserSettingTypes>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/PfdUserSettings.ts:239
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, PfdAllUserSettingTypes> | 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 & PfdAllUserSettingTypes>
A new setting manager which supports accessing a subset of this manager's settings using aliased names.
Implementation of
tryGetSetting()
tryGetSetting<
K>(name):OptionalUserSettingFromManager<PfdAllUserSettingTypes,K>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/PfdUserSettings.ts:219
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<PfdAllUserSettingTypes, K>
The requested setting, or undefined if no such setting exists.
Implementation of
UserSettingManager.tryGetSetting
whenSettingChanged()
whenSettingChanged<
K>(name):UserSettingConsumerFromManager<PfdAllUserSettingTypes,K>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/PfdUserSettings.ts:229
Gets a consumer which notifies handlers when the value of a setting changes.
Type Parameters
| Type Parameter |
|---|
K extends `flightDirectorFormat_${number}_g3x` | `svtEnabled_${number}_g3x` | `svtTrafficShow_${number}_g3x` | `svtFpmShow_${number}_g3x` | `pfdStandardRateTurnPointerShow_${number}_g3x` | `aoaDisplayMode_${number}_g3x` | `windDisplayMode_${number}_g3x` | `pfdInsetLeftKey_${number}_g3x` | `pfdInsetRightKey_${number}_g3x` | `pfdBearingPointer1Source_${number}_g3x` | `pfdBearingPointer2Source_${number}_g3x` | `pfdHsiOrientationMode_${number}_g3x` | `pfdHsiShowUpperDeviationIndicator_${number}_g3x` | `pfdKnobSplitScreenSideAction_${number}_g3x` | `pfdKnobPressToToggleAction_${number}_g3x` |
Parameters
| Parameter | Type | Description |
|---|---|---|
name | K | The name of a setting. |
Returns
UserSettingConsumerFromManager<PfdAllUserSettingTypes, 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.