Class: DefaultUnitsUserSettingManager<T>
A default implementation of UnitsUserSettingManager which sources setting values from another setting manager.
Type parameters
| Name | Type |
|---|---|
T | extends UnitsUserSettingTypes & UserSettingRecord = UnitsUserSettingTypes |
Implements
Constructors
constructor
• new DefaultUnitsUserSettingManager<T>(sourceSettingManager): DefaultUnitsUserSettingManager<T>
Creates a new instance of DefaultUnitsUserSettingManager.
Type parameters
| Name | Type |
|---|---|
T | extends UnitsUserSettingTypes & UserSettingRecord = UnitsUserSettingTypes |
Parameters
| Name | Type | Description |
|---|---|---|
sourceSettingManager | UserSettingManager<T> | The manager from which to source setting values. |
Returns
DefaultUnitsUserSettingManager<T>
Defined in
src/garminsdk/settings/UnitsUserSettings.ts:183
Properties
altitudeUnits
• Readonly altitudeUnits: Subscribable<Unit<Distance>>
The altitude units to use for the current altitude units setting.
Implementation of
UnitsUserSettingManager.altitudeUnits
Defined in
src/garminsdk/settings/UnitsUserSettings.ts:153
distanceUnitsLarge
• Readonly distanceUnitsLarge: Subscribable<Unit<Distance>>
The large distance units to use (nautical mile, kilometer, etc.) for the current distance units setting.
Implementation of
UnitsUserSettingManager.distanceUnitsLarge
Defined in
src/garminsdk/settings/UnitsUserSettings.ts:141
distanceUnitsSmall
• Readonly distanceUnitsSmall: Subscribable<Unit<Distance>>
The small distance units to use (foot, meter, etc.) for the current distance units setting.
Implementation of
UnitsUserSettingManager.distanceUnitsSmall
Defined in
src/garminsdk/settings/UnitsUserSettings.ts:145
fuelFlowUnits
• Readonly fuelFlowUnits: Subscribable<Unit<WeightFlux>>
The fuel flow units to use for the current fuel units setting.
Implementation of
UnitsUserSettingManager.fuelFlowUnits
Defined in
src/garminsdk/settings/UnitsUserSettings.ts:177
fuelUnits
• Readonly fuelUnits: Subscribable<Unit<Weight>>
The fuel units to use for the current fuel units setting.
Implementation of
UnitsUserSettingManager.fuelUnits
Defined in
src/garminsdk/settings/UnitsUserSettings.ts:173
navAngleUnits
• Readonly navAngleUnits: Subscribable<NavAngleUnit>
The nav angle units to use for the current nav angle units setting.
Implementation of
UnitsUserSettingManager.navAngleUnits
Defined in
src/garminsdk/settings/UnitsUserSettings.ts:137
speedUnits
• Readonly speedUnits: Subscribable<Unit<Speed>>
The speed units to use for the current distance units setting.
Implementation of
UnitsUserSettingManager.speedUnits
Defined in
src/garminsdk/settings/UnitsUserSettings.ts:149
temperatureDeltaUnits
• Readonly temperatureDeltaUnits: Subscribable<Unit<TemperatureDelta>>
The temperature delta units to use for the current temperature units setting.
Implementation of
UnitsUserSettingManager.temperatureDeltaUnits
Defined in
src/garminsdk/settings/UnitsUserSettings.ts:165
temperatureUnits
• Readonly temperatureUnits: Subscribable<Unit<Temperature>>
The temperature units to use for the current temperature units setting.
Implementation of
UnitsUserSettingManager.temperatureUnits
Defined in
src/garminsdk/settings/UnitsUserSettings.ts:161
verticalSpeedUnits
• Readonly verticalSpeedUnits: Subscribable<Unit<Speed>>
The vertical speed units to use for the current altitude units setting.
Implementation of
UnitsUserSettingManager.verticalSpeedUnits
Defined in
src/garminsdk/settings/UnitsUserSettings.ts:157
weightUnits
• Readonly weightUnits: Subscribable<Unit<Weight>>
The weight units to use for the current weight units setting.
Implementation of
UnitsUserSettingManager.weightUnits
Defined in
src/garminsdk/settings/UnitsUserSettings.ts:169
Methods
getAllSettings
▸ getAllSettings(): UserSetting<UserSettingValue>[]
Gets an array of all settings of this manager.
Returns
UserSetting<UserSettingValue>[]
an array of all settings of this manager.
Implementation of
UnitsUserSettingManager.getAllSettings
Defined in
src/garminsdk/settings/UnitsUserSettings.ts:278
getSetting
▸ getSetting<K>(name): UserSetting<NonNullable<T[K]>>
Gets a setting from this manager.
Type parameters
| Name | Type |
|---|---|
K | extends string |
Parameters
| Name | 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
Defined in
src/garminsdk/settings/UnitsUserSettings.ts:268
mapTo
▸ mapTo<M>(map): UserSettingManager<M & T>
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
| Name | Type |
|---|---|
M | extends UserSettingRecord |
Parameters
| Name | 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
Defined in
src/garminsdk/settings/UnitsUserSettings.ts:283
tryGetSetting
▸ tryGetSetting<K>(name): K extends keyof T ? UserSetting<NonNullable<T[K]>> : undefined
Attempts to get a setting from this manager.
Type parameters
| Name | Type |
|---|---|
K | extends string |
Parameters
| Name | Type | Description |
|---|---|---|
name | K | The name of the setting to get. |
Returns
K extends keyof T ? UserSetting<NonNullable<T[K]>> : undefined
The requested setting, or undefined if no such setting exists.
Implementation of
UnitsUserSettingManager.tryGetSetting
Defined in
src/garminsdk/settings/UnitsUserSettings.ts:263
whenSettingChanged
▸ whenSettingChanged<K>(name): Consumer<NonNullable<T[K]>>
Gets a consumer which notifies handlers when the value of a setting changes.
Type parameters
| Name | Type |
|---|---|
K | extends string |
Parameters
| Name | 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
Defined in
src/garminsdk/settings/UnitsUserSettings.ts:273