Class: UiWaypointTouchButton
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/UiWaypointTouchButton.tsx:22
A touchscreen button which displays information about a waypoint, including its identifier, name, type, and city.
Extends
DisplayComponent
<UiWaypointTouchButtonProps
>
Constructors
Constructor
new UiWaypointTouchButton(
props
):UiWaypointTouchButton
Defined in: src/sdk/components/FSComponent.ts:73
Creates an instance of a DisplayComponent.
Parameters
Parameter | Type | Description |
---|---|---|
props | UiWaypointTouchButtonProps | The propertis of the component. |
Returns
UiWaypointTouchButton
Inherited from
DisplayComponent<UiWaypointTouchButtonProps>.constructor
Properties
context?
optional
context: [] =undefined
Defined in: src/sdk/components/FSComponent.ts:64
The context on this component, if any.
Inherited from
DisplayComponent.context
contextType?
readonly
optional
contextType: readonly [] =undefined
Defined in: src/sdk/components/FSComponent.ts:67
The type of context for this component, if any.
Inherited from
DisplayComponent.contextType
props
props:
UiWaypointTouchButtonProps
&ComponentProps
Defined in: src/sdk/components/FSComponent.ts:61
The properties of the component.
Inherited from
DisplayComponent.props
Methods
destroy()
destroy():
void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/UiWaypointTouchButton.tsx:122
Returns
void
Inherit Doc
Overrides
DisplayComponent.destroy
getContext()
protected
getContext(context
):never
Defined in: src/sdk/components/FSComponent.ts:106
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
getRootElement()
getRootElement():
HTMLElement
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/UiWaypointTouchButton.tsx:53
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.
onAfterRender()
onAfterRender():
void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/UiWaypointTouchButton.tsx:40
Returns
void
Inherit Doc
Overrides
DisplayComponent.onAfterRender
onBeforeRender()
onBeforeRender():
void
Defined in: src/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: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/UiWaypointTouchButton.tsx:67
Returns
VNode
Inherit Doc
Overrides
DisplayComponent.render
simulatePressed()
simulatePressed(
ignoreDisabled
):void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/UiWaypointTouchButton.tsx:62
Simulates this button being pressed. This will execute the onPressed()
callback if one is defined.
Parameters
Parameter | 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