Interface: G3XUnitsUserSettingManager
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/G3XUnitsUserSettings.ts:66
A manager for G3X Touch display units user settings.
Extends
UnitsUserSettingManager
<G3XUnitsUserSettingTypes
>
Properties
altitudeUnits
readonly
altitudeUnits:Subscribable
<Unit
<Distance
>>
Defined in: src/garminsdk/settings/UnitsUserSettings.ts:118
The altitude units to use for the current altitude units setting.
Inherited from
UnitsUserSettingManager.altitudeUnits
baroPressureUnits
readonly
baroPressureUnits:Subscribable
<Unit
<Pressure
>>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/G3XUnitsUserSettings.ts:68
The barometric pressure units to use for the current barometric pressure units setting.
distanceUnitsLarge
readonly
distanceUnitsLarge:Subscribable
<Unit
<Distance
>>
Defined in: src/garminsdk/settings/UnitsUserSettings.ts:109
The large distance units to use (nautical mile, kilometer, etc.) for the current distance units setting.
Inherited from
UnitsUserSettingManager.distanceUnitsLarge
distanceUnitsSmall
readonly
distanceUnitsSmall:Subscribable
<Unit
<Distance
>>
Defined in: src/garminsdk/settings/UnitsUserSettings.ts:112
The small distance units to use (foot, meter, etc.) for the current distance units setting.
Inherited from
UnitsUserSettingManager.distanceUnitsSmall
fuelEconomyUnits
readonly
fuelEconomyUnits:Subscribable
<Unit
<DistancePerWeight
|WeightPerDistance
>>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Settings/G3XUnitsUserSettings.ts:70
The fuel economy units to use for the current fuel economy units setting.
fuelFlowUnits
readonly
fuelFlowUnits:Subscribable
<Unit
<WeightFlux
>>
Defined in: src/garminsdk/settings/UnitsUserSettings.ts:136
The fuel flow units to use for the current fuel units setting.
Inherited from
UnitsUserSettingManager.fuelFlowUnits
fuelUnits
readonly
fuelUnits:Subscribable
<Unit
<Weight
>>
Defined in: src/garminsdk/settings/UnitsUserSettings.ts:133
The fuel units to use for the current fuel units setting.
Inherited from
UnitsUserSettingManager.fuelUnits
navAngleUnits
readonly
navAngleUnits:Subscribable
<NavAngleUnit
>
Defined in: src/garminsdk/settings/UnitsUserSettings.ts:106
The nav angle units to use for the current nav angle units setting.
Inherited from
UnitsUserSettingManager.navAngleUnits
speedUnits
readonly
speedUnits:Subscribable
<Unit
<Speed
>>
Defined in: src/garminsdk/settings/UnitsUserSettings.ts:115
The speed units to use for the current distance units setting.
Inherited from
UnitsUserSettingManager.speedUnits
temperatureDeltaUnits
readonly
temperatureDeltaUnits:Subscribable
<Unit
<TemperatureDelta
>>
Defined in: src/garminsdk/settings/UnitsUserSettings.ts:127
The temperature delta units to use for the current temperature units setting.
Inherited from
UnitsUserSettingManager.temperatureDeltaUnits
temperatureUnits
readonly
temperatureUnits:Subscribable
<Unit
<Temperature
>>
Defined in: src/garminsdk/settings/UnitsUserSettings.ts:124
The temperature units to use for the current temperature units setting.
Inherited from
UnitsUserSettingManager.temperatureUnits
verticalSpeedUnits
readonly
verticalSpeedUnits:Subscribable
<Unit
<Speed
>>
Defined in: src/garminsdk/settings/UnitsUserSettings.ts:121
The vertical speed units to use for the current altitude units setting.
Inherited from
UnitsUserSettingManager.verticalSpeedUnits
weightUnits
readonly
weightUnits:Subscribable
<Unit
<Weight
>>
Defined in: src/garminsdk/settings/UnitsUserSettings.ts:130
The weight units to use for the current weight units setting.
Inherited from
UnitsUserSettingManager.weightUnits
Methods
getAllSettings()
getAllSettings():
UserSetting
<UserSettingValue
>[]
Defined in: src/sdk/settings/UserSetting.ts:96
Gets an array of all settings of this manager.
Returns
UserSetting
<UserSettingValue
>[]
an array of all settings of this manager.
Inherited from
UnitsUserSettingManager.getAllSettings
getSetting()
getSetting<
K
>(name
):UserSetting
<NonNullable
<G3XUnitsUserSettingTypes
[K
]>>
Defined in: src/sdk/settings/UserSetting.ts:82
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
UserSetting
<NonNullable
<G3XUnitsUserSettingTypes
[K
]>>
The requested setting.
Throws
Error if no setting with the specified name exists.
Inherited from
UnitsUserSettingManager.getSetting
mapTo()
mapTo<
M
>(map
):UserSettingManager
<M
&UnitsUserSettingTypes
&object
>
Defined in: src/sdk/settings/UserSetting.ts:105
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.
Inherited from
UnitsUserSettingManager.mapTo
tryGetSetting()
tryGetSetting<
K
>(name
):undefined
|UserSetting
<NonNullable
<G3XUnitsUserSettingTypes
[K
]>>
Defined in: src/sdk/settings/UserSetting.ts:74
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
undefined
| UserSetting
<NonNullable
<G3XUnitsUserSettingTypes
[K
]>>
The requested setting, or undefined
if no such setting exists.
Inherited from
UnitsUserSettingManager.tryGetSetting
whenSettingChanged()
whenSettingChanged<
K
>(name
):Consumer
<NonNullable
<G3XUnitsUserSettingTypes
[K
]>>
Defined in: src/sdk/settings/UserSetting.ts:90
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
Consumer
<NonNullable
<G3XUnitsUserSettingTypes
[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
UnitsUserSettingManager.whenSettingChanged