Skip to main content

Class: MFDSystemSetupToggleRow<T, K, P>

A row which displays to the right of the title an arrow toggle component which controls the value of a boolean user setting.

Type parameters

NameType
Textends UserSettingRecord
Kextends keyof UserSettingValueFilter<T, boolean> & string
Pextends MFDSystemSetupToggleRowProps<T, K> = MFDSystemSetupToggleRowProps<T, K>

Hierarchy

Constructors

constructor

new MFDSystemSetupToggleRow<T, K, P>(props): MFDSystemSetupToggleRow<T, K, P>

Creates an instance of a DisplayComponent.

Type parameters

NameType
Textends UserSettingRecord
Kextends string
Pextends MFDSystemSetupToggleRowProps<T, K> = MFDSystemSetupToggleRowProps<T, K>

Parameters

NameTypeDescription
propsPThe propertis of the component.

Returns

MFDSystemSetupToggleRow<T, K, P>

Inherited from

MFDSystemSetupRow.constructor

Defined in

sdk/components/FSComponent.ts:73

Properties

context

Optional context: [] = undefined

The context on this component, if any.

Inherited from

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

MFDSystemSetupRow.contextType

Defined in

sdk/components/FSComponent.ts:67


props

props: P & ComponentProps

The properties of the component.

Inherited from

MFDSystemSetupRow.props

Defined in

sdk/components/FSComponent.ts:61

Methods

destroy

destroy(): void

Destroys this component.

Returns

void

Inherited from

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

MFDSystemSetupRow.getContext

Defined in

sdk/components/FSComponent.ts:106


onAfterRender

onAfterRender(node): void

A callback that is called after the component is rendered.

Parameters

NameTypeDescription
nodeVNodeThe component's VNode.

Returns

void

Inherited from

MFDSystemSetupRow.onAfterRender

Defined in

sdk/components/FSComponent.ts:87


onBeforeRender

onBeforeRender(): void

A callback that is called before the component is rendered.

Returns

void

Inherited from

MFDSystemSetupRow.onBeforeRender

Defined in

sdk/components/FSComponent.ts:80


render

render(): VNode

Returns

VNode

Inherit Doc

Inherited from

MFDSystemSetupRow.render

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/MFD/Components/UI/SystemSetup/MFDSystemSetupRow.tsx:25


renderLeft

renderLeft(): null | VNode

Renders the component to the left of the title.

Returns

null | VNode

The component to the left of the title, as a VNode, or null if there is no such component.

Inherited from

MFDSystemSetupRow.renderLeft

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/MFD/Components/UI/SystemSetup/MFDSystemSetupRow.tsx:43


renderRight

renderRight(): null | VNode

Renders the component to the right of the title.

Returns

null | VNode

The component to the right of the title, as a VNode, or null if there is no such component.

Overrides

MFDSystemSetupRow.renderRight

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/MFD/Components/UI/SystemSetup/MFDSystemSetupRow.tsx:130