Skip to main content

Interface: G1000UiControlProps

Properties on the G1000UiControl component.

Hierarchy

Properties

children

Optional children: DisplayChildren[]

The children of the display component.

Inherited from

HardwareUiControlProps.children

Defined in

sdk/components/FSComponent.ts:122


getFocusPositionOnScroll

Optional getFocusPositionOnScroll: (direction: ScrollDirection) => FocusPosition

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

Type declaration

▸ (direction): FocusPosition

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

Parameters
NameType
directionScrollDirection
Returns

FocusPosition

Inherited from

HardwareUiControlProps.getFocusPositionOnScroll

Defined in

sdk/components/controls/HardwareUiControl.tsx:56


innerKnobScroll

Optional innerKnobScroll: boolean

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

Inherited from

HardwareUiControlProps.innerKnobScroll

Defined in

sdk/components/controls/HardwareUiControl.tsx:32


isolateScroll

Optional isolateScroll: boolean

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

Inherited from

HardwareUiControlProps.isolateScroll

Defined in

sdk/components/controls/HardwareUiControl.tsx:38


on0

on0: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.on0


on1

on1: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.on1


on2

on2: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.on2


on3

on3: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.on3


on4

on4: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.on4


on5

on5: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.on5


on6

on6: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.on6


on7

on7: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.on7


on8

on8: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.on8


on9

on9: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.on9


onA

onA: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onA


onAfterScroll

Optional onAfterScroll: (control: HardwareUiControl<Record<string, any>, HardwareUiControlProps>, index: number) => void

An event called when the scroll operation has completed.

Type declaration

▸ (control, index): void

An event called when the scroll operation has completed.

Parameters
NameType
controlHardwareUiControl<Record<string, any>, HardwareUiControlProps>
indexnumber
Returns

void

Inherited from

HardwareUiControlProps.onAfterScroll

Defined in

sdk/components/controls/HardwareUiControl.tsx:62


onB

onB: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onB


onBKSP

onBKSP: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onBKSP


onBlurred

Optional onBlurred: (source: HardwareUiControl<Record<string, any>, HardwareUiControlProps>) => void

An event called when the control loses focus.

Type declaration

▸ (source): void

An event called when the control loses focus.

Parameters
NameType
sourceHardwareUiControl<Record<string, any>, HardwareUiControlProps>
Returns

void

Inherited from

HardwareUiControlProps.onBlurred

Defined in

sdk/components/controls/HardwareUiControl.tsx:47


onC

onC: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onC


onClr

onClr: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onClr


onClrLong

onClrLong: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onClrLong


onCom

onCom: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onCom


onCrs

onCrs: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onCrs


onD

onD: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onD


onDestroyed

Optional onDestroyed: (source: HardwareUiControl<Record<string, any>, HardwareUiControlProps>) => void

An event called when the control is destroyed.

Type declaration

▸ (source): void

An event called when the control is destroyed.

Parameters
NameType
sourceHardwareUiControl<Record<string, any>, HardwareUiControlProps>
Returns

void

Inherited from

HardwareUiControlProps.onDestroyed

Defined in

sdk/components/controls/HardwareUiControl.tsx:71


onDirectTo

onDirectTo: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onDirectTo


onDisabled

Optional onDisabled: (source: HardwareUiControl<Record<string, any>, HardwareUiControlProps>) => void

An event called when the control is disabled.

Type declaration

▸ (source): void

An event called when the control is disabled.

Parameters
NameType
sourceHardwareUiControl<Record<string, any>, HardwareUiControlProps>
Returns

void

Inherited from

HardwareUiControlProps.onDisabled

Defined in

sdk/components/controls/HardwareUiControl.tsx:50


onDot

onDot: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onDot


onE

onE: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onE


onEnabled

Optional onEnabled: (source: HardwareUiControl<Record<string, any>, HardwareUiControlProps>) => void

An event called when the control is enabled.

Type declaration

▸ (source): void

An event called when the control is enabled.

Parameters
NameType
sourceHardwareUiControl<Record<string, any>, HardwareUiControlProps>
Returns

void

Inherited from

HardwareUiControlProps.onEnabled

Defined in

sdk/components/controls/HardwareUiControl.tsx:53


onEnter

onEnter: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onEnter


onF

onF: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onF


onFPL

onFPL: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onFPL


onFocused

Optional onFocused: (source: HardwareUiControl<Record<string, any>, HardwareUiControlProps>) => void

An event called when the control is focused.

Type declaration

▸ (source): void

An event called when the control is focused.

Parameters
NameType
sourceHardwareUiControl<Record<string, any>, HardwareUiControlProps>
Returns

void

Inherited from

HardwareUiControlProps.onFocused

Defined in

sdk/components/controls/HardwareUiControl.tsx:44


onG

onG: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onG


onH

onH: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onH


onHome

onHome: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onHome


onI

onI: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onI


onInnerControlKnobDec

onInnerControlKnobDec: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onInnerControlKnobDec


onInnerControlKnobInc

onInnerControlKnobInc: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onInnerControlKnobInc


onInnerControlKnobPush

onInnerControlKnobPush: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onInnerControlKnobPush


onJ

onJ: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onJ


onJoystickDown

onJoystickDown: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onJoystickDown


onJoystickLeft

onJoystickLeft: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onJoystickLeft


onJoystickPush

onJoystickPush: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onJoystickPush


onJoystickRight

onJoystickRight: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onJoystickRight


onJoystickUp

onJoystickUp: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onJoystickUp


onK

onK: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onK


onL

onL: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onL


onLowerKnobDec

onLowerKnobDec: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onLowerKnobDec


onLowerKnobInc

onLowerKnobInc: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onLowerKnobInc


onM

onM: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onM


onMenu

onMenu: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onMenu


onN

onN: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onN


onNav

onNav: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onNav


onO

onO: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onO


onOuterControlKnobDec

onOuterControlKnobDec: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onOuterControlKnobDec


onOuterControlKnobInc

onOuterControlKnobInc: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onOuterControlKnobInc


onP

onP: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onP


onPlusMinus

onPlusMinus: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onPlusMinus


onProc

onProc: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onProc


onQ

onQ: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onQ


onR

onR: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onR


onRangeDec

onRangeDec: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onRangeDec


onRangeInc

onRangeInc: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onRangeInc


onRegistered

Optional onRegistered: (source: HardwareUiControl<Record<string, any>, HardwareUiControlProps>) => void

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

Type declaration

▸ (source): void

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

Parameters
NameType
sourceHardwareUiControl<Record<string, any>, HardwareUiControlProps>
Returns

void

Inherited from

HardwareUiControlProps.onRegistered

Defined in

sdk/components/controls/HardwareUiControl.tsx:65


onS

onS: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onS


onSPC

onSPC: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onSPC


onScroll

Optional onScroll: (direction: ScrollDirection) => boolean

An event called when the control is scrolled.

Type declaration

▸ (direction): boolean

An event called when the control is scrolled.

Parameters
NameType
directionScrollDirection
Returns

boolean

Inherited from

HardwareUiControlProps.onScroll

Defined in

sdk/components/controls/HardwareUiControl.tsx:59


onT

onT: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onT


onU

onU: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onU


onUnregistered

Optional onUnregistered: (source: HardwareUiControl<Record<string, any>, HardwareUiControlProps>) => void

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

Type declaration

▸ (source): void

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

Parameters
NameType
sourceHardwareUiControl<Record<string, any>, HardwareUiControlProps>
Returns

void

Inherited from

HardwareUiControlProps.onUnregistered

Defined in

sdk/components/controls/HardwareUiControl.tsx:68


onUpperKnobDec

onUpperKnobDec: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onUpperKnobDec


onUpperKnobInc

onUpperKnobInc: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onUpperKnobInc


onUpperKnobPush

onUpperKnobPush: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onUpperKnobPush


onV

onV: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onV


onW

onW: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onW


onX

onX: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onX


onXpdr

onXpdr: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onXpdr


onY

onY: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onY


onZ

onZ: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

UiControlPropEventHandlers.onZ


reconcileChildBlur

Optional reconcileChildBlur: (index: number, child: HardwareUiControl<Record<string, any>, HardwareUiControlProps>) => number | BlurReconciliation

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.

Param

The index of the child control that was blurred.

Param

The child control that was blurred.

Type declaration

▸ (index, child): number | BlurReconciliation

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
NameTypeDescription
indexnumberThe index of the child control that was blurred.
childHardwareUiControl<Record<string, any>, HardwareUiControlProps>The child control that was blurred.
Returns

number | BlurReconciliation

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

Inherited from

HardwareUiControlProps.reconcileChildBlur

Defined in

sdk/components/controls/HardwareUiControl.tsx:80


ref

Optional ref: NodeReference<any>

A reference to the display component.

Inherited from

HardwareUiControlProps.ref

Defined in

sdk/components/FSComponent.ts:125


requireChildFocus

Optional requireChildFocus: boolean

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

Inherited from

HardwareUiControlProps.requireChildFocus

Defined in

sdk/components/controls/HardwareUiControl.tsx:41