Interface: GenericCursorInputSlotProps<T>
Component props for GenericCursorInputSlot.
Type parameters
| Name |
|---|
T |
Hierarchy
ComponentProps↳
GenericCursorInputSlotProps
Properties
allowBackfill
• allowBackfill: boolean | Subscribable<boolean>
Whether the slot supports backfill operations.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/CursorInput/CursorInputSlot.tsx:165
canSetChar
• canSetChar: (characters: readonly (null | string)[], index: number, charToSet: null | string, force: boolean) => boolean
A function which checks if a slot character can accept a value.
Type declaration
▸ (characters, index, charToSet, force): boolean
A function which checks if a slot character can accept a value.
Parameters
| Name | Type |
|---|---|
characters | readonly (null | string)[] |
index | number |
charToSet | null | string |
force | boolean |
Returns
boolean
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/CursorInput/CursorInputSlot.tsx:244
characterCount
• characterCount: number
The number of characters contained in the slot.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/CursorInput/CursorInputSlot.tsx:168
children
• Optional children: DisplayChildren[]
The children of the display component.
Inherited from
ComponentProps.children
Defined in
src/sdk/components/FSComponent.ts:122
class
• Optional class: string | ToggleableClassNameRecord | SubscribableSet<string>
CSS class(es) to apply to the component's root element.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/CursorInput/CursorInputSlot.tsx:247
decrementValue
• decrementValue: (value: T, setValue: (value: T) => void, characters: readonly (null | string)[], setCharacters: readonly (char: null | string) => void[]) => boolean
A function which decrements the slot value.
Param
The slot's current value.
Param
A function which sets the slot's value.
Param
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).
Param
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).
Type declaration
▸ (value, setValue, characters, setCharacters): boolean
A function which decrements the slot value.
Parameters
| Name | Type | Description |
|---|---|---|
value | T | The slot's current value. |
setValue | (value: T) => void | A function which sets the slot's value. |
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). |
setCharacters | readonly (char: null | string) => 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). |
Returns
boolean
Whether the operation was accepted.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/CursorInput/CursorInputSlot.tsx:229
digitizeValue
• digitizeValue: (value: T, setCharacters: readonly (char: null | string) => void[], characters: readonly (null | string)[]) => void
A function which assigns values to individual characters from a slot value.
Param
A slot value.
Param
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).
Param
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).
Type declaration
▸ (value, setCharacters, characters): void
A function which assigns values to individual characters from a slot value.
Parameters
| Name | Type | Description |
|---|---|---|
value | T | A slot value. |
setCharacters | readonly (char: null | string) => 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
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/CursorInput/CursorInputSlot.tsx:186
incrementValue
• incrementValue: (value: T, setValue: (value: T) => void, characters: readonly (null | string)[], setCharacters: readonly (char: null | string) => void[]) => boolean
A function which increments the slot value.
Param
The slot's current value.
Param
A function which sets the slot's value.
Param
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).
Param
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).
Type declaration
▸ (value, setValue, characters, setCharacters): boolean
A function which increments the slot value.
Parameters
| Name | Type | Description |
|---|---|---|
value | T | The slot's current value. |
setValue | (value: T) => void | A function which sets the slot's value. |
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). |
setCharacters | readonly (char: null | string) => 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). |
Returns
boolean
Whether the operation was accepted.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/CursorInput/CursorInputSlot.tsx:212
parseValue
• parseValue: (characters: readonly (null | string)[]) => T
A function which parses a slot value from individual character values.
Param
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).
Type declaration
▸ (characters): T
A function which parses a slot value from individual character values.
Parameters
| Name | 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
T
The slot value parsed from the specified character values.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/CursorInput/CursorInputSlot.tsx:176
ref
• Optional ref: NodeReference<any>
A reference to the display component.
Inherited from
ComponentProps.ref
Defined in
src/sdk/components/FSComponent.ts:125
renderChar
• renderChar: (charToRender: null | string, index: number, characters: readonly (null | string)[]) => string
A function which renders a character value into a string.
Param
The character to render.
Param
The index of the character to render.
Param
An array of the slot's character values.
Type declaration
▸ (charToRender, index, characters): string
A function which renders a character value into a string.
Parameters
| Name | Type | Description |
|---|---|---|
charToRender | null | string | The character to render. |
index | number | The index of the character to render. |
characters | readonly (null | string)[] | An array of the slot's character values. |
Returns
string
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/CursorInput/CursorInputSlot.tsx:200
setChar
• setChar: (characters: readonly MutableSubscribable<null | string, null | string>[], index: number, charToSet: null | string, force: boolean) => boolean
A function which sets the value of a slot character, and returns whether the operation was accepted.
Type declaration
▸ (characters, index, charToSet, force): boolean
A function which sets the value of a slot character, and returns whether the operation was accepted.
Parameters
| Name | Type |
|---|---|
characters | readonly MutableSubscribable<null | string, null | string>[] |
index | number |
charToSet | null | string |
force | boolean |
Returns
boolean
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/CursorInput/CursorInputSlot.tsx:239
valueEquals
• Optional valueEquals: (a: T, b: T) => boolean
A function which checks if two slot values are equal. If not defined, equality is checked using the strict
equality operator (===).
Type declaration
▸ (a, b): boolean
A function which checks if two slot values are equal. If not defined, equality is checked using the strict
equality operator (===).
Parameters
| Name | Type |
|---|---|
a | T |
b | T |
Returns
boolean
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/CursorInput/CursorInputSlot.tsx:192