Interface: UserSettingSelectControlProps<T, K>

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UserSettings/UserSettingSelectControl.tsx:12

Component props for UserSettingSelectControl.

Extends

• UserSettingControlProps<T, K>

Type Parameters

Type Parameter
T extends UserSettingRecord
K extends keyof T & string

Properties

buildMenuItem()?

optional buildMenuItem: (value, index) => ContextMenuItemDefinition

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UserSettings/UserSettingSelectControl.tsx:34

A function which builds a menu item definition for setting values. If not defined, value rendering is governed by the valueText prop instead, if it exists. If valueText is not defined either, values are rendered as plain text using their toString() method.

Parameters

Parameter	Type	Description
value	NonNullable<T[K]>	A setting value.
index	number	The index of the setting value in the list displayed by SelectControl.

Returns

ContextMenuItemDefinition

---

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

UserSettingControlProps.class

---

outerContainer

outerContainer: NodeReference<HTMLElement>

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UserSettings/UserSettingSelectControl.tsx:37

A reference to the HTML element that constrains the location of the SelectControl's selection pop-up.

---

ref?

optional ref: NodeReference<any>

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

A reference to the display component.

Inherited from

UserSettingControlProps.ref

---

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: SubscribableArray<NonNullable<T[K]>>

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UserSettings/UserSettingSelectControl.tsx:17

A subscribable array which provides the possible values of the controlled setting.

---

valueText?

optional valueText: SubscribableArray<string>

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UserSettings/UserSettingSelectControl.tsx:25

A subscribable array which provides the text representation 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 text is not defined for a value, it is rendered using its toString() method instead. Text provided by this prop is overridden by the buildMenuItem prop, if it is defined.

---

viewService

viewService: ViewService

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UserSettings/UserSettingSelectControl.tsx:14

The View Service.