Class: UserSettingToggleEnumControl<T, K, P>
A component which controls the value of a setting using an ArrowToggle.
Type parameters
| Name | Type |
|---|---|
T | extends UserSettingRecord |
K | extends keyof T & string |
P | extends UserSettingToggleEnumControlProps<T, K> = UserSettingToggleEnumControlProps<T, K> |
Hierarchy
DisplayComponent<P>↳
UserSettingToggleEnumControl
Constructors
constructor
• new UserSettingToggleEnumControl<T, K, P>(props): UserSettingToggleEnumControl<T, K, P>
Creates an instance of a DisplayComponent.
Type parameters
| Name | Type |
|---|---|
T | extends UserSettingRecord |
K | extends string |
P | extends UserSettingToggleEnumControlProps<T, K> = UserSettingToggleEnumControlProps<T, K> |
Parameters
| Name | Type | Description |
|---|---|---|
props | P | The propertis of the component. |
Returns
UserSettingToggleEnumControl<T, 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
toggleController
• Protected Readonly toggleController: UserSettingToggleController<T, K>
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UserSettings/UserSettingToggleEnumControl.tsx:30
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
| 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
DisplayComponent.getContext
Defined in
sdk/components/FSComponent.ts:106
onAfterRender
▸ onAfterRender(node): void
Parameters
| Name | Type |
|---|---|
node | VNode |
Returns
void
Inherit Doc
Overrides
DisplayComponent.onAfterRender
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UserSettings/UserSettingToggleEnumControl.tsx:33
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(): VNode
Returns
VNode
Inherit Doc
Overrides
DisplayComponent.render
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UserSettings/UserSettingToggleEnumControl.tsx:40