Class: DefaultG3XUnitsUserSettingManager

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/G3XUnitsUserSettings.ts:77

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

Extends

• DefaultUnitsUserSettingManager<G3XUnitsUserSettingTypes>

Implements

• G3XUnitsUserSettingManager

Constructors

Constructor

new DefaultG3XUnitsUserSettingManager(sourceSettingManager): DefaultG3XUnitsUserSettingManager

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/G3XUnitsUserSettings.ts:90

Creates a new instance of DefaultG3XUnitsUserSettingManager.

Parameters

Parameter	Type	Description
sourceSettingManager	UserSettingManager<G3XUnitsUserSettingTypes>	The manager from which to source setting values.

Returns

DefaultG3XUnitsUserSettingManager

Overrides

DefaultUnitsUserSettingManager.constructor

Properties

altitudeUnits

readonly altitudeUnits: Subscribable<Unit<Distance>>

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

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

Implementation of

G3XUnitsUserSettingManager.altitudeUnits

Inherited from

DefaultUnitsUserSettingManager.altitudeUnits

---

baroPressureUnits

readonly baroPressureUnits: Subscribable<Unit<Pressure>>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/G3XUnitsUserSettings.ts:80

The barometric pressure units to use for the current barometric pressure units setting.

Implementation of

G3XUnitsUserSettingManager.baroPressureUnits

---

distanceUnitsLarge

readonly distanceUnitsLarge: Subscribable<Unit<Distance>>

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

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

Implementation of

G3XUnitsUserSettingManager.distanceUnitsLarge

Inherited from

DefaultUnitsUserSettingManager.distanceUnitsLarge

---

distanceUnitsSmall

readonly distanceUnitsSmall: Subscribable<Unit<Distance>>

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

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

Implementation of

G3XUnitsUserSettingManager.distanceUnitsSmall

Inherited from

DefaultUnitsUserSettingManager.distanceUnitsSmall

---

fuelEconomyUnits

readonly fuelEconomyUnits: Subscribable<Unit<DistancePerWeight | WeightPerDistance>>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/G3XUnitsUserSettings.ts:84

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

Implementation of

G3XUnitsUserSettingManager.fuelEconomyUnits

---

fuelFlowUnits

readonly fuelFlowUnits: Subscribable<Unit<WeightFlux>>

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

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

Implementation of

G3XUnitsUserSettingManager.fuelFlowUnits

Inherited from

DefaultUnitsUserSettingManager.fuelFlowUnits

---

fuelUnits

readonly fuelUnits: Subscribable<Unit<Weight>>

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

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

Implementation of

G3XUnitsUserSettingManager.fuelUnits

Inherited from

DefaultUnitsUserSettingManager.fuelUnits

---

navAngleUnits

readonly navAngleUnits: Subscribable<NavAngleUnit>

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

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

Implementation of

G3XUnitsUserSettingManager.navAngleUnits

Inherited from

DefaultUnitsUserSettingManager.navAngleUnits

---

speedUnits

readonly speedUnits: Subscribable<Unit<Speed>>

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

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

Implementation of

G3XUnitsUserSettingManager.speedUnits

Inherited from

DefaultUnitsUserSettingManager.speedUnits

---

temperatureDeltaUnits

readonly temperatureDeltaUnits: Subscribable<Unit<TemperatureDelta>>

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

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

Implementation of

G3XUnitsUserSettingManager.temperatureDeltaUnits

Inherited from

DefaultUnitsUserSettingManager.temperatureDeltaUnits

---

temperatureUnits

readonly temperatureUnits: Subscribable<Unit<Temperature>>

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

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

Implementation of

G3XUnitsUserSettingManager.temperatureUnits

Inherited from

DefaultUnitsUserSettingManager.temperatureUnits

---

verticalSpeedUnits

readonly verticalSpeedUnits: Subscribable<Unit<Speed>>

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

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

Implementation of

G3XUnitsUserSettingManager.verticalSpeedUnits

Inherited from

DefaultUnitsUserSettingManager.verticalSpeedUnits

---

weightUnits

readonly weightUnits: Subscribable<Unit<Weight>>

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

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

Implementation of

G3XUnitsUserSettingManager.weightUnits

Inherited from

DefaultUnitsUserSettingManager.weightUnits

Methods

getAllSettings()

getAllSettings(): UserSetting<UserSettingValue>[]

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

Gets an array of all settings of this manager.

Returns

UserSetting<UserSettingValue>[]

an array of all settings of this manager.

Implementation of

G3XUnitsUserSettingManager.getAllSettings

Inherited from

DefaultUnitsUserSettingManager.getAllSettings

---

getSetting()

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

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

Gets a setting from this manager.

Type Parameters

Type Parameter
K extends "unitsNavAngle" | "unitsDistance" | "unitsAltitude" | "unitsTemperature" | "unitsWeight" | "unitsFuel" | "unitsBaroPressure" | "unitsFuelEconomy"

Parameters

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

Returns

UserSettingFromManager<G3XUnitsUserSettingTypes, K>

The requested setting.

Throws

Error if no setting with the specified name exists.

Implementation of

G3XUnitsUserSettingManager.getSetting

Inherited from

DefaultUnitsUserSettingManager.getSetting

---

mapTo()

mapTo<M>(map): UserSettingManager<M & UnitsUserSettingTypes & object>

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

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 & UnitsUserSettingTypes & object>

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

Implementation of

G3XUnitsUserSettingManager.mapTo

Inherited from

DefaultUnitsUserSettingManager.mapTo

---

tryGetSetting()

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

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

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

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

Implementation of

G3XUnitsUserSettingManager.tryGetSetting

Inherited from

DefaultUnitsUserSettingManager.tryGetSetting

---

whenSettingChanged()

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

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

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

Type Parameters

Type Parameter
K extends "unitsNavAngle" | "unitsDistance" | "unitsAltitude" | "unitsTemperature" | "unitsWeight" | "unitsFuel" | "unitsBaroPressure" | "unitsFuelEconomy"

Parameters

Parameter	Type	Description
name	K	The name of a setting.

Returns

UserSettingConsumerFromManager<G3XUnitsUserSettingTypes, 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

G3XUnitsUserSettingManager.whenSettingChanged

Inherited from

DefaultUnitsUserSettingManager.whenSettingChanged