Skip to main content

Class: MapUserSettings

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/MapUserSettings.ts:96

Utility class for retrieving G3000 map user setting managers.

Constructors

Constructor

new MapUserSettings(): MapUserSettings

Returns

MapUserSettings

Methods

getAliasedSettingDefs()

static getAliasedSettingDefs(): readonly UserSettingDefinition<number | boolean | MapOrientationSettingMode | MapDeclutterSettingMode | MapTerrainSettingMode | MapTrafficAlertLevelSettingMode | MapInsetSettingMode>[]

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/MapUserSettings.ts:203

Gets an array of user setting definitions for a full set of aliased map settings.

Returns

readonly UserSettingDefinition<number | boolean | MapOrientationSettingMode | MapDeclutterSettingMode | MapTerrainSettingMode | MapTrafficAlertLevelSettingMode | MapInsetSettingMode>[]

An array of user setting definitions for a full set of aliased map settings.


getDefaultValues()

static getDefaultValues(): G3000MapUserSettingTypes

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/MapUserSettings.ts:153

Gets the default values for a full set of aliased map settings.

Returns

G3000MapUserSettingTypes

The default values for a full set of aliased map settings.


getDisplayPaneManager()

static getDisplayPaneManager(bus, index): UserSettingManager<Omit<MapUserSettingTypes, G3000MapDelegatedUserSettingNames> & G3000SpecificMapUserSettingTypes & MapUserSettingTypes>

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/MapUserSettings.ts:131

Retrieves a manager for aliased map settings for a single display pane.

Parameters

ParameterTypeDescription
busEventBusThe event bus.
indexControllableDisplayPaneIndexThe index of the display pane.

Returns

UserSettingManager<Omit<MapUserSettingTypes, G3000MapDelegatedUserSettingNames> & G3000SpecificMapUserSettingTypes & MapUserSettingTypes>

A manager for aliased map settings for the specified display pane.


getMasterManager()

static getMasterManager(bus): UserSettingManager<MapAllUserSettingTypes>

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/MapUserSettings.ts:114

Retrieves a manager for all true map settings.

Parameters

ParameterTypeDescription
busEventBusThe event bus.

Returns

UserSettingManager<MapAllUserSettingTypes>

A manager for all true map settings.


getPfdManager()

static getPfdManager(bus, index): UserSettingManager<Omit<MapUserSettingTypes, G3000MapDelegatedUserSettingNames> & G3000SpecificMapUserSettingTypes & MapUserSettingTypes>

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Settings/MapUserSettings.ts:143

Retrieves a manager for aliased map settings for a PFD.

Parameters

ParameterTypeDescription
busEventBusThe event bus.
indexPfdIndexThe index of the PFD.

Returns

UserSettingManager<Omit<MapUserSettingTypes, G3000MapDelegatedUserSettingNames> & G3000SpecificMapUserSettingTypes & MapUserSettingTypes>

A manager for aliased map settings for the specified PFD.