Interface: DigitInputSlotProps

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/NumberInput/DigitInputSlot.tsx:9

Component props for DigitInputSlot.

Extends

• ComponentProps

Properties

allowBackfill?

optional allowBackfill: boolean | Subscribable<boolean>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/NumberInput/DigitInputSlot.tsx:11

Whether the slot supports backfill operations. Defaults to true.

---

characterCount

characterCount: number

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/NumberInput/DigitInputSlot.tsx:14

The number of characters in the slot.

---

children?

optional children: DisplayChildren[]

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

The children of the display component.

Inherited from

ComponentProps.children

---

class?

optional class: string | SubscribableSet<string>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/NumberInput/DigitInputSlot.tsx:71

CSS class(es) to apply to the slot's root element.

---

defaultCharValues

defaultCharValues: readonly number[] | Subscribable<readonly number[]>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/NumberInput/DigitInputSlot.tsx:40

The default numeric values for each of the slot's character positions when the character value is null.

---

digitizeValue()?

optional digitizeValue: (value, setCharacters, characters) => void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/NumberInput/DigitInputSlot.tsx:62

A function which assigns values to individual characters from a slot value. If not defined, values will be digitized according to their standard base-10 string representations, with each character assigned to exactly one base-10 digit ("0" through "9") in right-to-left order (the last character is assigned to the right-most digit, the second-to-last character to the second right-most digit, etc, until there are no more characters or digits).

Parameters

Parameter	Type	Description
value	number	A slot value.
setCharacters	readonly (char) => void[]	An array of functions which set the values of the slot's character values. The order of the functions is the same as order of their associated characters in the slot (from left to right).
characters	readonly (null | string)[]	An array containing the slot's current character values. The order of the values is the same as the order of the characters in the slot (from left to right).

Returns

void

---

increment

increment: number | Subscribable<number>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/NumberInput/DigitInputSlot.tsx:26

The amount to increment/decrement the input's un-scaled value when the inner FMS knob is scrolled, or a subscribable which provides it.

---

maxValue

maxValue: number | Subscribable<number>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/NumberInput/DigitInputSlot.tsx:20

The maximum un-scaled value of the input (exclusive if wrap is true), or a subscribable which provides it.

---

minValue

minValue: number | Subscribable<number>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/NumberInput/DigitInputSlot.tsx:17

The minimum un-scaled value of the input, or a subscribable which provides it.

---

parseValue()?

optional parseValue: (characters) => number

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/NumberInput/DigitInputSlot.tsx:49

A function which parses a slot value from individual character values. If not defined, characters will be parsed as standard base-10 integers.

Parameters

Parameter	Type	Description
characters	readonly (null | string)[]	An array of character values. The order of the values is the same as the order of the characters in the slot (from left to right).

Returns

number

The slot value parsed from the specified character values.

---

ref?

optional ref: NodeReference<any>

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

A reference to the display component.

Inherited from

ComponentProps.ref

---

renderChar()?

optional renderChar: (character, index) => string

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/NumberInput/DigitInputSlot.tsx:68

A function which renders slot characters into string. If not defined, non-null characters will be rendered as-is, and null characters will be rendered according to the default value assigned to that character.

Parameters

Parameter	Type
character	null | string
index	number

Returns

string

---

scale

scale: number | Subscribable<number>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/NumberInput/DigitInputSlot.tsx:37

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.

---

wrap

wrap: boolean | Subscribable<boolean>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/NumberInput/DigitInputSlot.tsx:29

Whether the input should wrap from the max value to the min value, or a subscribable which provides it.