Class: SavedFrequenciesUserSettingsManager

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/SavedFrequenciesUserSettings.ts:40

A user setting manager for saved frequencies.

Implements

• UserSettingManager<SavedFrequencyAllUserSettingTypes>

Constructors

Constructor

new SavedFrequenciesUserSettingsManager(bus): SavedFrequenciesUserSettingsManager

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/SavedFrequenciesUserSettings.ts:47

Creates a new instance of SavedFrequenciesUserSettingsManager.

Parameters

Parameter	Type	Description
bus	EventBus	The event bus.

Returns

SavedFrequenciesUserSettingsManager

Methods

getAllSettings()

getAllSettings(): UserSetting<UserSettingValue>[]

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/SavedFrequenciesUserSettings.ts:73

Gets an array of all settings of this manager.

Returns

UserSetting<UserSettingValue>[]

an array of all settings of this manager.

Implementation of

UserSettingManager.getAllSettings

---

getManager()

getManager(): DefaultUserSettingManager<SavedFrequencyAllUserSettingTypes>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/SavedFrequenciesUserSettings.ts:86

Gets a manager for Saved Frequency user settings.

Returns

DefaultUserSettingManager<SavedFrequencyAllUserSettingTypes>

A manager for Saved Frequency user settings.

---

getSetting()

getSetting<K>(name): UserSettingFromManager<SavedFrequencyAllUserSettingTypes, K>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/SavedFrequenciesUserSettings.ts:63

Gets a setting from this manager.

Type Parameters

Type Parameter

K extends "frequencyComRecent_2_g3x" | "frequencyComRecent_4_g3x" | "frequencyComRecent_16_g3x" | "frequencyComRecent_1_g3x" | "frequencyComRecent_3_g3x" | "frequencyComRecent_6_g3x" | "frequencyComRecent_5_g3x" | "frequencyComRecent_7_g3x" | "frequencyComRecent_8_g3x" | "frequencyComRecent_9_g3x" | "frequencyComRecent_10_g3x" | "frequencyComRecent_11_g3x" | "frequencyComRecent_12_g3x" | "frequencyComRecent_13_g3x" | "frequencyComRecent_14_g3x" | "frequencyComRecent_15_g3x" | "frequencyComUser_2_g3x" | "frequencyComUser_4_g3x" | "frequencyComUser_16_g3x" | "frequencyComUser_1_g3x" | "frequencyComUser_3_g3x" | "frequencyComUser_6_g3x" | "frequencyComUser_5_g3x" | "frequencyComUser_7_g3x" | "frequencyComUser_8_g3x" | "frequencyComUser_9_g3x" | "frequencyComUser_10_g3x" | "frequencyComUser_11_g3x" | "frequencyComUser_12_g3x" | "frequencyComUser_13_g3x" | "frequencyComUser_14_g3x" | "frequencyComUser_15_g3x" | "frequencyNavRecent_2_g3x" | "frequencyNavRecent_4_g3x" | "frequencyNavRecent_16_g3x" | "frequencyNavRecent_1_g3x" | "frequencyNavRecent_3_g3x" | "frequencyNavRecent_6_g3x" | "frequencyNavRecent_5_g3x" | "frequencyNavRecent_7_g3x" | "frequencyNavRecent_8_g3x" | "frequencyNavRecent_9_g3x" | "frequencyNavRecent_10_g3x" | "frequencyNavRecent_11_g3x" | "frequencyNavRecent_12_g3x" | "frequencyNavRecent_13_g3x" | "frequencyNavRecent_14_g3x" | "frequencyNavRecent_15_g3x" | "frequencyNavUser_2_g3x" | "frequencyNavUser_4_g3x" | "frequencyNavUser_16_g3x" | "frequencyNavUser_1_g3x" | "frequencyNavUser_3_g3x" | "frequencyNavUser_6_g3x" | "frequencyNavUser_5_g3x" | "frequencyNavUser_7_g3x" | "frequencyNavUser_8_g3x" | "frequencyNavUser_9_g3x" | "frequencyNavUser_10_g3x" | "frequencyNavUser_11_g3x" | "frequencyNavUser_12_g3x" | "frequencyNavUser_13_g3x" | "frequencyNavUser_14_g3x" | "frequencyNavUser_15_g3x"

Parameters

Parameter	Type	Description
name	K	The name of the setting to get.

Returns

UserSettingFromManager<SavedFrequencyAllUserSettingTypes, K>

The requested setting.

Throws

Error if no setting with the specified name exists.

Implementation of

UserSettingManager.getSetting

---

mapTo()

mapTo<M>(map): UserSettingManager<M & SavedFrequencyAllUserSettingTypes>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/SavedFrequenciesUserSettings.ts:78

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, SavedFrequencyAllUserSettingTypes>	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 & SavedFrequencyAllUserSettingTypes>

A new setting manager which supports accessing a subset of this manager's settings using aliased names.

Implementation of

UserSettingManager.mapTo

---

tryGetSetting()

tryGetSetting<K>(name): OptionalUserSettingFromManager<SavedFrequencyAllUserSettingTypes, K>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/SavedFrequenciesUserSettings.ts:58

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<SavedFrequencyAllUserSettingTypes, K>

The requested setting, or undefined if no such setting exists.

Implementation of

UserSettingManager.tryGetSetting

---

whenSettingChanged()

whenSettingChanged<K>(name): UserSettingConsumerFromManager<SavedFrequencyAllUserSettingTypes, K>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/SavedFrequenciesUserSettings.ts:68

Gets a consumer which notifies handlers when the value of a setting changes.

Type Parameters

Type Parameter

K extends "frequencyComRecent_2_g3x" | "frequencyComRecent_4_g3x" | "frequencyComRecent_16_g3x" | "frequencyComRecent_1_g3x" | "frequencyComRecent_3_g3x" | "frequencyComRecent_6_g3x" | "frequencyComRecent_5_g3x" | "frequencyComRecent_7_g3x" | "frequencyComRecent_8_g3x" | "frequencyComRecent_9_g3x" | "frequencyComRecent_10_g3x" | "frequencyComRecent_11_g3x" | "frequencyComRecent_12_g3x" | "frequencyComRecent_13_g3x" | "frequencyComRecent_14_g3x" | "frequencyComRecent_15_g3x" | "frequencyComUser_2_g3x" | "frequencyComUser_4_g3x" | "frequencyComUser_16_g3x" | "frequencyComUser_1_g3x" | "frequencyComUser_3_g3x" | "frequencyComUser_6_g3x" | "frequencyComUser_5_g3x" | "frequencyComUser_7_g3x" | "frequencyComUser_8_g3x" | "frequencyComUser_9_g3x" | "frequencyComUser_10_g3x" | "frequencyComUser_11_g3x" | "frequencyComUser_12_g3x" | "frequencyComUser_13_g3x" | "frequencyComUser_14_g3x" | "frequencyComUser_15_g3x" | "frequencyNavRecent_2_g3x" | "frequencyNavRecent_4_g3x" | "frequencyNavRecent_16_g3x" | "frequencyNavRecent_1_g3x" | "frequencyNavRecent_3_g3x" | "frequencyNavRecent_6_g3x" | "frequencyNavRecent_5_g3x" | "frequencyNavRecent_7_g3x" | "frequencyNavRecent_8_g3x" | "frequencyNavRecent_9_g3x" | "frequencyNavRecent_10_g3x" | "frequencyNavRecent_11_g3x" | "frequencyNavRecent_12_g3x" | "frequencyNavRecent_13_g3x" | "frequencyNavRecent_14_g3x" | "frequencyNavRecent_15_g3x" | "frequencyNavUser_2_g3x" | "frequencyNavUser_4_g3x" | "frequencyNavUser_16_g3x" | "frequencyNavUser_1_g3x" | "frequencyNavUser_3_g3x" | "frequencyNavUser_6_g3x" | "frequencyNavUser_5_g3x" | "frequencyNavUser_7_g3x" | "frequencyNavUser_8_g3x" | "frequencyNavUser_9_g3x" | "frequencyNavUser_10_g3x" | "frequencyNavUser_11_g3x" | "frequencyNavUser_12_g3x" | "frequencyNavUser_13_g3x" | "frequencyNavUser_14_g3x" | "frequencyNavUser_15_g3x"

Parameters

Parameter	Type	Description
name	K	The name of a setting.

Returns

UserSettingConsumerFromManager<SavedFrequencyAllUserSettingTypes, 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.

Implementation of

UserSettingManager.whenSettingChanged