Skip to main content

Class: SoftKey

A softkey tab in the soft key bar interface.

Hierarchy

  • DisplayComponent<SoftKeyProps>

    SoftKey

Constructors

constructor

new SoftKey(props): SoftKey

Creates an instance of a DisplayComponent.

Parameters

NameTypeDescription
propsSoftKeyPropsThe propertis of the component.

Returns

SoftKey

Inherited from

DisplayComponent<SoftKeyProps>.constructor

Defined in

sdk/components/FSComponent.ts:73

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: SoftKeyProps & 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

NameTypeDescription
contextneverThe 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(node): void

Parameters

NameType
nodeVNode

Returns

void

Inherit Doc

Overrides

DisplayComponent.onAfterRender

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/Menus/SoftKey.tsx:28


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 VNode.

Overrides

DisplayComponent.render

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/Menus/SoftKey.tsx:197


setMenuItem

setMenuItem(item): void

Sets and binds a menu item to this soft key.

Parameters

NameTypeDescription
itemMenuItemthe menu item

Returns

void

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/Menus/SoftKey.tsx:37