Interface: UnitsUserSettingManager<T>

Defined in: garminsdk/settings/UnitsUserSettings.ts:105

A manager for Garmin display units user settings.

Extends

• UserSettingManager<T>

Type Parameters

Type Parameter	Default type
T extends UnitsUserSettingTypes & UserSettingRecord	UnitsUserSettingTypes

Properties

altitudeUnits

readonly altitudeUnits: Subscribable<Unit<Distance>>

Defined in: garminsdk/settings/UnitsUserSettings.ts:119

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

---

distanceUnitsLarge

readonly distanceUnitsLarge: Subscribable<Unit<Distance>>

Defined in: garminsdk/settings/UnitsUserSettings.ts:110

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

---

distanceUnitsSmall

readonly distanceUnitsSmall: Subscribable<Unit<Distance>>

Defined in: garminsdk/settings/UnitsUserSettings.ts:113

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

---

fuelFlowUnits

readonly fuelFlowUnits: Subscribable<Unit<WeightFlux>>

Defined in: garminsdk/settings/UnitsUserSettings.ts:137

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

---

fuelUnits

readonly fuelUnits: Subscribable<Unit<Weight>>

Defined in: garminsdk/settings/UnitsUserSettings.ts:134

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

---

navAngleUnits

readonly navAngleUnits: Subscribable<NavAngleUnit>

Defined in: garminsdk/settings/UnitsUserSettings.ts:107

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

---

speedUnits

readonly speedUnits: Subscribable<Unit<Speed>>

Defined in: garminsdk/settings/UnitsUserSettings.ts:116

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

---

temperatureDeltaUnits

readonly temperatureDeltaUnits: Subscribable<Unit<TemperatureDelta>>

Defined in: garminsdk/settings/UnitsUserSettings.ts:128

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

---

temperatureUnits

readonly temperatureUnits: Subscribable<Unit<Temperature>>

Defined in: garminsdk/settings/UnitsUserSettings.ts:125

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

---

verticalSpeedUnits

readonly verticalSpeedUnits: Subscribable<Unit<Speed>>

Defined in: garminsdk/settings/UnitsUserSettings.ts:122

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

---

weightUnits

readonly weightUnits: Subscribable<Unit<Weight>>

Defined in: garminsdk/settings/UnitsUserSettings.ts:131

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

Methods

getAllSettings()

getAllSettings(): UserSetting<UserSettingValue>[]

Defined in: sdk/settings/UserSetting.ts:128

Gets an array of all settings of this manager.

Returns

UserSetting<UserSettingValue>[]

an array of all settings of this manager.

Inherited from

UserSettingManager.getAllSettings

---

getSetting()

getSetting<K>(name): UserSetting<ToNonNullable<PropertyTypeOf<T, K>>>

Defined in: sdk/settings/UserSetting.ts:113

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<ToNonNullable<PropertyTypeOf<T, K>>>

The requested setting.

Throws

Error if no setting with the specified name exists.

Inherited from

UserSettingManager.getSetting

---

mapTo()

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

Defined in: sdk/settings/UserSetting.ts:137

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.

Inherited from

UserSettingManager.mapTo

---

tryGetSetting()

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

Defined in: sdk/settings/UserSetting.ts:105

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

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

Inherited from

UserSettingManager.tryGetSetting

---

whenSettingChanged()

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

Defined in: sdk/settings/UserSetting.ts:122

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

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

Inherited from

UserSettingManager.whenSettingChanged