Interface: UserSettingControlProps<T, K>

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UserSettings/UserSettingControl.ts:8

Props for components that control a user setting.

Extends

• ComponentProps

Extended by

• UserSettingSelectControlProps
• UserSettingToggleControlProps
• UserSettingToggleEnumControlProps

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

ComponentProps.children

---

class?

optional class: string

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UserSettings/UserSettingControl.ts:19

The CSS class(es) to apply to the root of the component.

---

ref?

optional ref: NodeReference<any>

Defined in: sdk/components/FSComponent.ts:125

A reference to the display component.

Inherited from

ComponentProps.ref

---

registerFunc()

registerFunc: (ctrl, unregister?) => void

Defined in: workingtitle-instruments-g1000/html_ui/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

---

settingManager

settingManager: UserSettingManager<T>

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UserSettings/UserSettingControl.ts:10

The setting manager associated with the controlled setting.

---

settingName

settingName: K

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UserSettings/UserSettingControl.ts:13

The name of the controlled setting.