Class: DefaultUnitsUserSettingManager<T>

Defined in: src/garminsdk/settings/UnitsUserSettings.ts:168

A default implementation of UnitsUserSettingManager which sources setting values from another setting manager.

Type Parameters

Type Parameter	Default type
T extends UnitsUserSettingTypes & UserSettingRecord	UnitsUserSettingTypes

Implements

• UnitsUserSettingManager<T>

Constructors

Constructor

new DefaultUnitsUserSettingManager<T>(sourceSettingManager, options?): DefaultUnitsUserSettingManager<T>

Defined in: src/garminsdk/settings/UnitsUserSettings.ts:224

Creates a new instance of DefaultUnitsUserSettingManager.

Parameters

Parameter	Type	Description
sourceSettingManager	UserSettingManager<T>	The manager from which to source setting values.
options?	Readonly<DefaultUnitsUserSettingManagerOptions>	Options with which to configure the manager.

Returns

DefaultUnitsUserSettingManager<T>

Properties

altitudeUnits

readonly altitudeUnits: Subscribable<Unit<Distance>>

Defined in: src/garminsdk/settings/UnitsUserSettings.ts:190

The altitude units to use for the current altitude units setting.

Implementation of

UnitsUserSettingManager.altitudeUnits

---

distanceUnitsLarge

readonly distanceUnitsLarge: Subscribable<Unit<Distance>>

Defined in: src/garminsdk/settings/UnitsUserSettings.ts:178

The large distance units to use (nautical mile, kilometer, etc.) for the current distance units setting.

Implementation of

UnitsUserSettingManager.distanceUnitsLarge

---

distanceUnitsSmall

readonly distanceUnitsSmall: Subscribable<Unit<Distance>>

Defined in: src/garminsdk/settings/UnitsUserSettings.ts:182

The small distance units to use (foot, meter, etc.) for the current distance units setting.

Implementation of

UnitsUserSettingManager.distanceUnitsSmall

---

fuelFlowUnits

readonly fuelFlowUnits: Subscribable<Unit<WeightFlux>>

Defined in: src/garminsdk/settings/UnitsUserSettings.ts:214

The fuel flow units to use for the current fuel units setting.

Implementation of

UnitsUserSettingManager.fuelFlowUnits

---

fuelUnits

readonly fuelUnits: Subscribable<Unit<Weight>>

Defined in: src/garminsdk/settings/UnitsUserSettings.ts:210

The fuel units to use for the current fuel units setting.

Implementation of

UnitsUserSettingManager.fuelUnits

---

navAngleUnits

readonly navAngleUnits: Subscribable<NavAngleUnit>

Defined in: src/garminsdk/settings/UnitsUserSettings.ts:174

The nav angle units to use for the current nav angle units setting.

Implementation of

UnitsUserSettingManager.navAngleUnits

---

speedUnits

readonly speedUnits: Subscribable<Unit<Speed>>

Defined in: src/garminsdk/settings/UnitsUserSettings.ts:186

The speed units to use for the current distance units setting.

Implementation of

UnitsUserSettingManager.speedUnits

---

temperatureDeltaUnits

readonly temperatureDeltaUnits: Subscribable<Unit<TemperatureDelta>>

Defined in: src/garminsdk/settings/UnitsUserSettings.ts:202

The temperature delta units to use for the current temperature units setting.

Implementation of

UnitsUserSettingManager.temperatureDeltaUnits

---

temperatureUnits

readonly temperatureUnits: Subscribable<Unit<Temperature>>

Defined in: src/garminsdk/settings/UnitsUserSettings.ts:198

The temperature units to use for the current temperature units setting.

Implementation of

UnitsUserSettingManager.temperatureUnits

---

verticalSpeedUnits

readonly verticalSpeedUnits: Subscribable<Unit<Speed>>

Defined in: src/garminsdk/settings/UnitsUserSettings.ts:194

The vertical speed units to use for the current altitude units setting.

Implementation of

UnitsUserSettingManager.verticalSpeedUnits

---

weightUnits

readonly weightUnits: Subscribable<Unit<Weight>>

Defined in: src/garminsdk/settings/UnitsUserSettings.ts:206

The weight units to use for the current weight units setting.

Implementation of

UnitsUserSettingManager.weightUnits

Methods

getAllSettings()

getAllSettings(): UserSetting<UserSettingValue>[]

Defined in: src/garminsdk/settings/UnitsUserSettings.ts:373

Gets an array of all settings of this manager.

Returns

UserSetting<UserSettingValue>[]

an array of all settings of this manager.

Implementation of

UnitsUserSettingManager.getAllSettings

---

getSetting()

getSetting<K>(name): UserSetting<NonNullable<T[K]>>

Defined in: src/garminsdk/settings/UnitsUserSettings.ts:363

Gets 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

UserSetting<NonNullable<T[K]>>

The requested setting.

Throws

Error if no setting with the specified name exists.

Implementation of

UnitsUserSettingManager.getSetting

---

mapTo()

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

Defined in: src/garminsdk/settings/UnitsUserSettings.ts:378

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

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

Implementation of

UnitsUserSettingManager.mapTo

---

tryGetSetting()

tryGetSetting<K>(name): K extends keyof T ? UserSetting<NonNullable<T[K<K>]>> : undefined

Defined in: src/garminsdk/settings/UnitsUserSettings.ts:358

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

K extends keyof T ? UserSetting<NonNullable<T[K<K>]>> : undefined

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

Implementation of

UnitsUserSettingManager.tryGetSetting

---

whenSettingChanged()

whenSettingChanged<K>(name): Consumer<NonNullable<T[K]>>

Defined in: src/garminsdk/settings/UnitsUserSettings.ts:368

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

Type Parameters

Type Parameter
K extends string

Parameters

Parameter	Type	Description
name	K	The name of a setting.

Returns

Consumer<NonNullable<T[K]>>

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

Throws

Error if no setting with the specified name exists.

Implementation of

UnitsUserSettingManager.whenSettingChanged