Skip to main content

Class: MapToggleSettingControl<K>

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/MapSettings/MapSettingControls.tsx:45

A component which controls an on/off map setting.

Extends

Type Parameters

Type Parameter
K extends keyof UserSettingValueFilter<MapUserSettingTypes, boolean>

Constructors

Constructor

new MapToggleSettingControl<K>(props): MapToggleSettingControl<K>

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

Creates an instance of a DisplayComponent.

Parameters

ParameterTypeDescription
propsMapSettingControlPropsThe propertis of the component.

Returns

MapToggleSettingControl<K>

Inherited from

MapSettingControl.constructor

Properties

context?

optional context: [] = undefined

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

The context on this component, if any.

Inherited from

MapSettingControl.context


contextType?

readonly optional contextType: readonly [] = undefined

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

The type of context for this component, if any.

Inherited from

MapSettingControl.contextType


props

props: MapSettingControlProps<K> & ComponentProps

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

The properties of the component.

Inherited from

MapSettingControl.props


setting

protected readonly setting: UserSetting<NonNullable<MapUserSettingTypes[K]>>

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/MapSettings/MapSettingControls.tsx:39

Inherited from

MapSettingControl.setting

Methods

destroy()

destroy(): void

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

Destroys this component.

Returns

void

Inherited from

MapSettingControl.destroy


getContext()

protected getContext(context): never

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

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

MapSettingControl.getContext


onAfterRender()

onAfterRender(node): void

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

A callback that is called after the component is rendered.

Parameters

ParameterTypeDescription
nodeVNodeThe component's VNode.

Returns

void

Inherited from

MapSettingControl.onAfterRender


onBeforeRender()

onBeforeRender(): void

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

A callback that is called before the component is rendered.

Returns

void

Inherited from

MapSettingControl.onBeforeRender


render()

render(): VNode

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/MapSettings/MapSettingControls.tsx:47

Renders the component.

Returns

VNode

A JSX element to be rendered.

Overrides

MapSettingControl.render