Interface: CursorInputSlot<T>
A slot for a scrolling cursor input.
Type parameters
| Name |
|---|
T |
Implemented by
Properties
allowBackfill
• Readonly allowBackfill: boolean
Whether this slot supports backfill operations.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/CursorInput/CursorInputSlot.tsx:21
characterCount
• Readonly characterCount: number
The number of characters contained in this slot.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/CursorInput/CursorInputSlot.tsx:24
characters
• Readonly characters: Subscribable<readonly (null | string)[]>
The value of this slot's characters, in order.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/CursorInput/CursorInputSlot.tsx:27
isCursorInputSlot
• Readonly isCursorInputSlot: true
Flags this object as a CursorInputSlot.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/CursorInput/CursorInputSlot.tsx:18
value
• Readonly value: Subscribable<T>
The current value of this slot.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/CursorInput/CursorInputSlot.tsx:30
Methods
canSetChar
▸ canSetChar(index, char, force?): boolean
Checks if one of this slot's characters can accept a value.
Parameters
| Name | Type | Description |
|---|---|---|
index | number | The index of the character to query. |
char | null | string | The value to query. |
force? | boolean | Whether the character should be forced to accept a value that would normally be invalid. Defaults to false. |
Returns
boolean
Whether the character can accept the specified value.
Throws
RangeError if index is out of bounds.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/CursorInput/CursorInputSlot.tsx:71
decrementValue
▸ decrementValue(): boolean
Decrements this slot's value.
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:50
getBottom
▸ getBottom(): number
Gets the y coordinate, in pixels, of the bottom edge of this slot's border box, relative to its nearest positioned ancestor.
Returns
number
The y coordinate, in pixels, of the bottom edge of this slot's border box, relative to its nearest positioned ancestor.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/CursorInput/CursorInputSlot.tsx:123
getCharLeft
▸ getCharLeft(index): number
Gets the x coordinate, in pixels, of the left edge of the border box of one of this slot's characters, relative to this slot's nearest positioned ancestor.
Parameters
| Name | Type | Description |
|---|---|---|
index | number | The index of the character to query. |
Returns
number
The x coordinate, in pixels, of the left edge of the border box of one of the specified character, relative to this slot's nearest positioned ancestor.
Throws
RangeError if index is out of bounds.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/CursorInput/CursorInputSlot.tsx:139
getCharRight
▸ getCharRight(index): number
Gets the x coordinate, in pixels, of the right edge of the border box of one of this slot's characters, relative to this slot's nearest positioned ancestor.
Parameters
| Name | Type | Description |
|---|---|---|
index | number | The index of the character to query. |
Returns
number
The x coordinate, in pixels, of the right edge of the border box of one of the specified character, relative to this slot's nearest positioned ancestor.
Throws
RangeError if index is out of bounds.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/CursorInput/CursorInputSlot.tsx:149
getCharWidth
▸ getCharWidth(index): number
Gets the width, in pixels, of one of this slot's characters.
Parameters
| Name | Type | Description |
|---|---|---|
index | number | The index of the character to query. |
Returns
number
The width, in pixels, of one of the specified character.
Throws
RangeError if index is out of bounds.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/CursorInput/CursorInputSlot.tsx:157
getHeight
▸ getHeight(): number
Gets the height, in pixels, of this slot's border box.
Returns
number
The height, in pixels, of this slot's border box.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/CursorInput/CursorInputSlot.tsx:129
getLeft
▸ getLeft(): number
Gets the x coordinate, in pixels, of the left edge of this slot's border box, relative to its nearest positioned ancestor.
Returns
number
The x coordinate, in pixels, of the left edge of this slot's border box, relative to its nearest positioned ancestor.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/CursorInput/CursorInputSlot.tsx:93
getRight
▸ getRight(): number
Gets the x coordinate, in pixels, of the right edge of this slot's border box, relative to its nearest positioned ancestor.
Returns
number
The x coordinate, in pixels, of the right edge of this slot's border box, relative to its nearest positioned ancestor.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/CursorInput/CursorInputSlot.tsx:101
getTop
▸ getTop(): number
Gets the y coordinate, in pixels, of the top edge of this slot's border box, relative to its nearest positioned ancestor.
Returns
number
The y coordinate, in pixels, of the top edge of this slot's border box, relative to its nearest positioned ancestor.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/CursorInput/CursorInputSlot.tsx:115
getWidth
▸ getWidth(): number
Gets the width, in pixels, of this slot's border box.
Returns
number
The width, in pixels, of this slot's border box.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/CursorInput/CursorInputSlot.tsx:107
incrementValue
▸ incrementValue(): boolean
Increments this slot's value.
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:44
populateCharsFromValue
▸ populateCharsFromValue(): void
Populates all of this slot's characters with non-empty values, if possible, using this slot's current value as a template.
Returns
void
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/CursorInput/CursorInputSlot.tsx:85
setChar
▸ setChar(index, char, force?): boolean
Sets the value of one of this slot's characters.
Parameters
| Name | Type | Description |
|---|---|---|
index | number | The index of the character to set. |
char | null | string | The value to set. |
force? | boolean | Whether to force the character to accept a value that would normally be invalid. Defaults to false. |
Returns
boolean
Whether the operation was accepted.
Throws
RangeError if index is out of bounds.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/CursorInput/CursorInputSlot.tsx:60
setCharSelected
▸ setCharSelected(index, mode): void
Sets the selection mode for one of this slot's characters.
Parameters
| Name | Type | Description |
|---|---|---|
index | number | The index of the character for which to set a selection mode. |
mode | CursorInputCharSelectionMode | A character selection mode. |
Returns
void
Throws
RangeError if index is out of bounds.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/CursorInput/CursorInputSlot.tsx:79
setValue
▸ setValue(value): T
Sets the value of this slot. The value of this slot after the operation is complete may be different from the requested value, depending on whether this slot can accurately represent the requested value.
Parameters
| Name | Type | Description |
|---|---|---|
value | T | The new value. |
Returns
T
The value of this slot after the operation is complete.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/CursorInput/CursorInputSlot.tsx:38