Skip to main content

Interface: UiPaneContainerProps

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

Component props for UiPaneContainer.

Extends​

  • ComponentProps

Properties​

alternateUpdatesInSplitMode?​

optional alternateUpdatesInSplitMode: boolean | Subscribable<boolean>

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

Whether to alternate updates every other update cycle for each pane while both panes are visible. Defaults to false.

bus​

bus: EventBus

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

An instance of the event bus.

children?​

optional children: DisplayChildren[]

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

The children of the display component.

Inherited from​

ComponentProps.children

class?​

optional class: string | SubscribableSet<string>

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

CSS class(es) to apply to the root element of the container.

isPane1Visible​

isPane1Visible: Subscribable<boolean>

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

Whether pane 1 is visible.

isPane2Visible​

isPane2Visible: Subscribable<boolean>

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

Whether pane 2 is visible.

pane1Content?​

optional pane1Content: VNode

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

The content to render to pane 1.

pane1HalfSize​

pane1HalfSize: Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">> | Subscribable<Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>>

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

The size of pane 1's content area in half mode, as [width, height] in pixels.

pane2Content?​

optional pane2Content: VNode

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

The content to render to pane 2.

pane2HalfSize​

pane2HalfSize: Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">> | Subscribable<Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>>

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

The size of pane 2's content area in half mode, as [width, height] in pixels.

paneFullSize​

paneFullSize: Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">> | Subscribable<Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>>

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

The size of a pane's content area in full mode, as [width, height] in pixels.

ref?​

optional ref: NodeReference<any>

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

A reference to the display component.

Inherited from​

ComponentProps.ref

updateFreq​

updateFreq: number | Subscribable<number>

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

The update frequency of the container's panes.