Interface: UserSettingToggleEnumControlProps<T, K>
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UserSettings/UserSettingToggleEnumControl.tsx:10
Component props for UserSettingToggleEnumControl.
Extends
UserSettingControlProps
<T
,K
>
Type Parameters
Type Parameter |
---|
T extends UserSettingRecord |
K extends keyof T & string |
Properties
children?
optional
children:DisplayChildren
[]
Defined in: sdk/components/FSComponent.ts:122
The children of the display component.
Inherited from
UserSettingControlProps
.children
class?
optional
class:string
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UserSettings/UserSettingControl.ts:19
The CSS class(es) to apply to the root of the component.
Inherited from
ref?
optional
ref:NodeReference
<any
>
Defined in: sdk/components/FSComponent.ts:125
A reference to the display component.
Inherited from
registerFunc()
registerFunc: (
ctrl
,unregister?
) =>void
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UserSettings/UserSettingControl.ts:16
The function to use to register the UI control(s) used by the component.
Parameters
Parameter | Type |
---|---|
ctrl | UiControl |
unregister? | boolean |
Returns
void
Inherited from
UserSettingControlProps
.registerFunc
settingManager
settingManager:
UserSettingManager
<T
>
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UserSettings/UserSettingControl.ts:10
The setting manager associated with the controlled setting.
Inherited from
UserSettingControlProps
.settingManager
settingName
settingName:
K
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UserSettings/UserSettingControl.ts:13
The name of the controlled setting.
Inherited from
UserSettingControlProps
.settingName
values
values:
NonNullable
<T
[K
]>[]
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UserSettings/UserSettingToggleEnumControl.tsx:12
The possible values of the controlled setting.
valueText?
optional
valueText:string
[]
Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UserSettings/UserSettingToggleEnumControl.tsx:19
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.