Class: ChannelInputSlot

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/FrequencyInput/ChannelInputSlot.tsx:25

A cursor input slot which allows the user to select a radio frequency channel.

Extends

• DisplayComponent<ChannelInputSlotProps>

Constructors

Constructor

new ChannelInputSlot(props): ChannelInputSlot

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

Creates an instance of a DisplayComponent.

Parameters

Parameter	Type	Description
props	ChannelInputSlotProps	The propertis of the component.

Returns

ChannelInputSlot

Inherited from

DisplayComponent.constructor

Properties

channelCount

readonly channelCount: number

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

The number of unique channels supported by this slot.

---

context?

optional context: [] = undefined

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

The context on this component, if any.

Inherited from

DisplayComponent.context

---

contextType?

readonly optional contextType: readonly [] = undefined

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

The type of context for this component, if any.

Inherited from

DisplayComponent.contextType

---

frequency

readonly frequency: Subscribable<number>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/FrequencyInput/ChannelInputSlot.tsx:92

The frequency associated with this slot's channel value.

---

props

props: ChannelInputSlotProps & ComponentProps

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

The properties of the component.

Inherited from

DisplayComponent.props

Accessors

value

Get Signature

get value(): Subscribable<number>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/FrequencyInput/ChannelInputSlot.tsx:86

This slot's channel value.

Returns

Subscribable<number>

Methods

decrementValue()

decrementValue(): boolean

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/FrequencyInput/ChannelInputSlot.tsx:150

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/FrequencyInput/ChannelInputSlot.tsx:366

Destroys this component.

Returns

void

Overrides

DisplayComponent.destroy

---

getContext()

protected getContext(context): never

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

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/FrequencyInput/ChannelInputSlot.tsx:142

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/FrequencyInput/ChannelInputSlot.tsx:95

A callback that is called after the component is rendered.

Returns

void

Overrides

DisplayComponent.onAfterRender

---

onBeforeRender()

onBeforeRender(): void

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

A callback that is called before the component is rendered.

Returns

void

Inherited from

DisplayComponent.onBeforeRender

---

populateCharsFromValue()

populateCharsFromValue(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/FrequencyInput/ChannelInputSlot.tsx:169

Populates all of this slot's characters with non-empty values, if possible, using this slot's current value as a template.

Returns

void

---

render()

render(): VNode

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/FrequencyInput/ChannelInputSlot.tsx:347

Renders the component.

Returns

VNode

A JSX element to be rendered.

Overrides

DisplayComponent.render

---

setChar()

setChar(index, char, force?): boolean

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/FrequencyInput/ChannelInputSlot.tsx:161

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

Parameters

Parameter	Type	Description
index	number	The index of the character to set.
char	string | null	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.

---

setFrequency()

setFrequency(freq): number

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/FrequencyInput/ChannelInputSlot.tsx:121

Sets the frequency value of this slot. As part of the operation, all of this slot's characters will be set to non-null representations of the new slot value, if possible. The frequency value of this slot after the operation is complete may differ from the requested value depending on whether the requested value can be accurately represented by this slot.

Parameters

Parameter	Type	Description
freq	number	The new frequency value, in hertz.

Returns

number

The frequency value of this slot after the operation is complete.