Class: UiPaneViewStackContainer

A UI view stack container contained in a UI pane.

Hierarchy

• DisplayComponent<UiPaneViewStackContainerProps>

  ↳ UiPaneViewStackContainer

Implements

• UiPaneContent
• UiViewStackContainer

Constructors

constructor

• new UiPaneViewStackContainer(props): UiPaneViewStackContainer

Creates an instance of a DisplayComponent.

Parameters

Name	Type	Description
props	UiPaneViewStackContainerProps	The propertis of the component.

Returns

UiPaneViewStackContainer

Inherited from

DisplayComponent<UiPaneViewStackContainerProps>.constructor

Defined in

src/sdk/components/FSComponent.ts:73

Properties

context

• Optional context: [] = undefined

The context on this component, if any.

Implementation of

UiPaneContent.context

Inherited from

DisplayComponent.context

Defined in

src/sdk/components/FSComponent.ts:64

---

contextType

• Optional Readonly contextType: readonly [] = undefined

The type of context for this component, if any.

Implementation of

UiPaneContent.contextType

Inherited from

DisplayComponent.contextType

Defined in

src/sdk/components/FSComponent.ts:67

---

isUiPaneContent

• Readonly isUiPaneContent: true

Flags this component as a UiPaneContent.

Implementation of

UiPaneContent.isUiPaneContent

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/UiPaneViewStackContainer.tsx:23

---

props

• props: UiPaneViewStackContainerProps & ComponentProps

The properties of the component.

Implementation of

UiPaneContent.props

Inherited from

DisplayComponent.props

Defined in

src/sdk/components/FSComponent.ts:61

---

rootRef

• Readonly rootRef: NodeReference<HTMLElement>

A reference to this container's root element.

Implementation of

UiViewStackContainer.rootRef

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/UiPaneViewStackContainer.tsx:26

---

sizeChanged

• Readonly sizeChanged: SubEvent<UiViewStackContainer, void>

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

Implementation of

UiViewStackContainer.sizeChanged

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/UiPaneViewStackContainer.tsx:35

Methods

destroy

▸ destroy(): void

Destroys this component.

Returns

void

Implementation of

UiPaneContent.destroy

Inherited from

DisplayComponent.destroy

Defined in

src/sdk/components/FSComponent.ts:98

---

getContext

▸ getContext(context): never

Gets a context data subscription from the context collection.

Parameters

Name	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

Defined in

src/sdk/components/FSComponent.ts:106

---

getDimensions

▸ getDimensions(): Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>

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

Returns

Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>

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

Implementation of

UiViewStackContainer.getDimensions

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/UiPaneViewStackContainer.tsx:46

---

getSizeMode

▸ getSizeMode(): UiViewSizeMode

Gets this container's current size mode.

Returns

UiViewSizeMode

This container's current size mode.

Implementation of

UiViewStackContainer.getSizeMode

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/UiPaneViewStackContainer.tsx:41

---

onAfterRender

▸ onAfterRender(node): void

A callback that is called after the component is rendered.

Parameters

Name	Type	Description
node	VNode	The component's VNode.

Returns

void

Implementation of

UiPaneContent.onAfterRender

Inherited from

DisplayComponent.onAfterRender

Defined in

src/sdk/components/FSComponent.ts:87

---

onBeforeRender

▸ onBeforeRender(): void

A callback that is called before the component is rendered.

Returns

void

Implementation of

UiPaneContent.onBeforeRender

Inherited from

DisplayComponent.onBeforeRender

Defined in

src/sdk/components/FSComponent.ts:80

---

onInit

▸ onInit(sizeMode, dimensions): void

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

Parameters

Name	Type	Description
sizeMode	UiPaneSizeMode	The size mode of this content's parent pane.
dimensions	Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>	The dimensions of this content's parent pane, as [width, height] in pixels.

Returns

void

Implementation of

UiPaneContent.onInit

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/UiPaneViewStackContainer.tsx:51

---

onPause

▸ onPause(): void

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

Returns

void

Implementation of

UiPaneContent.onPause

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/UiPaneViewStackContainer.tsx:61

---

onResize

▸ onResize(sizeMode, dimensions): void

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

Parameters

Name	Type	Description
sizeMode	UiPaneSizeMode	The new size mode of this content's pane.
dimensions	Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>	The new dimensions of this content's pane, as [width, height] in pixels.

Returns

void

Implementation of

UiPaneContent.onResize

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/UiPaneViewStackContainer.tsx:66

---

onResume

▸ onResume(sizeMode, dimensions): void

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

Parameters

Name	Type	Description
sizeMode	UiPaneSizeMode	The size mode of this content's parent pane.
dimensions	Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>	The dimensions of this content's parent pane, as [width, height] in pixels.

Returns

void

Implementation of

UiPaneContent.onResume

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/UiPaneViewStackContainer.tsx:56

---

onUpdate

▸ onUpdate(time): void

Called every update cycle.

Parameters

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

Returns

void

Implementation of

UiPaneContent.onUpdate

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/UiPaneViewStackContainer.tsx:99

---

render

▸ render(): VNode

Renders the component.

Returns

VNode

A JSX element to be rendered.

Implementation of

UiPaneContent.render

Overrides

DisplayComponent.render

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/UiPaneViewStackContainer.tsx:109

---

renderView

▸ renderView(layer, view): void

Renders a view into this container.

Parameters

Name	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

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/UiPaneViewStackContainer.tsx:104