Skip to main content

Class: UiPaneContainer

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiPaneContainer.tsx:51

A container for two UI panes. Automatically controls the size of each 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

Constructors

Constructor

new UiPaneContainer(props): UiPaneContainer

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

Creates an instance of a DisplayComponent.

Parameters

ParameterTypeDescription
propsUiPaneContainerPropsThe propertis of the component.

Returns

UiPaneContainer

Inherited from

DisplayComponent<UiPaneContainerProps>.constructor

Properties

context?

optional context: [] = undefined

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

The context on this component, if any.

Inherited from

DisplayComponent.context


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

DisplayComponent.contextType


props

props: UiPaneContainerProps & ComponentProps

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

The properties of the component.

Inherited from

DisplayComponent.props

Methods

destroy()

destroy(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiPaneContainer.tsx:240

Returns

void

Inherit Doc

Overrides

DisplayComponent.destroy


getContext()

protected getContext(context): never

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

Gets a context data subscription from the context collection.

Parameters

ParameterTypeDescription
contextneverThe 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-g3x-touch/html_ui/Shared/UiSystem/UiPaneContainer.tsx:129

Checks whether this container is awake.

Returns

boolean

Whether this container is awake.


onAfterRender()

onAfterRender(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiPaneContainer.tsx:85

Returns

void

Inherit Doc

Overrides

DisplayComponent.onAfterRender


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

DisplayComponent.onBeforeRender


render()

render(): VNode

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiPaneContainer.tsx:201

Returns

VNode

Inherit Doc

Overrides

DisplayComponent.render


sleep()

sleep(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiPaneContainer.tsx:161

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-g3x-touch/html_ui/Shared/UiSystem/UiPaneContainer.tsx:137

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

Returns

void

Throws

Error if this container has been destroyed.