Class: SignInputSlot
A cursor input slot which allows the user to select a numeric sign, either +1
or -1
.
Hierarchy
DisplayComponent
<SignInputSlotProps
>↳
SignInputSlot
Constructors
constructor
• new SignInputSlot(props
): SignInputSlot
Creates an instance of a DisplayComponent.
Parameters
Name | Type | Description |
---|---|---|
props | SignInputSlotProps | The propertis of the component. |
Returns
Inherited from
DisplayComponent<SignInputSlotProps>.constructor
Defined in
src/sdk/components/FSComponent.ts:73
Properties
context
• Optional
context: [] = undefined
The context on this component, if any.
Inherited from
DisplayComponent.context
Defined in
src/sdk/components/FSComponent.ts:64
contextType
• Optional
Readonly
contextType: readonly [] = undefined
The type of context for this component, if any.
Inherited from
DisplayComponent.contextType
Defined in
src/sdk/components/FSComponent.ts:67
props
• props: SignInputSlotProps
& ComponentProps
The properties of the component.
Inherited from
DisplayComponent.props
Defined in
src/sdk/components/FSComponent.ts:61
Accessors
value
• get
value(): Subscribable
<1
| -1
>
The value bound to this slot.
Returns
Subscribable
<1
| -1
>
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/NumberInput/SignInputSlot.tsx:34
Methods
decrementValue
▸ decrementValue(): boolean
Decrements this slot's value.
Returns
boolean
Whether the decrement operation was accepted.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/NumberInput/SignInputSlot.tsx:66
destroy
▸ destroy(): void
Returns
void
Inherit Doc
Overrides
DisplayComponent.destroy
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/NumberInput/SignInputSlot.tsx:129
getContext
▸ getContext(context
): never
Gets a context data subscription from the context collection.
Parameters
Name | Type | Description |
---|---|---|
context | never | The context to get the subscription for. |
Returns
never
The requested context.
Throws
An error if no data for the specified context type could be found.
Inherited from
DisplayComponent.getContext
Defined in
src/sdk/components/FSComponent.ts:106
incrementValue
▸ incrementValue(): boolean
Increments this slot's value.
Returns
boolean
Whether the increment operation was accepted.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/NumberInput/SignInputSlot.tsx:58
onAfterRender
▸ onAfterRender(): void
Returns
void
Inherit Doc
Overrides
DisplayComponent.onAfterRender
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/NumberInput/SignInputSlot.tsx:41
onBeforeRender
▸ onBeforeRender(): void
A callback that is called before the component is rendered.
Returns
void
Inherited from
DisplayComponent.onBeforeRender
Defined in
src/sdk/components/FSComponent.ts:80
render
▸ render(): VNode
Returns
VNode
Inherit Doc
Overrides
DisplayComponent.render
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/NumberInput/SignInputSlot.tsx:82
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.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/NumberInput/SignInputSlot.tsx:77
setValue
▸ setValue(value
): 1
| -1
Sets the value of this slot.
Parameters
Name | Type | Description |
---|---|---|
value | 1 | -1 | The new value. |
Returns
1
| -1
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/NumberInput/SignInputSlot.tsx:50