Skip to main content

Interface: GenericNumberInputProps

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControls2/GenericNumberInput.tsx:13

Component props for GenericNumberInput.

Extends​

Properties​

children?​

optional children: DisplayChildren[]

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

The children of the display component.

Inherited from​

G1000UiControlProps.children


class?​

optional class: string

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControls2/GenericNumberInput.tsx:55

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


digitizer()?​

optional digitizer: (value, signValues, digitValues) => void

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

A function which assigns values to individual sign and digit inputs based on the bound value.

Parameters​

ParameterTypeDescription
valuenumberThe bound value.
signValuesreadonly Subject<-1 | 1>[]An array containing subjects which bind the values of the component's individual sign inputs. The order of the subjects is the same as the order of the sign inputs in the component's control subtree.
digitValuesreadonly Subject<number>[]An array containing subjects which bind the values of the component's individual digit inputs. The order of the subjects is the same as the order of the digit inputs in the component's control subtree.

Returns​

void


editOnActivate?​

optional editOnActivate: boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControls2/GenericNumberInput.tsx:52

Whether the first event activating the input should also edit the value.


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​

G1000UiControlProps.getFocusPositionOnScroll


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​

G1000UiControlProps.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​

G1000UiControlProps.isolateScroll


keyboardEntryDisabled?​

optional keyboardEntryDisabled: boolean

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControls2/GenericNumberInput.tsx:58

Whether keyboard entry should be disabled.


on0?​

optional on0: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.on0


on1?​

optional on1: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.on1


on2?​

optional on2: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.on2


on3?​

optional on3: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.on3


on4?​

optional on4: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.on4


on5?​

optional on5: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.on5


on6?​

optional on6: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.on6


on7?​

optional on7: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.on7


on8?​

optional on8: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.on8


on9?​

optional on9: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.on9


onA?​

optional onA: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.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​

G1000UiControlProps.onAfterScroll


onB?​

optional onB: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.onB


onBKSP?​

optional onBKSP: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.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​

G1000UiControlProps.onBlurred


onC?​

optional onC: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.onC


onClr?​

optional onClr: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.onClr


onClrLong?​

optional onClrLong: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.onClrLong


onCom?​

optional onCom: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.onCom


onCrs?​

optional onCrs: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.onCrs


onD?​

optional onD: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.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​

G1000UiControlProps.onDestroyed


onDirectTo?​

optional onDirectTo: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.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​

G1000UiControlProps.onDisabled


onDot?​

optional onDot: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.onDot


onE?​

optional onE: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.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​

G1000UiControlProps.onEnabled


onEnter?​

optional onEnter: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.onEnter


onF?​

optional onF: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.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​

G1000UiControlProps.onFocused


onFPL?​

optional onFPL: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.onFPL


onG?​

optional onG: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.onG


onH?​

optional onH: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.onH


onHome?​

optional onHome: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.onHome


onI?​

optional onI: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.onI


onInnerControlKnobDec?​

optional onInnerControlKnobDec: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.onInnerControlKnobDec


onInnerControlKnobInc?​

optional onInnerControlKnobInc: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.onInnerControlKnobInc


onInnerControlKnobPush?​

optional onInnerControlKnobPush: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.onInnerControlKnobPush


onInputAccepted()?​

optional onInputAccepted: (value) => void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControls2/GenericNumberInput.tsx:43

A function which responds to when an input value is accepted.

Parameters​

ParameterTypeDescription
valuenumberThe accepted value.

Returns​

void


onInputRejected()?​

optional onInputRejected: (value) => void

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControls2/GenericNumberInput.tsx:49

A function which responds to when an input value is rejected.

Parameters​

ParameterTypeDescription
valuenumberThe rejected value.

Returns​

void


onJ?​

optional onJ: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.onJ


onJoystickDown?​

optional onJoystickDown: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.onJoystickDown


onJoystickLeft?​

optional onJoystickLeft: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.onJoystickLeft


onJoystickPush?​

optional onJoystickPush: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.onJoystickPush


onJoystickRight?​

optional onJoystickRight: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.onJoystickRight


onJoystickUp?​

optional onJoystickUp: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.onJoystickUp


onK?​

optional onK: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.onK


onL?​

optional onL: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.onL


onLowerKnobDec?​

optional onLowerKnobDec: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.onLowerKnobDec


onLowerKnobInc?​

optional onLowerKnobInc: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.onLowerKnobInc


onM?​

optional onM: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.onM


onMenu?​

optional onMenu: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.onMenu


onN?​

optional onN: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.onN


onNav?​

optional onNav: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.onNav


onO?​

optional onO: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.onO


onOuterControlKnobDec?​

optional onOuterControlKnobDec: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.onOuterControlKnobDec


onOuterControlKnobInc?​

optional onOuterControlKnobInc: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.onOuterControlKnobInc


onP?​

optional onP: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.onP


onPlusMinus?​

optional onPlusMinus: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.onPlusMinus


onProc?​

optional onProc: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.onProc


onQ?​

optional onQ: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.onQ


onR?​

optional onR: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.onR


onRangeDec?​

optional onRangeDec: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.onRangeDec


onRangeInc?​

optional onRangeInc: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.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​

G1000UiControlProps.onRegistered


onS?​

optional onS: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.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​

G1000UiControlProps.onScroll


onSPC?​

optional onSPC: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.onSPC


onT?​

optional onT: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.onT


onU?​

optional onU: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.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​

G1000UiControlProps.onUnregistered


onUpperKnobDec?​

optional onUpperKnobDec: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.onUpperKnobDec


onUpperKnobInc?​

optional onUpperKnobInc: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.onUpperKnobInc


onUpperKnobPush?​

optional onUpperKnobPush: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.onUpperKnobPush


onV?​

optional onV: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.onV


onW?​

optional onW: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.onW


onX?​

optional onX: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.onX


onXpdr?​

optional onXpdr: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.onXpdr


onY?​

optional onY: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.onY


onZ?​

optional onZ: UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from​

G1000UiControlProps.onZ


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​

G1000UiControlProps.reconcileChildBlur


ref?​

optional ref: NodeReference<any>

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

A reference to the display component.

Inherited from​

G1000UiControlProps.ref


renderInactiveValue()?​

optional renderInactiveValue: (value) => string | VNode

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControls2/GenericNumberInput.tsx:31

A function which renders the input's value when editing is not active. If defined, the output of the function replaces all rendered child components when editing is not active.

Parameters​

ParameterType
valuenumber

Returns​

string | VNode


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​

G1000UiControlProps.requireChildFocus


solidHighlightDuration?​

optional solidHighlightDuration: number

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

The duration, in milliseconds, of the applied solid highlight when this input is focused or edited. Defaults to 1000.


value​

value: Subject<number>

Defined in: workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControls2/GenericNumberInput.tsx:15

A subject which is bound to the input value.