Class: SoftKeyBar
The Garmin softkeys tab display for the PFD and MFD.
Hierarchy
DisplayComponent<SoftKeysProps>↳
SoftKeyBar
Constructors
constructor
• new SoftKeyBar(props): SoftKeyBar
Creates an instance of SoftKeys.
Parameters
| Name | Type | Description |
|---|---|---|
props | SoftKeysProps | The properties to use. |
Returns
Overrides
DisplayComponent\<SoftKeysProps\>.constructor
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/SoftKeyBar.tsx:32
Properties
context
• Optional context: [] = undefined
The context on this component, if any.
Inherited from
DisplayComponent.context
Defined in
sdk/components/FSComponent.ts:64
contextType
• Optional Readonly contextType: readonly [] = undefined
The type of context for this component, if any.
Inherited from
DisplayComponent.contextType
Defined in
sdk/components/FSComponent.ts:67
props
• props: SoftKeysProps & ComponentProps
The properties of the component.
Inherited from
DisplayComponent.props
Defined in
sdk/components/FSComponent.ts:61
Methods
destroy
▸ destroy(): void
Destroys this component.
Returns
void
Inherited from
DisplayComponent.destroy
Defined in
sdk/components/FSComponent.ts:98
getContext
▸ getContext(context): never
Gets a context data subscription from the context collection.
Parameters
| Name | Type | Description |
|---|---|---|
context | never | The context to get the subscription for. |
Returns
never
The requested context.
Throws
An error if no data for the specified context type could be found.
Inherited from
DisplayComponent.getContext
Defined in
sdk/components/FSComponent.ts:106
onAfterRender
▸ onAfterRender(): void
Starts the softkey HEvent listener after render.
Returns
void
Overrides
DisplayComponent.onAfterRender
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/SoftKeyBar.tsx:56
onBeforeRender
▸ onBeforeRender(): void
A callback that is called before the component is rendered.
Returns
void
Inherited from
DisplayComponent.onBeforeRender
Defined in
sdk/components/FSComponent.ts:80
render
▸ render(): VNode
Renders the component.
Returns
VNode
The rendered component.
Overrides
DisplayComponent.render
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/SoftKeyBar.tsx:73
setMenuItem
▸ setMenuItem(index, menuItem): void
Binds a menu item to a soft key.
Parameters
| Name | Type | Description |
|---|---|---|
index | number | the index of the softkey |
menuItem | MenuItem | the menu item to set |
Returns
void
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/SoftKeyBar.tsx:65