Skip to main content

Class: SoftKeyWeatherOverlayController

Defined in: workingtitle-instruments-g3000/html_ui/PFD/SoftKey/SoftKeyWeatherOverlayController.ts:17

A controller which binds a softkey to a state which can take one of several enumerated values. Once bound, the softkey will display the bound state and each press of the softkey will cycle the state through possible values.

Constructors

Constructor

new SoftKeyWeatherOverlayController(softkeyMenu, softkeyIndex, softkeyLabel, mapSettingManager): SoftKeyWeatherOverlayController

Defined in: workingtitle-instruments-g3000/html_ui/PFD/SoftKey/SoftKeyWeatherOverlayController.ts:34

Constructor.

Parameters

ParameterTypeDescription
softkeyMenuSoftKeyMenuThe softkey menu to which this controller's softkey belongs.
softkeyIndexnumberThe index in the softkey menu at which this controller's softkey is located.
softkeyLabelstringThe text label of this controller's softkey.
mapSettingManagerUserSettingManager<MapUserSettingTypes>A manager for map user settings.

Returns

SoftKeyWeatherOverlayController

Methods

destroy()

destroy(): void

Defined in: workingtitle-instruments-g3000/html_ui/PFD/SoftKey/SoftKeyWeatherOverlayController.ts:112

Destroys this controller. This will remove the softkey menu item bound to this controller's state.

Returns

void


init()

init(): SoftKeyMenuItem

Defined in: workingtitle-instruments-g3000/html_ui/PFD/SoftKey/SoftKeyWeatherOverlayController.ts:47

Initializes this controller. This will create a softkey menu item and bind it to this controller's state.

Returns

SoftKeyMenuItem

The softkey menu item bound to this controller's state.

Throws

Error if this controller has been destroyed.