Class: PfdUserSettingManager
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/PfdUserSettings.ts:175
A manager for PFD user settings.
Implements
UserSettingManager
<PfdAllUserSettingTypes
>
Constructors
Constructor
new PfdUserSettingManager(
bus
,gduCount
):PfdUserSettingManager
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/PfdUserSettings.ts:203
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
readonly
gduCount:number
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/PfdUserSettings.ts:203
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:248
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:233
Returns
UserSetting
<UserSettingValue
>[]
Inherit Doc
Implementation of
UserSettingManager.getAllSettings
getSetting()
getSetting<
K
>(name
):UserSetting
<NonNullable
<PfdAllUserSettingTypes
[K
]>>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/PfdUserSettings.ts:223
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 |
---|---|
name | K |
Returns
UserSetting
<NonNullable
<PfdAllUserSettingTypes
[K
]>>
Inherit Doc
Implementation of
UserSettingManager.getSetting
mapTo()
mapTo<
M
>(map
):UserSettingManager
<M
&PfdAllUserSettingTypes
>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/PfdUserSettings.ts:238
Type Parameters
Type Parameter |
---|
M extends UserSettingRecord |
Parameters
Parameter | Type |
---|---|
map | UserSettingMap <M , PfdAllUserSettingTypes > |
Returns
UserSettingManager
<M
& PfdAllUserSettingTypes
>
Inherit Doc
Implementation of
UserSettingManager.mapTo
tryGetSetting()
tryGetSetting<
K
>(name
):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`
?UserSetting
<PfdAllUserSettingTypes
[K
<K
>]> :undefined
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/PfdUserSettings.ts:218
Type Parameters
Type Parameter |
---|
K extends string |
Parameters
Parameter | Type |
---|---|
name | K |
Returns
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`
? UserSetting
<PfdAllUserSettingTypes
[K
<K
>]> : undefined
Inherit Doc
Implementation of
UserSettingManager.tryGetSetting
whenSettingChanged()
whenSettingChanged<
K
>(name
):Consumer
<NonNullable
<PfdAllUserSettingTypes
[K
]>>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/PfdUserSettings.ts:228
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 |
---|---|
name | K |
Returns
Consumer
<NonNullable
<PfdAllUserSettingTypes
[K
]>>
Inherit Doc
Implementation of
UserSettingManager.whenSettingChanged