Class: MapAliasedUserSettingManager
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/MapAliasedUserSettingManager.ts:13
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 map settings.
- Each set of PFD map settings.
Implements
UserSettingManager
<G3000MapUserSettingTypes
>
Constructors
Constructor
new MapAliasedUserSettingManager(
bus
):MapAliasedUserSettingManager
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/MapAliasedUserSettingManager.ts:25
Constructor.
Parameters
Parameter | Type | Description |
---|---|---|
bus | EventBus | The event bus. |
Returns
MapAliasedUserSettingManager
Methods
getAllSettings()
getAllSettings():
UserSetting
<UserSettingValue
>[]
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/MapAliasedUserSettingManager.ts:73
Returns
UserSetting
<UserSettingValue
>[]
Inherit Doc
Implementation of
UserSettingManager.getAllSettings
getSetting()
getSetting<
K
>(name
):UserSetting
<NonNullable
<G3000MapUserSettingTypes
[K
]>>
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/MapAliasedUserSettingManager.ts:63
Type Parameters
Type Parameter |
---|
K extends "mapRangeIndex" | "mapOrientation" | "mapAutoNorthUpActive" | "mapAutoNorthUpRangeIndex" | "mapGroundNorthUpActive" | "mapDeclutter" | "mapTerrainMode" | "mapTerrainRangeIndex" | "mapTerrainScaleShow" | "mapAirportLargeRangeIndex" | "mapAirportMediumRangeIndex" | "mapAirportSmallRangeIndex" | "mapVorShow" | "mapVorRangeIndex" | "mapNdbShow" | "mapNdbRangeIndex" | "mapIntersectionShow" | "mapIntersectionRangeIndex" | "mapUserWaypointShow" | "mapUserWaypointRangeIndex" | "mapAirspaceClassBRangeIndex" | "mapAirspaceClassCRangeIndex" | "mapAirspaceClassDRangeIndex" | "mapAirspaceRestrictedRangeIndex" | "mapAirspaceMoaRangeIndex" | "mapAirspaceOtherRangeIndex" | "mapTrafficShow" | "mapTrafficRangeIndex" | "mapTrafficLabelShow" | "mapTrafficLabelRangeIndex" | "mapTrafficAlertLevelMode" | "mapNexradShow" | "mapNexradRangeIndex" | "mapTrackVectorShow" | "mapTrackVectorLookahead" | "mapAltitudeArcShow" | "mapWindVectorShow" | "mapAirspaceShow" | "mapAirportShow" | "mapInsetMode" | "mapInsetTextCumulative" |
Parameters
Parameter | Type |
---|---|
name | K |
Returns
UserSetting
<NonNullable
<G3000MapUserSettingTypes
[K
]>>
Inherit Doc
Implementation of
UserSettingManager.getSetting
mapTo()
mapTo<
M
>(map
):UserSettingManager
<M
&Omit
<MapUserSettingTypes
,G3000MapDelegatedUserSettingNames
> &G3000SpecificMapUserSettingTypes
>
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/MapAliasedUserSettingManager.ts:78
Type Parameters
Type Parameter |
---|
M extends UserSettingRecord |
Parameters
Parameter | Type |
---|---|
map | UserSettingMap <M , G3000MapUserSettingTypes > |
Returns
UserSettingManager
<M
& Omit
<MapUserSettingTypes
, G3000MapDelegatedUserSettingNames
> & G3000SpecificMapUserSettingTypes
>
Inherit Doc
Implementation of
UserSettingManager.mapTo
tryGetSetting()
tryGetSetting<
K
>(name
):K
extends"mapRangeIndex"
|"mapOrientation"
|"mapAutoNorthUpActive"
|"mapAutoNorthUpRangeIndex"
|"mapGroundNorthUpActive"
|"mapDeclutter"
|"mapTerrainMode"
|"mapTerrainRangeIndex"
|"mapTerrainScaleShow"
|"mapAirportLargeRangeIndex"
|"mapAirportMediumRangeIndex"
|"mapAirportSmallRangeIndex"
|"mapVorShow"
|"mapVorRangeIndex"
|"mapNdbShow"
|"mapNdbRangeIndex"
|"mapIntersectionShow"
|"mapIntersectionRangeIndex"
|"mapUserWaypointShow"
|"mapUserWaypointRangeIndex"
|"mapAirspaceClassBRangeIndex"
|"mapAirspaceClassCRangeIndex"
|"mapAirspaceClassDRangeIndex"
|"mapAirspaceRestrictedRangeIndex"
|"mapAirspaceMoaRangeIndex"
|"mapAirspaceOtherRangeIndex"
|"mapTrafficShow"
|"mapTrafficRangeIndex"
|"mapTrafficLabelShow"
|"mapTrafficLabelRangeIndex"
|"mapTrafficAlertLevelMode"
|"mapNexradShow"
|"mapNexradRangeIndex"
|"mapTrackVectorShow"
|"mapTrackVectorLookahead"
|"mapAltitudeArcShow"
|"mapWindVectorShow"
| keyof G3000SpecificMapUserSettingTypes ?UserSetting
<G3000MapUserSettingTypes
[K
<K
>]> :undefined
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/MapAliasedUserSettingManager.ts:58
Type Parameters
Type Parameter |
---|
K extends string |
Parameters
Parameter | Type |
---|---|
name | K |
Returns
K
extends "mapRangeIndex"
| "mapOrientation"
| "mapAutoNorthUpActive"
| "mapAutoNorthUpRangeIndex"
| "mapGroundNorthUpActive"
| "mapDeclutter"
| "mapTerrainMode"
| "mapTerrainRangeIndex"
| "mapTerrainScaleShow"
| "mapAirportLargeRangeIndex"
| "mapAirportMediumRangeIndex"
| "mapAirportSmallRangeIndex"
| "mapVorShow"
| "mapVorRangeIndex"
| "mapNdbShow"
| "mapNdbRangeIndex"
| "mapIntersectionShow"
| "mapIntersectionRangeIndex"
| "mapUserWaypointShow"
| "mapUserWaypointRangeIndex"
| "mapAirspaceClassBRangeIndex"
| "mapAirspaceClassCRangeIndex"
| "mapAirspaceClassDRangeIndex"
| "mapAirspaceRestrictedRangeIndex"
| "mapAirspaceMoaRangeIndex"
| "mapAirspaceOtherRangeIndex"
| "mapTrafficShow"
| "mapTrafficRangeIndex"
| "mapTrafficLabelShow"
| "mapTrafficLabelRangeIndex"
| "mapTrafficAlertLevelMode"
| "mapNexradShow"
| "mapNexradRangeIndex"
| "mapTrackVectorShow"
| "mapTrackVectorLookahead"
| "mapAltitudeArcShow"
| "mapWindVectorShow"
| keyof G3000SpecificMapUserSettingTypes ? UserSetting
<G3000MapUserSettingTypes
[K
<K
>]> : undefined
Inherit Doc
Implementation of
UserSettingManager.tryGetSetting
useDisplayPaneSettings()
useDisplayPaneSettings(
index
):void
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/MapAliasedUserSettingManager.ts:45
Switches the source of this manager's settings to a set of display pane map settings.
Parameters
Parameter | Type | Description |
---|---|---|
index | ControllableDisplayPaneIndex | The index of the display pane. |
Returns
void
usePfdSettings()
usePfdSettings(
index
):void
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/MapAliasedUserSettingManager.ts:53
Switches the source of this manager's settings to a set of PFD map settings.
Parameters
Parameter | Type | Description |
---|---|---|
index | PfdIndex | The index of the PFD. |
Returns
void
whenSettingChanged()
whenSettingChanged<
K
>(name
):Consumer
<NonNullable
<G3000MapUserSettingTypes
[K
]>>
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/MapAliasedUserSettingManager.ts:68
Type Parameters
Type Parameter |
---|
K extends "mapRangeIndex" | "mapOrientation" | "mapAutoNorthUpActive" | "mapAutoNorthUpRangeIndex" | "mapGroundNorthUpActive" | "mapDeclutter" | "mapTerrainMode" | "mapTerrainRangeIndex" | "mapTerrainScaleShow" | "mapAirportLargeRangeIndex" | "mapAirportMediumRangeIndex" | "mapAirportSmallRangeIndex" | "mapVorShow" | "mapVorRangeIndex" | "mapNdbShow" | "mapNdbRangeIndex" | "mapIntersectionShow" | "mapIntersectionRangeIndex" | "mapUserWaypointShow" | "mapUserWaypointRangeIndex" | "mapAirspaceClassBRangeIndex" | "mapAirspaceClassCRangeIndex" | "mapAirspaceClassDRangeIndex" | "mapAirspaceRestrictedRangeIndex" | "mapAirspaceMoaRangeIndex" | "mapAirspaceOtherRangeIndex" | "mapTrafficShow" | "mapTrafficRangeIndex" | "mapTrafficLabelShow" | "mapTrafficLabelRangeIndex" | "mapTrafficAlertLevelMode" | "mapNexradShow" | "mapNexradRangeIndex" | "mapTrackVectorShow" | "mapTrackVectorLookahead" | "mapAltitudeArcShow" | "mapWindVectorShow" | "mapAirspaceShow" | "mapAirportShow" | "mapInsetMode" | "mapInsetTextCumulative" |
Parameters
Parameter | Type |
---|---|
name | K |
Returns
Consumer
<NonNullable
<G3000MapUserSettingTypes
[K
]>>
Inherit Doc
Implementation of
UserSettingManager.whenSettingChanged