Class: UiPaneViewStackContainer

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiPaneViewStackContainer.tsx:21

A UI view stack container contained in a UI pane.

Extends

• DisplayComponent<UiPaneViewStackContainerProps>

Implements

• UiPaneContent
• UiViewStackContainer

Constructors

Constructor

new UiPaneViewStackContainer(props): UiPaneViewStackContainer

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

Creates an instance of a DisplayComponent.

Parameters

Parameter	Type	Description
props	UiPaneViewStackContainerProps	The propertis of the component.

Returns

UiPaneViewStackContainer

Inherited from

DisplayComponent<UiPaneViewStackContainerProps>.constructor

Properties

context?

optional context: [] = undefined

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

The context on this component, if any.

Implementation of

UiPaneContent.context

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.

Implementation of

UiPaneContent.contextType

Inherited from

DisplayComponent.contextType

---

isUiPaneContent

readonly isUiPaneContent: true = true

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiPaneViewStackContainer.tsx:23

Flags this component as a UiPaneContent.

Implementation of

UiPaneContent.isUiPaneContent

---

props

props: UiPaneViewStackContainerProps & ComponentProps

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

The properties of the component.

Implementation of

UiPaneContent.props

Inherited from

DisplayComponent.props

---

rootRef

readonly rootRef: NodeReference<HTMLElement>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiPaneViewStackContainer.tsx:26

A reference to this container's root element.

Implementation of

UiViewStackContainer.rootRef

---

sizeChanged

readonly sizeChanged: SubEvent<UiViewStackContainer, void>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiPaneViewStackContainer.tsx:35

An event that fires when the size of this container changes.

Implementation of

UiViewStackContainer.sizeChanged

Methods

destroy()

destroy(): void

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

Destroys this component.

Returns

void

Implementation of

UiPaneContent.destroy

Inherited from

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.

Implementation of

UiPaneContent.getContext

Inherited from

DisplayComponent.getContext

---

getDimensions()

getDimensions(): ReadonlyFloat64Array

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiPaneViewStackContainer.tsx:46

Gets this container's current dimensions, as [width, height] in pixels.

Returns

ReadonlyFloat64Array

This container's current dimensions, as [width, height] in pixels.

Implementation of

UiViewStackContainer.getDimensions

---

getSizeMode()

getSizeMode(): UiViewSizeMode

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiPaneViewStackContainer.tsx:41

Gets this container's current size mode.

Returns

UiViewSizeMode

This container's current size mode.

Implementation of

UiViewStackContainer.getSizeMode

---

onAfterRender()

onAfterRender(node): void

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

A callback that is called after the component is rendered.

Parameters

Parameter	Type	Description
node	VNode	The component's VNode.

Returns

void

Implementation of

UiPaneContent.onAfterRender

Inherited from

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

Implementation of

UiPaneContent.onBeforeRender

Inherited from

DisplayComponent.onBeforeRender

---

onInit()

onInit(sizeMode, dimensions): void

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

Responds to when this content is initially rendered to its parent pane.

Parameters

Parameter	Type	Description
sizeMode	UiPaneSizeMode	The size mode of this content's parent pane.
dimensions	ReadonlyFloat64Array	The dimensions of this content's parent pane, as [width, height] in pixels.

Returns

void

Implementation of

UiPaneContent.onInit

---

onPause()

onPause(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiPaneViewStackContainer.tsx:61

Responds to when this content's parent pane is made either hidden or asleep.

Returns

void

Implementation of

UiPaneContent.onPause

---

onResize()

onResize(sizeMode, dimensions): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiPaneViewStackContainer.tsx:66

Responds when this content's parent pane is resized while it is visible and awake.

Parameters

Parameter	Type	Description
sizeMode	UiPaneSizeMode	The new size mode of this content's pane.
dimensions	ReadonlyFloat64Array	The new dimensions of this content's pane, as [width, height] in pixels.

Returns

void

Implementation of

UiPaneContent.onResize

---

onResume()

onResume(sizeMode, dimensions): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiPaneViewStackContainer.tsx:56

Responds to when this content's parent pane is made visible and awake.

Parameters

Parameter	Type	Description
sizeMode	UiPaneSizeMode	The size mode of this content's parent pane.
dimensions	ReadonlyFloat64Array	The dimensions of this content's parent pane, as [width, height] in pixels.

Returns

void

Implementation of

UiPaneContent.onResume

---

onUpdate()

onUpdate(time): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiPaneViewStackContainer.tsx:99

Called every update cycle.

Parameters

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

Returns

void

Implementation of

UiPaneContent.onUpdate

---

render()

render(): VNode

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiPaneViewStackContainer.tsx:109

Renders the component.

Returns

VNode

A JSX element to be rendered.

Implementation of

UiPaneContent.render

Overrides

DisplayComponent.render

---

renderView()

renderView(layer, view): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiPaneViewStackContainer.tsx:104

Renders a view into this container.

Parameters

Parameter	Type	Description
layer	UiViewStackLayer	The layer to which to render the view.
view	VNode	A UI view, as a VNode.

Returns

void

Implementation of

UiViewStackContainer.renderView