Interface: UserSettingToggleEnumControlProps<T, K>
Component props for UserSettingToggleEnumControl.
Type parameters
| Name | Type |
|---|---|
T | extends UserSettingRecord |
K | extends keyof T & string |
Hierarchy
UserSettingControlProps<T,K>↳
UserSettingToggleEnumControlProps
Properties
children
• Optional children: DisplayChildren[]
The children of the display component.
Inherited from
UserSettingControlProps.children
Defined in
sdk/components/FSComponent.ts:122
class
• Optional class: string
The CSS class(es) to apply to the root of the component.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UserSettings/UserSettingControl.ts:19
ref
• Optional ref: NodeReference<any>
A reference to the display component.
Inherited from
Defined in
sdk/components/FSComponent.ts:125
registerFunc
• registerFunc: (ctrl: UiControl<UiControlProps>, unregister?: boolean) => void
The function to use to register the UI control(s) used by the component.
Type declaration
▸ (ctrl, unregister?): void
The function to use to register the UI control(s) used by the component.
Parameters
| Name | Type |
|---|---|
ctrl | UiControl<UiControlProps> |
unregister? | boolean |
Returns
void
Inherited from
UserSettingControlProps.registerFunc
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UserSettings/UserSettingControl.ts:16
settingManager
• settingManager: UserSettingManager<T>
The setting manager associated with the controlled setting.
Inherited from
UserSettingControlProps.settingManager
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UserSettings/UserSettingControl.ts:10
settingName
• settingName: K
The name of the controlled setting.
Inherited from
UserSettingControlProps.settingName
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UserSettings/UserSettingControl.ts:13
valueText
• Optional valueText: string[]
The text representations of the possible setting values. Each value provided by the values prop will be mapped
to the text provided by this prop at the same index. If this prop is not defined, values will be rendered using
their toString() methods instead.
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UserSettings/UserSettingToggleEnumControl.tsx:19
values
• values: NonNullable<T[K]>[]
The possible values of the controlled setting.
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UserSettings/UserSettingToggleEnumControl.tsx:12