Class: ChannelInputSlot
A cursor input slot which allows the user to select a radio frequency channel.
Hierarchy
DisplayComponent<ChannelInputSlotProps>↳
ChannelInputSlot
Constructors
constructor
• new ChannelInputSlot(props): ChannelInputSlot
Creates an instance of a DisplayComponent.
Parameters
| Name | Type | Description |
|---|---|---|
props | ChannelInputSlotProps | The propertis of the component. |
Returns
Inherited from
DisplayComponent<ChannelInputSlotProps>.constructor
Defined in
src/sdk/components/FSComponent.ts:73
Properties
channelCount
• Readonly channelCount: number
The number of unique channels supported by this slot.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/FrequencyInput/ChannelInputSlot.tsx:82
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
frequency
• Readonly frequency: Subscribable<number>
The frequency associated with this slot's channel value.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/FrequencyInput/ChannelInputSlot.tsx:92
props
• props: ChannelInputSlotProps & ComponentProps
The properties of the component.
Inherited from
DisplayComponent.props
Defined in
src/sdk/components/FSComponent.ts:61
Accessors
value
• get value(): Subscribable<number>
This slot's channel value.
Returns
Subscribable<number>
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/FrequencyInput/ChannelInputSlot.tsx:86
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/FrequencyInput/ChannelInputSlot.tsx:150
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/FrequencyInput/ChannelInputSlot.tsx:366
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/FrequencyInput/ChannelInputSlot.tsx:142
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/FrequencyInput/ChannelInputSlot.tsx:95
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
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/FrequencyInput/ChannelInputSlot.tsx:169
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/FrequencyInput/ChannelInputSlot.tsx:347
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/FrequencyInput/ChannelInputSlot.tsx:161
setFrequency
▸ setFrequency(freq): number
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
| Name | Type | Description |
|---|---|---|
freq | number | The new frequency value, in hertz. |
Returns
number
The frequency 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/FrequencyInput/ChannelInputSlot.tsx:121