Skip to main content

Interface: GarminControlListProps<T>

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/G1000UiControl.tsx:684

Properties on the GarminControlList component.

Extends

  • UiControlPropEventHandlers<FmsUiControlEvents>.HardwareUiControlProps.HardwareControlListProps<T>

Type Parameters

Type Parameter
T

Properties

children?

optional children: DisplayChildren[]

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

The children of the display component.

Inherited from

HardwareUiControlProps.children


class?

optional class: string

Defined in: sdk/components/controls/HardwareUiControlList.tsx:36

The CSS class to apply to this list container.

Inherited from

HardwareControlListProps.class


data

data: SubscribableArray<T>

Defined in: sdk/components/controls/HardwareUiControlList.tsx:12

The data associated with this list component.

Inherited from

HardwareControlListProps.data


disableContainerScroll?

optional disableContainerScroll: boolean

Defined in: sdk/components/controls/HardwareUiControlList.tsx:42

Disables automatically ensuring that the container scrolls to the focused item.

Inherited from

HardwareControlListProps.disableContainerScroll


getFocusPositionOnScroll()?

optional getFocusPositionOnScroll: (direction) => FocusPosition

Defined in: sdk/components/controls/HardwareUiControl.tsx:56

A function which returns how the control should focus its children when it is focused from a scroll.

Parameters

ParameterType
directionScrollDirection

Returns

FocusPosition

Inherited from

HardwareUiControlProps.getFocusPositionOnScroll


hideScrollbar?

optional hideScrollbar: boolean

Defined in: sdk/components/controls/HardwareUiControlList.tsx:30

Whether or not to hide the list scrollbar.

Inherited from

HardwareControlListProps.hideScrollbar


innerKnobScroll?

optional innerKnobScroll: boolean

Defined in: sdk/components/controls/HardwareUiControl.tsx:32

Whether or not the inner FMS knob scrolls also by default.

Inherited from

HardwareUiControlProps.innerKnobScroll


isolateScroll?

optional isolateScroll: boolean

Defined in: sdk/components/controls/HardwareUiControl.tsx:38

When enabled, scroll commands will not propagate from this control to its parent while the control is focused.

Inherited from

HardwareUiControlProps.isolateScroll


itemSize?

optional itemSize: number

Defined in: sdk/components/controls/HardwareUiControlList.tsx:24

The size, in pixels, of each item in the list.

Inherited from

HardwareControlListProps.itemSize


numItems?

optional numItems: number

Defined in: sdk/components/controls/HardwareUiControlList.tsx:27

The max number of items to display in the list.

Inherited from

HardwareControlListProps.numItems


on0?

optional on0: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.on0


on1?

optional on1: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.on1


on2?

optional on2: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.on2


on3?

optional on3: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.on3


on4?

optional on4: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.on4


on5?

optional on5: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.on5


on6?

optional on6: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.on6


on7?

optional on7: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.on7


on8?

optional on8: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.on8


on9?

optional on9: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.on9


onA?

optional onA: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onA


onAfterScroll()?

optional onAfterScroll: (control, index) => void

Defined in: sdk/components/controls/HardwareUiControl.tsx:62

An event called when the scroll operation has completed.

Parameters

ParameterType
controlHardwareUiControl
indexnumber

Returns

void

Inherited from

HardwareUiControlProps.onAfterScroll


onB?

optional onB: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onB


onBKSP?

optional onBKSP: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onBKSP


onBlurred()?

optional onBlurred: (source) => void

Defined in: sdk/components/controls/HardwareUiControl.tsx:47

An event called when the control loses focus.

Parameters

ParameterType
sourceHardwareUiControl

Returns

void

Inherited from

HardwareUiControlProps.onBlurred


onC?

optional onC: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onC


onClr?

optional onClr: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onClr


onClrLong?

optional onClrLong: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onClrLong


onCom?

optional onCom: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onCom


onCrs?

optional onCrs: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onCrs


onD?

optional onD: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onD


onDestroyed()?

optional onDestroyed: (source) => void

Defined in: sdk/components/controls/HardwareUiControl.tsx:71

An event called when the control is destroyed.

Parameters

ParameterType
sourceHardwareUiControl

Returns

void

Inherited from

HardwareUiControlProps.onDestroyed


onDirectTo?

optional onDirectTo: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onDirectTo


onDisabled()?

optional onDisabled: (source) => void

Defined in: sdk/components/controls/HardwareUiControl.tsx:50

An event called when the control is disabled.

Parameters

ParameterType
sourceHardwareUiControl

Returns

void

Inherited from

HardwareUiControlProps.onDisabled


onDot?

optional onDot: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onDot


onE?

optional onE: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onE


onEnabled()?

optional onEnabled: (source) => void

Defined in: sdk/components/controls/HardwareUiControl.tsx:53

An event called when the control is enabled.

Parameters

ParameterType
sourceHardwareUiControl

Returns

void

Inherited from

HardwareUiControlProps.onEnabled


onEnter?

optional onEnter: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onEnter


onF?

optional onF: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onF


onFocused()?

optional onFocused: (source) => void

Defined in: sdk/components/controls/HardwareUiControl.tsx:44

An event called when the control is focused.

Parameters

ParameterType
sourceHardwareUiControl

Returns

void

Inherited from

HardwareUiControlProps.onFocused


onFPL?

optional onFPL: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onFPL


onG?

optional onG: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onG


onH?

optional onH: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onH


onHome?

optional onHome: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onHome


onI?

optional onI: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onI


onInnerControlKnobDec?

optional onInnerControlKnobDec: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onInnerControlKnobDec


onInnerControlKnobInc?

optional onInnerControlKnobInc: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onInnerControlKnobInc


onInnerControlKnobPush?

optional onInnerControlKnobPush: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onInnerControlKnobPush


onItemSelected()?

optional onItemSelected: (data, node, index) => void

Defined in: sdk/components/controls/HardwareUiControlList.tsx:18

A callback called when an item in the list is selected.

Parameters

ParameterType
datanull | T
nodenull | HardwareUiControl<Record<string, any>, HardwareUiControlProps>
indexnumber

Returns

void

Inherited from

HardwareControlListProps.onItemSelected


onJ?

optional onJ: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onJ


onJoystickDown?

optional onJoystickDown: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onJoystickDown


onJoystickLeft?

optional onJoystickLeft: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onJoystickLeft


onJoystickPush?

optional onJoystickPush: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onJoystickPush


onJoystickRight?

optional onJoystickRight: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onJoystickRight


onJoystickUp?

optional onJoystickUp: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onJoystickUp


onK?

optional onK: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onK


onL?

optional onL: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onL


onLowerKnobDec?

optional onLowerKnobDec: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onLowerKnobDec


onLowerKnobInc?

optional onLowerKnobInc: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onLowerKnobInc


onM?

optional onM: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onM


onMenu?

optional onMenu: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onMenu


onN?

optional onN: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onN


onNav?

optional onNav: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onNav


onO?

optional onO: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onO


onOuterControlKnobDec?

optional onOuterControlKnobDec: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onOuterControlKnobDec


onOuterControlKnobInc?

optional onOuterControlKnobInc: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onOuterControlKnobInc


onP?

optional onP: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onP


onPlusMinus?

optional onPlusMinus: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onPlusMinus


onProc?

optional onProc: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onProc


onQ?

optional onQ: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onQ


onR?

optional onR: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onR


onRangeDec?

optional onRangeDec: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onRangeDec


onRangeInc?

optional onRangeInc: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onRangeInc


onRegistered()?

optional onRegistered: (source) => void

Defined in: sdk/components/controls/HardwareUiControl.tsx:65

An event called when a control is registered with this control.

Parameters

ParameterType
sourceHardwareUiControl

Returns

void

Inherited from

HardwareUiControlProps.onRegistered


onS?

optional onS: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onS


onScroll()?

optional onScroll: (direction) => boolean

Defined in: sdk/components/controls/HardwareUiControl.tsx:59

An event called when the control is scrolled.

Parameters

ParameterType
directionScrollDirection

Returns

boolean

Inherited from

HardwareUiControlProps.onScroll


onSPC?

optional onSPC: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onSPC


onT?

optional onT: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onT


onU?

optional onU: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onU


onUnregistered()?

optional onUnregistered: (source) => void

Defined in: sdk/components/controls/HardwareUiControl.tsx:68

An event called when a control is unregistered with this control.

Parameters

ParameterType
sourceHardwareUiControl

Returns

void

Inherited from

HardwareUiControlProps.onUnregistered


onUpperKnobDec?

optional onUpperKnobDec: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onUpperKnobDec


onUpperKnobInc?

optional onUpperKnobInc: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onUpperKnobInc


onUpperKnobPush?

optional onUpperKnobPush: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onUpperKnobPush


onV?

optional onV: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onV


onW?

optional onW: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onW


onX?

optional onX: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onX


onXpdr?

optional onXpdr: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onXpdr


onY?

optional onY: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onY


onZ?

optional onZ: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onZ


orderBy()?

optional orderBy: (a, b) => number

Defined in: sdk/components/controls/HardwareUiControlList.tsx:21

Indicates that the list should be ordered by a specified function.

Parameters

ParameterType
aT
bT

Returns

number

Inherited from

HardwareControlListProps.orderBy


reconcileChildBlur()?

optional reconcileChildBlur: (index, child) => number | BlurReconciliation

Defined in: sdk/components/controls/HardwareUiControl.tsx:80

A function which reconciles the focus state of the control's children when the control is focused with no focused children after a child has been blurred.

Parameters

ParameterTypeDescription
indexnumberThe index of the child control that was blurred.
childHardwareUiControlThe child control that was blurred.

Returns

number | BlurReconciliation

The index of the child to focus, or a blur reconciliation strategy.

Inherited from

HardwareUiControlProps.reconcileChildBlur


ref?

optional ref: NodeReference<any>

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

A reference to the display component.

Inherited from

HardwareUiControlProps.ref


renderItem()

renderItem: (data, index) => VNode

Defined in: sdk/components/controls/HardwareUiControlList.tsx:15

A function that renders a single data item into the list.

Parameters

ParameterType
dataT
indexnumber

Returns

VNode

Inherited from

HardwareControlListProps.renderItem


requireChildFocus?

optional requireChildFocus: boolean

Defined in: sdk/components/controls/HardwareUiControl.tsx:41

Whether the control requires one of its child controls to be focused for itself to be focused.

Inherited from

HardwareUiControlProps.requireChildFocus


scrollContainer?

optional scrollContainer: NodeReference<HTMLElement>

Defined in: sdk/components/controls/HardwareUiControlList.tsx:39

An alternate HTML element to scroll to ensure the selected element is in view.

Inherited from

HardwareControlListProps.scrollContainer


scrollToMostRecentlyAdded?

optional scrollToMostRecentlyAdded: boolean

Defined in: sdk/components/controls/HardwareUiControlList.tsx:33

Scroll to the index of the most recently added item.

Inherited from

HardwareControlListProps.scrollToMostRecentlyAdded