Skip to main content

Class: WaypointInfo

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/WaypointInfo/WaypointInfo.tsx:102

A component which displays waypoint information.

Extends​

Implements​

Constructors​

Constructor​

new WaypointInfo(props): WaypointInfo

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

Creates an instance of a DisplayComponent.

Parameters​

ParameterTypeDescription
propsWaypointInfoPropsThe propertis of the component.

Returns​

WaypointInfo

Inherited from​

DisplayComponent<WaypointInfoProps>.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


knobLabelState​

readonly knobLabelState: SubscribableMap<UiKnobId, string> & Subscribable<UiKnobRequestedLabelState>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/WaypointInfo/WaypointInfo.tsx:171

The bezel rotary knob label state requested by this display.


props​

props: WaypointInfoProps & 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/MFD/Components/WaypointInfo/WaypointInfo.tsx:693

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​

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(thisNode): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/WaypointInfo/WaypointInfo.tsx:178

Parameters​

ParameterType
thisNodeVNode

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


onClose()​

onClose(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/WaypointInfo/WaypointInfo.tsx:234

Responds to when this display's parent view is closed.

Returns​

void


onOcclusionChange()​

onOcclusionChange(occlusionType): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/WaypointInfo/WaypointInfo.tsx:349

Responds to when the occlusion type applied to this display's parent view changes while the view is open.

Parameters​

ParameterTypeDescription
occlusionTypeUiViewOcclusionTypeThe new occlusion type applied to this display's parent view.

Returns​

void


onOpen()​

onOpen(sizeMode, dimensions): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/WaypointInfo/WaypointInfo.tsx:219

Responds to when this display's parent view is opened.

Parameters​

ParameterTypeDescription
sizeModeUiViewSizeModeThe new size mode of this display's parent view.
dimensionsReadonlyFloat64ArrayThe new dimensions of this display, as [width, height] in pixels.

Returns​

void


onPause()​

onPause(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/WaypointInfo/WaypointInfo.tsx:262

Responds to when this display's parent view is paused.

Returns​

void


onResize()​

onResize(sizeMode, dimensions): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/WaypointInfo/WaypointInfo.tsx:277

Responds to when this display's parent view is resized while open.

Parameters​

ParameterTypeDescription
sizeModeUiViewSizeModeThe new size mode of this display's parent view.
dimensionsReadonlyFloat64ArrayThe new dimensions of this display, as [width, height] in pixels.

Returns​

void


onResume()​

onResume(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/WaypointInfo/WaypointInfo.tsx:248

Responds to when this display's parent view is resumed.

Returns​

void


onUiInteractionEvent()​

onUiInteractionEvent(event): boolean

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/WaypointInfo/WaypointInfo.tsx:372

Handles a UiInteractionEvent.

Parameters​

ParameterTypeDescription
eventUiInteractionEventThe event to handle.

Returns​

boolean

Whether the event was handled.

Implementation of​

UiInteractionHandler.onUiInteractionEvent


onUpdate()​

onUpdate(time): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/WaypointInfo/WaypointInfo.tsx:366

Responds to when this display's parent view is updated.

Parameters​

ParameterTypeDescription
timenumberThe current real (operating system) time, as a Javascript timestamp.

Returns​

void


render()​

render(): VNode

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/WaypointInfo/WaypointInfo.tsx:504

Returns​

VNode

Inherit Doc​

Overrides​

DisplayComponent.render


selectWaypoint()​

selectWaypoint(waypoint): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/WaypointInfo/WaypointInfo.tsx:210

Selects a waypoint for this display.

Parameters​

ParameterTypeDescription
waypointnull | FacilityWaypoint<Facility>The waypoint to select, or null to clear the selected waypoint.

Returns​

void