Interface: DigitInputProps
Component props for DigitInput.
Hierarchy
↳
DigitInputProps
Properties
children
• Optional
children: DisplayChildren
[]
The children of the display component.
Inherited from
Defined in
sdk/components/FSComponent.ts:122
class
• Optional
class: string
CSS class(es) to apply to the root of the input component.
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControls2/DigitInput.tsx:50
formatter
• Optional
formatter: (value
: number
) => string
| VNode
A function which formats input values for display as either a string or a VNode. If not defined, values will be
rendered as plain strings according to their toString()
method.
Type declaration
▸ (value
): string
| VNode
A function which formats input values for display as either a string or a VNode. If not defined, values will be
rendered as plain strings according to their toString()
method.
Parameters
Name | Type |
---|---|
value | number |
Returns
string
| VNode
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControls2/DigitInput.tsx:41
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
Name | Type |
---|---|
direction | ScrollDirection |
Returns
FocusPosition
Inherited from
G1000UiControlProps.getFocusPositionOnScroll
Defined in
sdk/components/controls/HardwareUiControl.tsx:56
increment
• increment: number
| Subscribable
<number
>
The amount to increment/decrement the input's un-scaled value when the inner FMS knob is scrolled, or a subscribable which provides it.
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControls2/DigitInput.tsx:24
innerKnobScroll
• Optional
innerKnobScroll: boolean
Whether or not the inner FMS knob scrolls also by default.
Inherited from
G1000UiControlProps.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
G1000UiControlProps.isolateScroll
Defined in
sdk/components/controls/HardwareUiControl.tsx:38
maxValue
• maxValue: number
| Subscribable
<number
>
The maximum un-scaled value of the input (exclusive if wrap
is true), or a subscribable which provides it.
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControls2/DigitInput.tsx:18
minValue
• minValue: number
| Subscribable
<number
>
The minimum un-scaled value of the input, or a subscribable which provides it.
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControls2/DigitInput.tsx:15
on0
• on0: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
on1
• on1: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
on2
• on2: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
on3
• on3: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
on4
• on4: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
on5
• on5: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
on6
• on6: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
on7
• on7: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
on8
• on8: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
on9
• on9: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onA
• onA: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
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
Name | Type |
---|---|
control | HardwareUiControl <Record <string , any >, HardwareUiControlProps > |
index | number |
Returns
void
Inherited from
G1000UiControlProps.onAfterScroll
Defined in
sdk/components/controls/HardwareUiControl.tsx:62
onB
• onB: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onBKSP
• onBKSP: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
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
Name | Type |
---|---|
source | HardwareUiControl <Record <string , any >, HardwareUiControlProps > |
Returns
void
Inherited from
Defined in
sdk/components/controls/HardwareUiControl.tsx:47
onC
• onC: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onClr
• onClr: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onClrLong
• onClrLong: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onCom
• onCom: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onCrs
• onCrs: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onD
• onD: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
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
Name | Type |
---|---|
source | HardwareUiControl <Record <string , any >, HardwareUiControlProps > |
Returns
void
Inherited from
G1000UiControlProps.onDestroyed
Defined in
sdk/components/controls/HardwareUiControl.tsx:71
onDirectTo
• onDirectTo: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
G1000UiControlProps.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
Name | Type |
---|---|
source | HardwareUiControl <Record <string , any >, HardwareUiControlProps > |
Returns
void
Inherited from
G1000UiControlProps.onDisabled
Defined in
sdk/components/controls/HardwareUiControl.tsx:50
onDot
• onDot: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onE
• onE: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
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
Name | Type |
---|---|
source | HardwareUiControl <Record <string , any >, HardwareUiControlProps > |
Returns
void
Inherited from
Defined in
sdk/components/controls/HardwareUiControl.tsx:53
onEnter
• onEnter: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onF
• onF: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onFPL
• onFPL: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
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
Name | Type |
---|---|
source | HardwareUiControl <Record <string , any >, HardwareUiControlProps > |
Returns
void
Inherited from
Defined in
sdk/components/controls/HardwareUiControl.tsx:44
onG
• onG: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onH
• onH: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onHome
• onHome: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onI
• onI: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onInnerControlKnobDec
• onInnerControlKnobDec: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
G1000UiControlProps.onInnerControlKnobDec
onInnerControlKnobInc
• onInnerControlKnobInc: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
G1000UiControlProps.onInnerControlKnobInc
onInnerControlKnobPush
• onInnerControlKnobPush: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
G1000UiControlProps.onInnerControlKnobPush
onJ
• onJ: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onJoystickDown
• onJoystickDown: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
G1000UiControlProps.onJoystickDown
onJoystickLeft
• onJoystickLeft: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
G1000UiControlProps.onJoystickLeft
onJoystickPush
• onJoystickPush: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
G1000UiControlProps.onJoystickPush
onJoystickRight
• onJoystickRight: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
G1000UiControlProps.onJoystickRight
onJoystickUp
• onJoystickUp: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
G1000UiControlProps.onJoystickUp
onK
• onK: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onL
• onL: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onLowerKnobDec
• onLowerKnobDec: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
G1000UiControlProps.onLowerKnobDec
onLowerKnobInc
• onLowerKnobInc: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
G1000UiControlProps.onLowerKnobInc
onM
• onM: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onMenu
• onMenu: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onN
• onN: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onNav
• onNav: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onO
• onO: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onOuterControlKnobDec
• onOuterControlKnobDec: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
G1000UiControlProps.onOuterControlKnobDec
onOuterControlKnobInc
• onOuterControlKnobInc: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
G1000UiControlProps.onOuterControlKnobInc
onP
• onP: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onPlusMinus
• onPlusMinus: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
G1000UiControlProps.onPlusMinus
onProc
• onProc: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onQ
• onQ: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onR
• onR: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onRangeDec
• onRangeDec: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
G1000UiControlProps.onRangeDec
onRangeInc
• onRangeInc: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
G1000UiControlProps.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
Name | Type |
---|---|
source | HardwareUiControl <Record <string , any >, HardwareUiControlProps > |
Returns
void
Inherited from
G1000UiControlProps.onRegistered
Defined in
sdk/components/controls/HardwareUiControl.tsx:65
onS
• onS: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onSPC
• onSPC: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
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
Name | Type |
---|---|
direction | ScrollDirection |
Returns
boolean
Inherited from
Defined in
sdk/components/controls/HardwareUiControl.tsx:59
onT
• onT: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onU
• onU: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
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
Name | Type |
---|---|
source | HardwareUiControl <Record <string , any >, HardwareUiControlProps > |
Returns
void
Inherited from
G1000UiControlProps.onUnregistered
Defined in
sdk/components/controls/HardwareUiControl.tsx:68
onUpperKnobDec
• onUpperKnobDec: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
G1000UiControlProps.onUpperKnobDec
onUpperKnobInc
• onUpperKnobInc: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
G1000UiControlProps.onUpperKnobInc
onUpperKnobPush
• onUpperKnobPush: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
G1000UiControlProps.onUpperKnobPush
onV
• onV: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onW
• onW: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onX
• onX: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onXpdr
• onXpdr: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onY
• onY: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
onZ
• onZ: undefined
| UiControlEventHandler
<G1000UiControl
<G1000UiControlProps
>>
Inherited from
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
Name | Type | Description |
---|---|---|
index | number | The index of the child control that was blurred. |
child | HardwareUiControl <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
G1000UiControlProps.reconcileChildBlur
Defined in
sdk/components/controls/HardwareUiControl.tsx:80
ref
• Optional
ref: NodeReference
<any
>
A reference to the display component.
Inherited from
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
G1000UiControlProps.requireChildFocus
Defined in
sdk/components/controls/HardwareUiControl.tsx:41
scale
• scale: number
| Subscribable
<number
>
The scaling factor applied to this input's value, or a subscribable which provides it. The scaling factor
determines the relationship between this input's bound data value and the displayed value as follows:
data_value = display_value * scale
. When the scaling factor changes, this input's displayed value is
preserved, and the bound data value is changed to reflect the new scaling factor.
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControls2/DigitInput.tsx:35
solidHighlightDuration
• Optional
solidHighlightDuration: number
The duration, in milliseconds, of the applied solid highlight when this input is focused or edited. Defaults to 1000.
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControls2/DigitInput.tsx:47
value
• value: Subject
<number
>
A subject which is bound to the input value.
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControls2/DigitInput.tsx:12
wrap
• wrap: boolean
| Subscribable
<boolean
>
Whether the input should wrap from the max value to the min value, or a subscribable which provides it.
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControls2/DigitInput.tsx:27