Interface: UserSettingControlProps<T, K>
Props for components that control a user setting.
Type parameters
| Name | Type |
|---|---|
T | extends UserSettingRecord |
K | extends keyof T & string |
Hierarchy
ComponentProps↳
UserSettingControlProps↳↳
UserSettingSelectControlProps
Properties
children
• Optional children: DisplayChildren[]
The children of the display component.
Inherited from
ComponentProps.children
Defined in
sdk/components/FSComponent.ts:122
class
• Optional class: string
The CSS class(es) to apply to the root of the component.
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
ComponentProps.ref
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
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.
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.
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UserSettings/UserSettingControl.ts:13