Skip to main content

Class: MapSettingControl<K, P>

A component which controls a map setting.

Type parameters

NameType
Kextends keyof MapUserSettingTypes
Pextends MapSettingControlProps<K>

Hierarchy

Constructors

constructor

new MapSettingControl<K, P>(props): MapSettingControl<K, P>

Creates an instance of a DisplayComponent.

Type parameters

NameType
Kextends keyof MapUserSettingTypes
Pextends MapSettingControlProps<K>

Parameters

NameTypeDescription
propsPThe propertis of the component.

Returns

MapSettingControl<K, P>

Inherited from

DisplayComponent<P>.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: P & ComponentProps

The properties of the component.

Inherited from

DisplayComponent.props

Defined in

sdk/components/FSComponent.ts:61


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

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

A callback that is called after the component is rendered.

Parameters

NameTypeDescription
nodeVNodeThe component's VNode.

Returns

void

Inherited from

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

DisplayComponent.onBeforeRender

Defined in

sdk/components/FSComponent.ts:80


render

render(): null | VNode

Renders the component.

Returns

null | VNode

A JSX element to be rendered.

Inherited from

DisplayComponent.render

Defined in

sdk/components/FSComponent.ts:93