Class: VSpeedUserSettingUtils

Defined in: src/garminsdk/settings/VSpeedUserSettings.ts:26

A utility class for working with reference V-speed user settings.

Constructors

Constructor

new VSpeedUserSettingUtils(): VSpeedUserSettingUtils

Returns

VSpeedUserSettingUtils

Methods

activeValue()

Call Signature

static activeValue(name, settingManager, useFmsValue, allowZeroValue?): MappedSubscribable<number>

Defined in: src/garminsdk/settings/VSpeedUserSettings.ts:41

Creates a mapped subscribable which provides the active value of a reference V-speed, in knots. The active value is derived from the following values (in order of decreasing precedence):

1. User-defined value.
2. FMS-defined value.
3. Default value.

Parameters

Parameter	Type	Description
name	string	The name of the reference V-speed.
settingManager	UserSettingManager<Omit<VSpeedUserSettingTypes, `vSpeedShow_${string}`>>	A manager for reference V-speed user settings.
useFmsValue	true	Whether to support the V-speed's FMS-defined value.
allowZeroValue?	boolean	Whether to allow the active value to be equal to zero. If false, a value of zero is treated as an undefined value (similar to negative values). Defaults to false.

Returns

MappedSubscribable<number>

A mapped subscribable which provides the active value of the specified reference V-speed, in knots.

Call Signature

static activeValue(name, settingManager, useFmsValue, allowZeroValue?): MappedSubscribable<number>

Defined in: src/garminsdk/settings/VSpeedUserSettings.ts:60

Creates a mapped subscribable which provides the active value of a reference V-speed, in knots. The active value is derived from the following values (in order of decreasing precedence):

1. User-defined value.
2. Default value.

Parameters

Parameter	Type	Description
name	string	The name of the reference V-speed.
settingManager	UserSettingManager<Omit<VSpeedUserSettingTypes, `vSpeedFmsValue_${string}` | `vSpeedShow_${string}`>>	A manager for reference V-speed user settings.
useFmsValue	false	Whether to support the V-speed's FMS-defined value.
allowZeroValue?	boolean	Whether to allow the active value to be equal to zero. If false, a value of zero is treated as an undefined value (similar to negative values). Defaults to false.

Returns

MappedSubscribable<number>

A mapped subscribable which provides the active value of the specified reference V-speed, in knots.

---

isFmsValueActive()

static isFmsValueActive(name, settingManager): MappedSubscribable<boolean>

Defined in: src/garminsdk/settings/VSpeedUserSettings.ts:181

Creates a mapped subscribable which provides whether a reference V-speed is using its FMS-defined value as its active value.

Parameters

Parameter	Type	Description
name	string	The name of the reference V-speed.
settingManager	UserSettingManager<Omit<VSpeedUserSettingTypes, `vSpeedShow_${string}`>>	A manager for reference V-speed user settings.

Returns

MappedSubscribable<boolean>

A mapped subscribable which provides whether the specified reference V-speed is using its FMS-defined value as its active value.

---

isUserValueActive()

Call Signature

static isUserValueActive(name, settingManager, useFmsValue): MappedSubscribable<boolean>

Defined in: src/garminsdk/settings/VSpeedUserSettings.ts:122

Creates a mapped subscribable which provides whether a reference V-speed is using its user-defined value as its active value.

Parameters

Parameter	Type	Description
name	string	The name of the reference V-speed.
settingManager	UserSettingManager<Omit<VSpeedUserSettingTypes, `vSpeedShow_${string}`>>	A manager for reference V-speed user settings.
useFmsValue	true	Whether to support the V-speed's FMS-defined value.

Returns

MappedSubscribable<boolean>

A mapped subscribable which provides whether the specified reference V-speed is using its user-defined value as its active value.

Call Signature

static isUserValueActive(name, settingManager, useFmsValue): MappedSubscribable<boolean>

Defined in: src/garminsdk/settings/VSpeedUserSettings.ts:136

Creates a mapped subscribable which provides whether a reference V-speed is using its user-defined value as its active value.

Parameters

Parameter	Type	Description
name	string	The name of the reference V-speed.
settingManager	UserSettingManager<Omit<VSpeedUserSettingTypes, `vSpeedFmsValue_${string}` | `vSpeedShow_${string}`>>	A manager for reference V-speed user settings.
useFmsValue	false	Whether to support the V-speed's FMS-defined value.

Returns

MappedSubscribable<boolean>

A mapped subscribable which provides whether the specified reference V-speed is using its user-defined value as its active value.