Class: WaypointInfoPaneView
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/WaypointInfoPane/WaypointInfoPaneView.tsx:44
A display pane view which displays a waypoint information map.
Extends
Constructors
Constructor
new WaypointInfoPaneView(
props
):WaypointInfoPaneView
Defined in: src/sdk/components/FSComponent.ts:73
Creates an instance of a DisplayComponent.
Parameters
Parameter | Type | Description |
---|---|---|
props | WaypointInfoPaneViewProps | The propertis of the component. |
Returns
WaypointInfoPaneView
Inherited from
Properties
_title
protected
readonly
_title:Subject
<string
|VNode
>
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPaneView.ts:21
Inherited from
context?
optional
context: [] =undefined
Defined in: src/sdk/components/FSComponent.ts:64
The context on this component, if any.
Inherited from
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
isPfd
readonly
isPfd:boolean
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPaneView.ts:25
Inherited from
props
props:
WaypointInfoPaneViewProps
&ComponentProps
Defined in: src/sdk/components/FSComponent.ts:61
The properties of the component.
Inherited from
title
readonly
title:Subscribable
<string
|VNode
>
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPaneView.ts:23
The title of this display pane view.
Inherited from
Methods
destroy()
destroy():
void
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/WaypointInfoPane/WaypointInfoPaneView.tsx:304
Destroys this component.
Returns
void
Overrides
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
onAfterRender()
onAfterRender():
void
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/WaypointInfoPane/WaypointInfoPaneView.tsx:139
A callback that is called after the component is rendered.
Returns
void
Overrides
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
DisplayPaneView
.onBeforeRender
onEvent()
onEvent(
event
):void
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/WaypointInfoPane/WaypointInfoPaneView.tsx:182
Called when a display pane view event is received by this view.
Parameters
Parameter | Type | Description |
---|---|---|
event | DisplayPaneViewEvent <WaypointInfoPaneViewEventTypes > | The event. |
Returns
void
Overrides
onPause()
onPause():
void
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/WaypointInfoPane/WaypointInfoPaneView.tsx:155
Called when this view is hidden.
Returns
void
Overrides
onResize()
onResize(
size
,width
,height
):void
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/WaypointInfoPane/WaypointInfoPaneView.tsx:164
Called when this view's parent pane is resized while this view is visible.
Parameters
Parameter | Type | Description |
---|---|---|
size | DisplayPaneSizeMode | The size of this view's parent pane. |
width | number | The width of this view's parent pane, in pixels. |
height | number | The height of this view's parent pane, in pixels. |
Returns
void
Overrides
onResume()
onResume(
size
,width
,height
):void
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/WaypointInfoPane/WaypointInfoPaneView.tsx:148
Called when this view is made visible.
Parameters
Parameter | Type | Description |
---|---|---|
size | DisplayPaneSizeMode | The size of this view's parent pane. |
width | number | The width of this view's parent pane, in pixels. |
height | number | The height of this view's parent pane, in pixels. |
Returns
void
Overrides
onUpdate()
onUpdate(
time
):void
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/WaypointInfoPane/WaypointInfoPaneView.tsx:169
Called every update cycle.
Parameters
Parameter | Type | Description |
---|---|---|
time | number | The current real (operating system) time, as a UNIX timestamp in milliseconds. |
Returns
void
Overrides
render()
render():
null
|VNode
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/WaypointInfoPane/WaypointInfoPaneView.tsx:297
Renders the component.
Returns
null
| VNode
A JSX element to be rendered.