Class: ArrowToggle_OLD
A class to define an arrow toggle/select UI element ArrowToggle
Hierarchy
DisplayComponent
<ArrowToggleComponentProps_OLD
>↳
ArrowToggle_OLD
Constructors
constructor
• new ArrowToggle_OLD(props
): ArrowToggle_OLD
Creates an instance of a DisplayComponent.
Parameters
Name | Type | Description |
---|---|---|
props | ArrowToggleComponentProps_OLD | The propertis of the component. |
Returns
Inherited from
DisplayComponent<ArrowToggleComponentProps_OLD>.constructor
Defined in
sdk/components/FSComponent.ts:73
Properties
context
• Optional
context: [] = undefined
The context on this component, if any.
Inherited from
DisplayComponent.context
Defined in
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
sdk/components/FSComponent.ts:67
isActive
• isActive: boolean
= false
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UIControls/ArrowToggle.tsx:151
props
• props: ArrowToggleComponentProps_OLD
& ComponentProps
The properties of the component.
Inherited from
DisplayComponent.props
Defined in
sdk/components/FSComponent.ts:61
selectedOptionIndex
• selectedOptionIndex: number
= 0
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UIControls/ArrowToggle.tsx:150
Methods
decOption
▸ decOption(): void
Method to decrement to the next selected option.
Returns
void
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UIControls/ArrowToggle.tsx:176
destroy
▸ destroy(): void
Destroys this component.
Returns
void
Inherited from
DisplayComponent.destroy
Defined in
sdk/components/FSComponent.ts:98
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
sdk/components/FSComponent.ts:106
incOption
▸ incOption(): void
Method to increment to the next selected option.
Returns
void
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UIControls/ArrowToggle.tsx:167
onAfterRender
▸ onAfterRender(): void
Do stuff after rendering.
Returns
void
Overrides
DisplayComponent.onAfterRender
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UIControls/ArrowToggle.tsx:210
onBeforeRender
▸ onBeforeRender(): void
A callback that is called before the component is rendered.
Returns
void
Inherited from
DisplayComponent.onBeforeRender
Defined in
sdk/components/FSComponent.ts:80
render
▸ render(): null
| VNode
Renders the component.
Returns
null
| VNode
The component VNode.
Overrides
DisplayComponent.render
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UIControls/ArrowToggle.tsx:222
selectOption
▸ selectOption(optionIndex
): void
Method to set the selected option.
Parameters
Name | Type | Description |
---|---|---|
optionIndex | number | is a string containing the start text value |
Returns
void
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UIControls/ArrowToggle.tsx:158
setActive
▸ setActive(active
): void
Method to set this toggle component active or inactive.
Parameters
Name | Type | Description |
---|---|---|
active | boolean | is whether to set this component active or not. |
Returns
void
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UIControls/ArrowToggle.tsx:186