Class: DisplayPane

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPane.tsx:82

The DisplayPane component.

Extends

• DisplayComponent<DisplayPaneProps>

Constructors

Constructor

new DisplayPane(props): DisplayPane

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

Creates an instance of a DisplayComponent.

Parameters

Parameter	Type	Description
props	DisplayPaneProps	The propertis of the component.

Returns

DisplayPane

Inherited from

DisplayComponent.constructor

Properties

activeView

readonly activeView: Subscribable<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">> | null>

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPane.tsx:97

The currently active view.

---

activeViewKey

readonly activeViewKey: Subscribable<string>

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPane.tsx:95

The key of the currently active view.

---

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

---

props

props: DisplayPaneProps & ComponentProps

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

The properties of the component.

Inherited from

DisplayComponent.props

Methods

destroy()

destroy(): void

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPane.tsx:456

Destroys this component.

Returns

void

Overrides

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

---

isAwake()

isAwake(): boolean

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPane.tsx:173

Checks whether this pane is awake.

Returns

boolean

Whether this pane is awake.

---

onAfterRender()

onAfterRender(): void

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPane.tsx:120

A callback that is called after the component is rendered.

Returns

void

Overrides

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

---

onInteractionEvent()

onInteractionEvent(event): boolean

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPane.tsx:258

Handles an interaction event. The event will be routed to this display pane's active view. If this pane is asleep or hidden, or there is no active view, then the event will not be handled.

Parameters

Parameter	Type	Description
event	string	The interaction event to handle.

Returns

boolean

Whether the event was handled.

Throws

Error if this pane has been destroyed.

---

render()

render(): VNode

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPane.tsx:434

Renders the component.

Returns

VNode

A JSX element to be rendered.

Overrides

DisplayComponent.render

---

sleep()

sleep(): void

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPane.tsx:210

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

Returns

void

Throws

Error if this pane has been destroyed.

---

update()

update(time): void

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPane.tsx:238

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

Parameters

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

Returns

void

Throws

Error if this pane has been destroyed.

---

wake()

wake(): void

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPane.tsx:182

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

Returns

void

Throws

Error if this pane has been destroyed.