Class: UiPane

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiPane.tsx:37

A UI pane which can be resized to be full-size, half-size, or hidden. Any UiPaneContent components that are rendered as descendants of a UI pane will be notified of certain events related to the pane, including changes to the pane's size, changes to its waking state, and update ticks.

Extends

• DisplayComponent<UiPaneProps>

Constructors

Constructor

new UiPane(props): UiPane

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

Creates an instance of a DisplayComponent.

Parameters

Parameter	Type	Description
props	UiPaneProps	The propertis of the component.

Returns

UiPane

Inherited from

DisplayComponent.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: UiPaneProps & 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/UiPane.tsx:242

Destroys this component.

Returns

void

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

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

Checks whether this pane is awake.

Returns

boolean

Whether this pane is awake.

---

onAfterRender()

onAfterRender(thisNode): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiPane.tsx:60

A callback that is called after the component is rendered.

Parameters

Parameter	Type	Description
thisNode	VNode	The component's VNode.

Returns

void

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/UiPane.tsx:223

Renders the component.

Returns

VNode

A JSX element to be rendered.

Overrides

DisplayComponent.render

---

sleep()

sleep(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiPane.tsx:153

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.

---

update()

update(time): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiPane.tsx:178

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 Javascript timestamp.

Returns

void

---

wake()

wake(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiPane.tsx:125

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.