Skip to main content

Interface: G3XUnitsUserSettingManager

A manager for G3X Touch display units user settings.

Hierarchy

Implemented by

Properties

altitudeUnits

Readonly altitudeUnits: Subscribable<Unit<Distance>>

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

Inherited from

UnitsUserSettingManager.altitudeUnits

Defined in

src/garminsdk/settings/UnitsUserSettings.ts:106


baroPressureUnits

Readonly baroPressureUnits: Subscribable<Unit<Pressure>>

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

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Settings/G3XUnitsUserSettings.ts:52


distanceUnitsLarge

Readonly distanceUnitsLarge: Subscribable<Unit<Distance>>

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

Inherited from

UnitsUserSettingManager.distanceUnitsLarge

Defined in

src/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.

Inherited from

UnitsUserSettingManager.distanceUnitsSmall

Defined in

src/garminsdk/settings/UnitsUserSettings.ts:100


fuelEconomyUnits

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

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

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Settings/G3XUnitsUserSettings.ts:54


fuelFlowUnits

Readonly fuelFlowUnits: Subscribable<Unit<WeightFlux>>

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

Inherited from

UnitsUserSettingManager.fuelFlowUnits

Defined in

src/garminsdk/settings/UnitsUserSettings.ts:124


fuelUnits

Readonly fuelUnits: Subscribable<Unit<Weight>>

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

Inherited from

UnitsUserSettingManager.fuelUnits

Defined in

src/garminsdk/settings/UnitsUserSettings.ts:121


Readonly navAngleUnits: Subscribable<NavAngleUnit>

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

Inherited from

UnitsUserSettingManager.navAngleUnits

Defined in

src/garminsdk/settings/UnitsUserSettings.ts:94


speedUnits

Readonly speedUnits: Subscribable<Unit<Speed>>

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

Inherited from

UnitsUserSettingManager.speedUnits

Defined in

src/garminsdk/settings/UnitsUserSettings.ts:103


temperatureDeltaUnits

Readonly temperatureDeltaUnits: Subscribable<Unit<TemperatureDelta>>

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

Inherited from

UnitsUserSettingManager.temperatureDeltaUnits

Defined in

src/garminsdk/settings/UnitsUserSettings.ts:115


temperatureUnits

Readonly temperatureUnits: Subscribable<Unit<Temperature>>

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

Inherited from

UnitsUserSettingManager.temperatureUnits

Defined in

src/garminsdk/settings/UnitsUserSettings.ts:112


verticalSpeedUnits

Readonly verticalSpeedUnits: Subscribable<Unit<Speed>>

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

Inherited from

UnitsUserSettingManager.verticalSpeedUnits

Defined in

src/garminsdk/settings/UnitsUserSettings.ts:109


weightUnits

Readonly weightUnits: Subscribable<Unit<Weight>>

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

Inherited from

UnitsUserSettingManager.weightUnits

Defined in

src/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

UnitsUserSettingManager.getAllSettings

Defined in

src/sdk/settings/UserSetting.ts:96


getSetting

getSetting<K>(name): UserSetting<NonNullable<G3XUnitsUserSettingTypes[K]>>

Gets a setting from this manager.

Type parameters

NameType
Kextends "unitsNavAngle" | "unitsDistance" | "unitsAltitude" | "unitsTemperature" | "unitsWeight" | "unitsFuel" | "unitsBaroPressure" | "unitsFuelEconomy"

Parameters

NameTypeDescription
nameKThe 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

Defined in

src/sdk/settings/UserSetting.ts:82


mapTo

mapTo<M>(map): UserSettingManager<M & UnitsUserSettingTypes & { unitsBaroPressure: G3XUnitsBaroPressureSettingMode ; unitsFuelEconomy: G3XUnitsFuelEconomySettingMode }>

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

NameType
Mextends UserSettingRecord

Parameters

NameTypeDescription
mapUserSettingMap<M, G3XUnitsUserSettingTypes>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 & { unitsBaroPressure: G3XUnitsBaroPressureSettingMode ; unitsFuelEconomy: G3XUnitsFuelEconomySettingMode }>

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

Inherited from

UnitsUserSettingManager.mapTo

Defined in

src/sdk/settings/UserSetting.ts:105


tryGetSetting

tryGetSetting<K>(name): undefined | UserSetting<NonNullable<G3XUnitsUserSettingTypes[K]>>

Attempts to get a setting from this manager.

Type parameters

NameType
Kextends string

Parameters

NameTypeDescription
nameKThe 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

Defined in

src/sdk/settings/UserSetting.ts:74


whenSettingChanged

whenSettingChanged<K>(name): Consumer<NonNullable<G3XUnitsUserSettingTypes[K]>>

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

Type parameters

NameType
Kextends "unitsNavAngle" | "unitsDistance" | "unitsAltitude" | "unitsTemperature" | "unitsWeight" | "unitsFuel" | "unitsBaroPressure" | "unitsFuelEconomy"

Parameters

NameTypeDescription
nameKThe 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

Defined in

src/sdk/settings/UserSetting.ts:90