Class: SignInputSlot

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

A cursor input slot which allows the user to select a numeric sign, either +1 or -1.

Extends

• DisplayComponent<SignInputSlotProps>

Constructors

Constructor

new SignInputSlot(props): SignInputSlot

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

Creates an instance of a DisplayComponent.

Parameters

Parameter	Type	Description
props	SignInputSlotProps	The propertis of the component.

Returns

SignInputSlot

Inherited from

DisplayComponent<SignInputSlotProps>.constructor

Properties

context?

optional context: [] = undefined

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

The context on this component, if any.

Inherited from

DisplayComponent.context

---

contextType?

readonly optional contextType: readonly [] = undefined

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

The type of context for this component, if any.

Inherited from

DisplayComponent.contextType

---

props

props: SignInputSlotProps & ComponentProps

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

The properties of the component.

Inherited from

DisplayComponent.props

Accessors

value

Get Signature

get value(): Subscribable<-1 | 1>

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

The value bound to this slot.

Returns

Subscribable<-1 | 1>

Methods

decrementValue()

decrementValue(): boolean

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

Decrements this slot's value.

Returns

boolean

Whether the decrement operation was accepted.

---

destroy()

destroy(): void

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

Returns

void

Inherit Doc

Overrides

DisplayComponent.destroy

---

getContext()

protected getContext(context): never

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

Gets a context data subscription from the context collection.

Parameters

Parameter	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

---

incrementValue()

incrementValue(): boolean

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

Increments this slot's value.

Returns

boolean

Whether the increment operation was accepted.

---

onAfterRender()

onAfterRender(): void

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

Returns

void

Inherit Doc

Overrides

DisplayComponent.onAfterRender

---

onBeforeRender()

onBeforeRender(): void

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

A callback that is called before the component is rendered.

Returns

void

Inherited from

DisplayComponent.onBeforeRender

---

render()

render(): VNode

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

Returns

VNode

Inherit Doc

Overrides

DisplayComponent.render

---

setChar()

setChar(index, char, force?): boolean

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

Sets the value of one of this slot's characters.

Parameters

Parameter	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.

---

setValue()

setValue(value): -1 | 1

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

Sets the value of this slot.

Parameters

Parameter	Type	Description
value	-1 | 1	The new value.

Returns

-1 | 1

The value of this slot after the operation is complete.