Skip to main content

Interface: DisplayPaneContainerProps

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPaneContainer.tsx:16

The properties for the DisplayPaneContainer component.

Extends​

Properties​

alternateUpdatesInSplitMode?​

optional alternateUpdatesInSplitMode: boolean

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPaneContainer.tsx:45

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-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPaneContainer.tsx:18

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-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPaneContainer.tsx:48

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

displayPaneViewFactory​

displayPaneViewFactory: DisplayPaneViewFactory

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPaneContainer.tsx:21

The factory to use to create display pane views.

leftIndex​

leftIndex: DisplayPaneIndex

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPaneContainer.tsx:24

The index of the left pane.

leftPaneFullSize​

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

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPaneContainer.tsx:30

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

leftPaneHalfSize​

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

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPaneContainer.tsx:33

The size of the left pane's content area in half 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

rightIndex​

rightIndex: DisplayPaneIndex

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPaneContainer.tsx:27

The index of the right pane.

rightPaneFullSize​

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

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPaneContainer.tsx:36

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

rightPaneHalfSize​

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

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPaneContainer.tsx:39

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

updateFreq​

updateFreq: number | Subscribable<number>

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPaneContainer.tsx:42

The update frequency of the container's panes.