Abstract Class: DisplayPaneView<P, E>

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPaneView.ts:18

A DisplayPaneView component

Extends

• DisplayComponent<P>

Extended by

• ChartsPaneView
• ChecklistPaneView
• GpsStatusPane
• NavigationMapPaneView
• NearestPaneView
• ProcedurePreviewPaneView
• TrafficMapPaneView
• WaypointInfoPaneView
• ConnextWeatherPaneView
• WeatherRadarPaneView
• WeightBalancePaneView
• PfdInstrumentContainer

Type Parameters

Type Parameter	Default type
P extends DisplayPaneViewProps	DisplayPaneViewProps
E extends DisplayPaneViewEvent<any>	DisplayPaneViewEvent

Constructors

Constructor

new DisplayPaneView<P, E>(props): DisplayPaneView<P, E>

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

Creates an instance of a DisplayComponent.

Parameters

Parameter	Type	Description
props	P	The propertis of the component.

Returns

DisplayPaneView<P, E>

Inherited from

DisplayComponent.constructor

Properties

_title

protected readonly _title: Subject<string | VNode>

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPaneView.ts:21

---

context?

optional context: [] = undefined

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

The context on this component, if any.

Inherited from

DisplayComponent.context

---

contextType?

readonly optional contextType: readonly [] = undefined

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

The type of context for this component, if any.

Inherited from

DisplayComponent.contextType

---

isPfd

readonly isPfd: boolean

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPaneView.ts:25

---

props

props: P & ComponentProps

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

The properties of the component.

Inherited from

DisplayComponent.props

---

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.

Methods

destroy()

destroy(): void

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

Destroys this component.

Returns

void

Inherited from

DisplayComponent.destroy

---

getContext()

protected getContext(context): never

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

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

---

onAfterRender()

onAfterRender(node): void

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

A callback that is called after the component is rendered.

Parameters

Parameter	Type	Description
node	VNode	The component's VNode.

Returns

void

Inherited from

DisplayComponent.onAfterRender

---

onBeforeRender()

onBeforeRender(): void

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

A callback that is called before the component is rendered.

Returns

void

Inherited from

DisplayComponent.onBeforeRender

---

onEvent()

onEvent(event): void

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPaneView.ts:66

Called when a display pane view event is received by this view.

Parameters

Parameter	Type	Description
event	E	The event.

Returns

void

---

onInteractionEvent()

onInteractionEvent(event): boolean

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPaneView.ts:75

Called when this view receives an interaction event.

Parameters

Parameter	Type	Description
event	string	The interaction event.

Returns

boolean

Whether the interaction event was handled.

---

onPause()

onPause(): void

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPaneView.ts:40

Called when this view is hidden.

Returns

void

---

onResize()

onResize(size, width, height): void

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPaneView.ts:50

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

---

onResume()

onResume(size, width, height): void

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPaneView.ts:33

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

---

onUpdate()

onUpdate(time): void

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPaneView.ts:58

Called every update cycle.

Parameters

Parameter	Type	Description
time	number	The current real (operating system) time, as a UNIX timestamp in milliseconds.

Returns

void

---

render()

abstract render(): VNode | null

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

Renders the component.

Returns

VNode | null

A JSX element to be rendered.

Inherited from

DisplayComponent.render