Interface: UserSettingSelectControlProps<T, K>

Component props for UserSettingSelectControl.

Type parameters

Name	Type
T	extends UserSettingRecord
K	extends keyof T & string

Hierarchy

• UserSettingControlProps<T, K>

  ↳ UserSettingSelectControlProps

Properties

buildMenuItem

• Optional buildMenuItem: (value: NonNullable<T[K]>, index: number) => ContextMenuItemDefinition

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.

Param

A setting value.

Param

The index of the setting value in the list displayed by SelectControl.

Type declaration

▸ (value, index): ContextMenuItemDefinition

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

Name	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

Defined in

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

---

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

UserSettingControlProps.class

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UserSettings/UserSettingControl.ts:19

---

outerContainer

• outerContainer: NodeReference<HTMLElement>

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

Defined in

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

---

ref

• Optional ref: NodeReference<any>

A reference to the display component.

Inherited from

UserSettingControlProps.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

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: SubscribableArray<string>

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.

Defined in

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

---

values

• values: SubscribableArray<NonNullable<T[K]>>

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

Defined in

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

---

viewService

• viewService: ViewService

The View Service.

Defined in

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