Class: ArrowToggle_OLD

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UIControls/ArrowToggle.tsx:146

A class to define an arrow toggle/select UI element ArrowToggle

Extends

• DisplayComponent<ArrowToggleComponentProps_OLD>

Constructors

Constructor

new ArrowToggle_OLD(props): ArrowToggle_OLD

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

Creates an instance of a DisplayComponent.

Parameters

Parameter	Type	Description
props	ArrowToggleComponentProps_OLD	The propertis of the component.

Returns

ArrowToggle_OLD

Inherited from

DisplayComponent.constructor

Properties

context?

optional context: [] = undefined

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

The context on this component, if any.

Inherited from

DisplayComponent.context

---

contextType?

readonly optional contextType: readonly [] = undefined

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

The type of context for this component, if any.

Inherited from

DisplayComponent.contextType

---

isActive

isActive: boolean = false

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UIControls/ArrowToggle.tsx:151

---

props

props: ArrowToggleComponentProps_OLD & ComponentProps

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

The properties of the component.

Inherited from

DisplayComponent.props

---

selectedOptionIndex

selectedOptionIndex: number = 0

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UIControls/ArrowToggle.tsx:150

Methods

decOption()

decOption(): void

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UIControls/ArrowToggle.tsx:176

Method to decrement to the next selected option.

Returns

void

---

destroy()

destroy(): void

Defined in: sdk/components/FSComponent.ts:101

Destroys this component.

Returns

void

Inherited from

DisplayComponent.destroy

---

getContext()

protected getContext(context): never

Defined in: 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

---

incOption()

incOption(): void

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UIControls/ArrowToggle.tsx:167

Method to increment to the next selected option.

Returns

void

---

onAfterRender()

onAfterRender(): void

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UIControls/ArrowToggle.tsx:210

Do stuff after rendering.

Returns

void

Overrides

DisplayComponent.onAfterRender

---

onBeforeRender()

onBeforeRender(): void

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

A callback that is called before the component is rendered.

Returns

void

Inherited from

DisplayComponent.onBeforeRender

---

render()

render(): VNode | null

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UIControls/ArrowToggle.tsx:222

Renders the component.

Returns

VNode | null

The component VNode.

Overrides

DisplayComponent.render

---

selectOption()

selectOption(optionIndex): void

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UIControls/ArrowToggle.tsx:158

Method to set the selected option.

Parameters

Parameter	Type	Description
optionIndex	number	is a string containing the start text value

Returns

void

---

setActive()

setActive(active): void

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UIControls/ArrowToggle.tsx:186

Method to set this toggle component active or inactive.

Parameters

Parameter	Type	Description
active	boolean	is whether to set this component active or not.

Returns

void