Skip to main content

Class: MFDMapToggleSettingRow<T, P>

A map settings row which contains a toggle setting control.

Type parameters

NameType
Textends keyof UserSettingValueFilter<MapUserSettingTypes, boolean>
Pextends MFDMapToggleSettingRowProps<T> = MFDMapToggleSettingRowProps<T>

Hierarchy

Constructors

constructor

new MFDMapToggleSettingRow<T, P>(props): MFDMapToggleSettingRow<T, P>

Creates an instance of a DisplayComponent.

Type parameters

NameType
Textends "mapAutoNorthUpActive" | "mapGroundNorthUpActive" | "mapTerrainScaleShow" | "mapAirportLargeShow" | "mapAirportMediumShow" | "mapAirportSmallShow" | "mapVorShow" | "mapNdbShow" | "mapIntersectionShow" | "mapUserWaypointShow" | "mapAirspaceClassBShow" | "mapAirspaceClassCShow" | "mapAirspaceClassDShow" | "mapAirspaceRestrictedShow" | "mapAirspaceMoaShow" | "mapAirspaceOtherShow" | "mapTrafficShow" | "mapTrafficLabelShow" | "mapNexradShow" | "mapTrackVectorShow" | "mapAltitudeArcShow" | "mapWindVectorShow"
Pextends MFDMapToggleSettingRowProps<T> = MFDMapToggleSettingRowProps<T>

Parameters

NameTypeDescription
propsPThe propertis of the component.

Returns

MFDMapToggleSettingRow<T, P>

Inherited from

MFDMapSettingsRow.constructor

Defined in

sdk/components/FSComponent.ts:73

Properties

context

Optional context: [] = undefined

The context on this component, if any.

Inherited from

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

MFDMapSettingsRow.contextType

Defined in

sdk/components/FSComponent.ts:67


props

props: P & ComponentProps

The properties of the component.

Inherited from

MFDMapSettingsRow.props

Defined in

sdk/components/FSComponent.ts:61

Methods

destroy

destroy(): void

Destroys this component.

Returns

void

Inherited from

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

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

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

MFDMapSettingsRow.onBeforeRender

Defined in

sdk/components/FSComponent.ts:80


render

render(): VNode

Returns

VNode

Inherit Doc

Inherited from

MFDMapSettingsRow.render

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/MFD/Components/UI/MapSettings/MFDMapSettingsRow.tsx:27


renderLeftControl

renderLeftControl(): null | VNode

Renders this row's left setting control.

Returns

null | VNode

Overrides

MFDMapSettingsRow.renderLeftControl

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/MFD/Components/UI/MapSettings/MFDMapSettingsRow.tsx:97


renderRightControl

renderRightControl(): null | VNode

Renders this row's right setting control.

Returns

null | VNode

Overrides

MFDMapSettingsRow.renderRightControl

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/MFD/Components/UI/MapSettings/MFDMapSettingsRow.tsx:110