Skip to main content

Class: GtcWaypointSelectButton<T, S>

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/TouchButton/GtcWaypointSelectButton.tsx:97

A GTC button which displays the ident, name, and icon for a waypoint and when pressed allows the user to select a facility waypoint by ident.

Extends​

Type Parameters​

Type Parameter
T extends WaypointSelectType
S extends Subscribable<WaypointSelectTypeMap[T] | null>

Constructors​

Constructor​

new GtcWaypointSelectButton<T, S>(props): GtcWaypointSelectButton<T, S>

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

Creates an instance of a DisplayComponent.

Parameters​

ParameterTypeDescription
propsGtcWaypointSelectButtonPropsThe propertis of the component.

Returns​

GtcWaypointSelectButton<T, S>

Inherited from​

DisplayComponent<GtcWaypointSelectButtonProps<T, S>>.constructor

Properties​

context?​

optional context: [] = undefined

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

The context on this component, if any.

Inherited from​

DisplayComponent.context


contextType?​

readonly optional contextType: readonly [] = undefined

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

The type of context for this component, if any.

Inherited from​

DisplayComponent.contextType


props​

props: GtcWaypointSelectButtonProps<T, S> & ComponentProps

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

The properties of the component.

Inherited from​

DisplayComponent.props

Methods​

destroy()​

destroy(): void

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/TouchButton/GtcWaypointSelectButton.tsx:175

Returns​

void

Inherit Doc​

Overrides​

DisplayComponent.destroy


getContext()​

protected getContext(context): never

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

Gets a context data subscription from the context collection.

Parameters​

ParameterTypeDescription
contextneverThe 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


onAfterRender()​

onAfterRender(node): void

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

A callback that is called after the component is rendered.

Parameters​

ParameterTypeDescription
nodeVNodeThe component's VNode.

Returns​

void

Inherited from​

DisplayComponent.onAfterRender


onBeforeRender()​

onBeforeRender(): void

Defined in: 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: workingtitle-instruments-g3000/html_ui/GTC/Components/TouchButton/GtcWaypointSelectButton.tsx:125

Returns​

VNode

Inherit Doc​

Overrides​

DisplayComponent.render


simulatePressed()​

simulatePressed(ignoreDisabled): void

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/TouchButton/GtcWaypointSelectButton.tsx:120

Simulates this button being pressed. This will execute the onPressed() callback if one is defined.

Parameters​

ParameterTypeDefault valueDescription
ignoreDisabledbooleanfalseWhether to simulate the button being pressed regardless of whether the button is disabled. Defaults to false.

Returns​

void