Skip to main content

Class: PfdRootSoftKeyMenu

The root PFD softkey menu.

Hierarchy

  • SoftKeyMenu

    PfdRootSoftKeyMenu

Constructors

constructor

new PfdRootSoftKeyMenu(menuSystem, pfdIndex, activeNavIndicator, obsSuspDataProvider, mapLayoutSettingManager, radiosConfig, declutter, isSplit): PfdRootSoftKeyMenu

Creates an instance of the root PFD softkey menu.

Parameters

NameTypeDescription
menuSystemSoftKeyMenuSystemThe softkey menu system.
pfdIndexPfdIndexThe index of the PFD instrument to which this menu belongs.
activeNavIndicatorG3000NavIndicatorThe active nav indicator of this menu's PFD.
obsSuspDataProviderObsSuspDataProviderA provider of OBS/SUSP data.
mapLayoutSettingManagerUserSettingManager<PfdMapLayoutUserSettingTypes>A manager for map layout settings for this menu's PFD.
radiosConfigRadiosConfigThe radios configuration object.
declutterSubscribable<boolean>Whether this menu's parent PFD is decluttered.
isSplitbooleanWhether the menu is a split-mode menu.

Returns

PfdRootSoftKeyMenu

Overrides

SoftKeyMenu.constructor

Defined in

src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/PFD/SoftKey/PfdRootSoftKeyMenu.ts:38

Properties

Protected menuSystem: SoftKeyMenuSystem

The menu system that will manage this menu.

Inherited from

SoftKeyMenu.menuSystem

Defined in

src/garminsdk/softkey/SoftKeyMenu.ts:45


SOFTKEY_COUNT

Static Readonly SOFTKEY_COUNT: 12

The number of softkeys in each menu.

Inherited from

SoftKeyMenu.SOFTKEY_COUNT

Defined in

src/garminsdk/softkey/SoftKeyMenu.ts:36

Methods

addItem

addItem(index, label, handler?, value?, disabled?): SoftKeyMenuItem

Adds a menu item to the softkey menu.

Parameters

NameTypeDefault valueDescription
indexnumberundefinedThe softkey index to add the menu item to. Must be between 0 and 11, inclusive.
labelstringundefinedThe label of the menu item.
handler?(menu: SoftKeyMenu) => voidundefinedThe handler to call when the menu item is selected.
value?string | booleanundefinedThe value of the menu item, if any.
disabledbooleanfalseWhether or not the menu item is disabled.

Returns

SoftKeyMenuItem

The new menu item.

Throws

Error if index is out of bounds.

Inherited from

SoftKeyMenu.addItem

Defined in

src/garminsdk/softkey/SoftKeyMenu.ts:57


destroy

destroy(): void

Returns

void

Inherit Doc

Overrides

SoftKeyMenu.destroy

Defined in

src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/PFD/SoftKey/PfdRootSoftKeyMenu.ts:175


forEach

forEach(each): void

Iterates over the menu items.

Parameters

NameTypeDescription
each(menuItem: null | SoftKeyMenuItem, index: number) => voidThe function to run over each menu item.

Returns

void

Inherited from

SoftKeyMenu.forEach

Defined in

src/garminsdk/softkey/SoftKeyMenu.ts:116


getItem

getItem(index): null | SoftKeyMenuItem

Gets a menu item.

Parameters

NameTypeDescription
indexnumberThe index of the menu item. Must be between 0 and 11, inclusive.

Returns

null | SoftKeyMenuItem

The requested menu item.

Throws

Error if index is out of bounds.

Inherited from

SoftKeyMenu.getItem

Defined in

src/garminsdk/softkey/SoftKeyMenu.ts:97


handleBack

handleBack(): void

Handles a back menu action.

Returns

void

Inherited from

SoftKeyMenu.handleBack

Defined in

src/garminsdk/softkey/SoftKeyMenu.ts:108


handleItemPressed

handleItemPressed(index): void

Handles when a menu item is pressed.

Parameters

NameTypeDescription
indexnumberThe index of the menu item that was pressed.

Returns

void

Inherited from

SoftKeyMenu.handleItemPressed

Defined in

src/garminsdk/softkey/SoftKeyMenu.ts:124


removeItem

removeItem(index): void

Removes a menu item from the menu.

Parameters

NameTypeDescription
indexnumberThe softkey index to remove the menu item from. Must be between 0 and 11, inclusive.

Returns

void

Throws

Error if index is out of bounds.

Inherited from

SoftKeyMenu.removeItem

Defined in

src/garminsdk/softkey/SoftKeyMenu.ts:83