Skip to main content

Class: MFDMapToggleEnumSettingsRow<T, E>

Defined in: workingtitle-instruments-g1000/html_ui/MFD/Components/UI/MapSettings/MFDMapSettingsRow.tsx:128

A map settings row which controls track vector settings.

Extends​

Type Parameters​

Type Parameter
T extends keyof UserSettingValueFilter<MapUserSettingTypes, boolean>
E extends keyof MapUserSettingTypes

Constructors​

Constructor​

new MFDMapToggleEnumSettingsRow<T, E>(props): MFDMapToggleEnumSettingsRow<T, E>

Defined in: sdk/components/FSComponent.ts:76

Creates an instance of a DisplayComponent.

Parameters​

ParameterTypeDescription
propsMFDMapToggleEnumSettingsRowPropsThe propertis of the component.

Returns​

MFDMapToggleEnumSettingsRow<T, E>

Inherited from​

MFDMapToggleSettingRow.constructor

Properties​

context?​

optional context: [] = undefined

Defined in: sdk/components/FSComponent.ts:67

The context on this component, if any.

Inherited from​

MFDMapToggleSettingRow.context


contextType?​

readonly optional contextType: readonly [] = undefined

Defined in: sdk/components/FSComponent.ts:70

The type of context for this component, if any.

Inherited from​

MFDMapToggleSettingRow.contextType


props​

props: MFDMapToggleEnumSettingsRowProps<T, E> & ComponentProps

Defined in: sdk/components/FSComponent.ts:64

The properties of the component.

Inherited from​

MFDMapToggleSettingRow.props

Methods​

destroy()​

destroy(): void

Defined in: sdk/components/FSComponent.ts:101

Destroys this component.

Returns​

void

Inherited from​

MFDMapToggleSettingRow.destroy


getContext()​

protected getContext(context): never

Defined in: sdk/components/FSComponent.ts:109

Gets a context data subscription from the context collection.

Parameters​

ParameterTypeDescription
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​

MFDMapToggleSettingRow.getContext


onAfterRender()​

onAfterRender(node): void

Defined in: sdk/components/FSComponent.ts:90

A callback that is called after the component is rendered.

Parameters​

ParameterTypeDescription
nodeVNodeThe component's VNode.

Returns​

void

Inherited from​

MFDMapToggleSettingRow.onAfterRender


onBeforeRender()​

onBeforeRender(): void

Defined in: sdk/components/FSComponent.ts:83

A callback that is called before the component is rendered.

Returns​

void

Inherited from​

MFDMapToggleSettingRow.onBeforeRender


render()​

render(): VNode

Defined in: workingtitle-instruments-g1000/html_ui/MFD/Components/UI/MapSettings/MFDMapSettingsRow.tsx:27

Renders the component.

Returns​

VNode

A JSX element to be rendered.

Inherited from​

MFDMapToggleSettingRow.render


renderLeftControl()​

protected renderLeftControl(): VNode | null

Defined in: workingtitle-instruments-g1000/html_ui/MFD/Components/UI/MapSettings/MFDMapSettingsRow.tsx:97

Renders this row's left setting control.

Returns​

VNode | null

Inherited from​

MFDMapToggleSettingRow.renderLeftControl


renderRightControl()​

protected renderRightControl(): VNode | null

Defined in: workingtitle-instruments-g1000/html_ui/MFD/Components/UI/MapSettings/MFDMapSettingsRow.tsx:132

Renders this row's right setting control.

Returns​

VNode | null

Overrides​

MFDMapToggleSettingRow.renderRightControl