Skip to main content

Class: MapUserSettings

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/MapUserSettings.ts:94

Utility class for retrieving G3X Touch map user setting managers.

Constructors

Constructor

new MapUserSettings(): MapUserSettings

Returns

MapUserSettings

Methods

getAliasedSettingDefs()

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

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/MapUserSettings.ts:189

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

Returns

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

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


getDefaultValues()

static getDefaultValues(): G3XMapUserSettingTypes

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/MapUserSettings.ts:122

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

Returns

G3XMapUserSettingTypes

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


getMasterManager()

static getMasterManager(bus): UserSettingManager<G3XMapTrueUserSettingTypes>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/MapUserSettings.ts:103

Retrieves a manager for all true map settings.

Parameters

ParameterTypeDescription
busEventBusThe event bus.

Returns

UserSettingManager<G3XMapTrueUserSettingTypes>

A manager for all true map settings.


getStandardManager()

static getStandardManager(bus): UserSettingManager<Omit<MapUserSettingTypes, "mapTrackVectorShow"> & G3XSpecificMapUserSettingTypes>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/MapUserSettings.ts:112

Retrieves a manager for aliased map settings for a standard map.

Parameters

ParameterTypeDescription
busEventBusThe event bus.

Returns

UserSettingManager<Omit<MapUserSettingTypes, "mapTrackVectorShow"> & G3XSpecificMapUserSettingTypes>

A manager for aliased map settings for a standard map.