Class: MapEnumSettingControl<K>
A component which controls a map setting which can take on one of several enumerated values.
Type parameters
| Name | Type |
|---|---|
K | extends keyof MapUserSettingTypes |
Hierarchy
MapSettingControl<K,MapEnumSettingControlProps<K>>↳
MapEnumSettingControl
Constructors
constructor
• new MapEnumSettingControl<K>(props): MapEnumSettingControl<K>
Creates an instance of a DisplayComponent.
Type parameters
| Name | Type |
|---|---|
K | extends keyof MapUserSettingTypes |
Parameters
| Name | Type | Description |
|---|---|---|
props | MapEnumSettingControlProps<K> | The propertis of the component. |
Returns
Inherited from
Defined in
sdk/components/FSComponent.ts:73
Properties
context
• Optional context: [] = undefined
The context on this component, if any.
Inherited from
Defined in
sdk/components/FSComponent.ts:64
contextType
• Optional Readonly contextType: readonly [] = undefined
The type of context for this component, if any.
Inherited from
Defined in
sdk/components/FSComponent.ts:67
props
• props: MapEnumSettingControlProps<K> & ComponentProps
The properties of the component.
Inherited from
Defined in
sdk/components/FSComponent.ts:61
setting
• Protected Readonly setting: UserSetting<NonNullable<MapUserSettingTypes[K]>>
Inherited from
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
Defined in
sdk/components/FSComponent.ts:98
getContext
▸ getContext(context): never
Gets a context data subscription from the context collection.
Parameters
| Name | Type | Description |
|---|---|---|
context | never | The 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
Defined in
sdk/components/FSComponent.ts:106
onAfterRender
▸ onAfterRender(node): void
A callback that is called after the component is rendered.
Parameters
| Name | Type | Description |
|---|---|---|
node | VNode | The component's VNode. |
Returns
void
Inherited from
MapSettingControl.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
MapSettingControl.onBeforeRender
Defined in
sdk/components/FSComponent.ts:80
render
▸ render(): VNode
Renders the component.
Returns
VNode
A JSX element to be rendered.
Overrides
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/MapSettings/MapSettingControls.tsx:80