Interface: UnitsUserSettingManager<T>
A manager for Garmin display units user settings.
Type parameters
| Name | Type |
|---|---|
T | extends UnitsUserSettingTypes & UserSettingRecord = UnitsUserSettingTypes |
Hierarchy
UserSettingManager<T>↳
UnitsUserSettingManager
Properties
altitudeUnits
• Readonly altitudeUnits: Subscribable<Unit<Distance>>
The altitude units to use for the current altitude units setting.
Defined in
garminsdk/settings/UnitsUserSettings.ts:106
distanceUnitsLarge
• Readonly distanceUnitsLarge: Subscribable<Unit<Distance>>
The large distance units to use (nautical mile, kilometer, etc.) for the current distance units setting.
Defined in
garminsdk/settings/UnitsUserSettings.ts:97
distanceUnitsSmall
• Readonly distanceUnitsSmall: Subscribable<Unit<Distance>>
The small distance units to use (foot, meter, etc.) for the current distance units setting.
Defined in
garminsdk/settings/UnitsUserSettings.ts:100
fuelFlowUnits
• Readonly fuelFlowUnits: Subscribable<Unit<WeightFlux>>
The fuel flow units to use for the current fuel units setting.
Defined in
garminsdk/settings/UnitsUserSettings.ts:124
fuelUnits
• Readonly fuelUnits: Subscribable<Unit<Weight>>
The fuel units to use for the current fuel units setting.
Defined in
garminsdk/settings/UnitsUserSettings.ts:121
navAngleUnits
• Readonly navAngleUnits: Subscribable<NavAngleUnit>
The nav angle units to use for the current nav angle units setting.
Defined in
garminsdk/settings/UnitsUserSettings.ts:94
speedUnits
• Readonly speedUnits: Subscribable<Unit<Speed>>
The speed units to use for the current distance units setting.
Defined in
garminsdk/settings/UnitsUserSettings.ts:103
temperatureDeltaUnits
• Readonly temperatureDeltaUnits: Subscribable<Unit<TemperatureDelta>>
The temperature delta units to use for the current temperature units setting.
Defined in
garminsdk/settings/UnitsUserSettings.ts:115
temperatureUnits
• Readonly temperatureUnits: Subscribable<Unit<Temperature>>
The temperature units to use for the current temperature units setting.
Defined in
garminsdk/settings/UnitsUserSettings.ts:112
verticalSpeedUnits
• Readonly verticalSpeedUnits: Subscribable<Unit<Speed>>
The vertical speed units to use for the current altitude units setting.
Defined in
garminsdk/settings/UnitsUserSettings.ts:109
weightUnits
• Readonly weightUnits: Subscribable<Unit<Weight>>
The weight units to use for the current weight units setting.
Defined in
garminsdk/settings/UnitsUserSettings.ts:118
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.
Inherited from
UserSettingManager.getAllSettings
Defined in
sdk/settings/UserSetting.ts:96
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.
Inherited from
UserSettingManager.getSetting
Defined in
sdk/settings/UserSetting.ts:82
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.
Inherited from
UserSettingManager.mapTo
Defined in
sdk/settings/UserSetting.ts:105
tryGetSetting
▸ tryGetSetting<K>(name): undefined | UserSetting<NonNullable<T[K]>>
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
undefined | UserSetting<NonNullable<T[K]>>
The requested setting, or undefined if no such setting exists.
Inherited from
UserSettingManager.tryGetSetting
Defined in
sdk/settings/UserSetting.ts:74
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.
Inherited from
UserSettingManager.whenSettingChanged
Defined in
sdk/settings/UserSetting.ts:90