Class: DisplayPaneContainer

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPaneContainer.tsx:56

A container for two display panes: a left pane and a right pane. Automatically controls the size of each display pane such that if both are visible, each is sized as a half pane, and if only one is visible, it is sized as a full pane.

Extends

• DisplayComponent<DisplayPaneContainerProps>

Constructors

Constructor

new DisplayPaneContainer(props): DisplayPaneContainer

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

Creates an instance of a DisplayComponent.

Parameters

Parameter	Type	Description
props	DisplayPaneContainerProps	The propertis of the component.

Returns

DisplayPaneContainer

Inherited from

DisplayComponent.constructor

Properties

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: DisplayPaneContainerProps & 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/DisplayPaneContainer.tsx:250

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/DisplayPaneContainer.tsx:118

Checks whether this container is awake.

Returns

boolean

Whether this container is awake.

---

onAfterRender()

onAfterRender(): void

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPaneContainer.tsx:86

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

---

render()

render(): VNode

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPaneContainer.tsx:214

Renders the component.

Returns

VNode

A JSX element to be rendered.

Overrides

DisplayComponent.render

---

routeInteractionEvent()

routeInteractionEvent(pane, event): boolean

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPaneContainer.tsx:178

Routes an interaction event to one of this container's display panes. If this pane is asleep, then the event will will not be routed and will not be handled.

Parameters

Parameter	Type	Description
pane	"left" | "right"	The pane to which to route the interaction event.
event	string	The interaction event to route.

Returns

boolean

Whether the event was handled.

Throws

Error if this container has been destroyed.

---

sleep()

sleep(): void

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPaneContainer.tsx:150

Puts this container to sleep. This will put this container's child panes to sleep and pause updates.

Returns

void

Throws

Error if this container has been destroyed.

---

wake()

wake(): void

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPaneContainer.tsx:126

Wakes this container. This will wake this container's child panes and resume updates.

Returns

void

Throws

Error if this container has been destroyed.