Class: DisplayPane

The DisplayPane component.

Hierarchy

• DisplayComponent<DisplayPaneProps>

  ↳ DisplayPane

Constructors

constructor

• new DisplayPane(props): DisplayPane

Creates an instance of a DisplayComponent.

Parameters

Name	Type	Description
props	DisplayPaneProps	The propertis of the component.

Returns

DisplayPane

Inherited from

DisplayComponent<DisplayPaneProps>.constructor

Defined in

src/sdk/components/FSComponent.ts:73

Properties

activeView

• Readonly activeView: Subscribable<null | DisplayPaneView<DisplayPaneViewProps, DisplayPaneViewEvent<DisplayPaneViewEventTypes, "display_pane_map_range_inc" | "display_pane_map_range_dec" | "display_pane_map_pointer_active_set" | "display_pane_map_pointer_active_toggle" | "display_pane_map_pointer_move">>>

The currently active view.

Defined in

src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/Shared/Components/DisplayPanes/DisplayPane.tsx:79

---

activeViewKey

• Readonly activeViewKey: Subscribable<string>

The key of the currently active view.

Defined in

src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/Shared/Components/DisplayPanes/DisplayPane.tsx:77

---

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: DisplayPaneProps & 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-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/Shared/Components/DisplayPanes/DisplayPane.tsx:405

---

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

---

isAwake

▸ isAwake(): boolean

Checks whether this pane is awake.

Returns

boolean

Whether this pane is awake.

Defined in

src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/Shared/Components/DisplayPanes/DisplayPane.tsx:155

---

onAfterRender

▸ onAfterRender(): void

Returns

void

Inherit Doc

Overrides

DisplayComponent.onAfterRender

Defined in

src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/Shared/Components/DisplayPanes/DisplayPane.tsx:102

---

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-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/Shared/Components/DisplayPanes/DisplayPane.tsx:383

---

sleep

▸ sleep(): void

Puts this pane to sleep. This will pause this pane's active view (if one exists) and suspend handling of display pane view events.

Returns

void

Throws

Error if this pane has been destroyed.

Defined in

src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/Shared/Components/DisplayPanes/DisplayPane.tsx:192

---

update

▸ update(time): void

Updates this display pane. Has no effect if this display pane is not visible.

Parameters

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

Returns

void

Defined in

src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/Shared/Components/DisplayPanes/DisplayPane.tsx:219

---

wake

▸ wake(): void

Wakes this pane. This will resume this pane's active view (if one exists) and resume handling of display pane view events.

Returns

void

Throws

Error if this pane has been destroyed.

Defined in

src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/Shared/Components/DisplayPanes/DisplayPane.tsx:164