Class: UiWaypointSelectButton<T, S>
A touchscreen button which displays information about a waypoint and when pressed allows the user to select a a facility waypoint by ident.
Type parameters
| Name | Type |
|---|---|
T | extends G3XWaypointSearchType |
S | extends Subscribable<G3XWaypointSearchTypeMap[T] | null> |
Hierarchy
DisplayComponent<UiWaypointSelectButtonProps<T,S>>↳
UiWaypointSelectButton
Constructors
constructor
• new UiWaypointSelectButton<T, S>(props): UiWaypointSelectButton<T, S>
Creates an instance of a DisplayComponent.
Type parameters
| Name | Type |
|---|---|
T | extends G3XWaypointSearchType |
S | extends Subscribable<null | G3XWaypointSearchTypeMap[T]> |
Parameters
| Name | Type | Description |
|---|---|---|
props | UiWaypointSelectButtonProps<T, S> | The propertis of the component. |
Returns
UiWaypointSelectButton<T, S>
Inherited from
DisplayComponent<UiWaypointSelectButtonProps<T, S>>.constructor
Defined in
src/sdk/components/FSComponent.ts:73
Properties
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
props
• props: UiWaypointSelectButtonProps<T, S> & ComponentProps
The properties of the component.
Inherited from
DisplayComponent.props
Defined in
src/sdk/components/FSComponent.ts:61
Methods
destroy
▸ destroy(): void
Returns
void
Inherit Doc
Overrides
DisplayComponent.destroy
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Components/TouchButton/UiWaypointSelectButton.tsx:140
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
getRootElement
▸ getRootElement(): HTMLElement
Gets this button's root HTML element.
Returns
HTMLElement
This button's root HTML element.
Throws
Error if this button has not yet been rendered.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Components/TouchButton/UiWaypointSelectButton.tsx:74
onAfterRender
▸ onAfterRender(node): void
A callback that is called after the component is rendered.
Parameters
| Name | Type | Description |
|---|---|---|
node | VNode | The component's VNode. |
Returns
void
Inherited from
DisplayComponent.onAfterRender
Defined in
src/sdk/components/FSComponent.ts:87
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
render
▸ render(): VNode
Returns
VNode
Inherit Doc
Overrides
DisplayComponent.render
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Components/TouchButton/UiWaypointSelectButton.tsx:88
simulatePressed
▸ simulatePressed(ignoreDisabled?): void
Simulates this button being pressed. This will execute the onPressed() callback if one is defined.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
ignoreDisabled | boolean | false | Whether to simulate the button being pressed regardless of whether the button is disabled. Defaults to false. |
Returns
void
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Components/TouchButton/UiWaypointSelectButton.tsx:83