Class: DisplayPaneContainer
A container for two display panes: a left pane and a right pane. Automatically controls the size of each display pane such that if both are visible, each is sized as a half pane, and if only one is visible, it is sized as a full pane.
Hierarchy
DisplayComponent<DisplayPaneContainerProps>↳
DisplayPaneContainer
Constructors
constructor
• new DisplayPaneContainer(props): DisplayPaneContainer
Creates an instance of a DisplayComponent.
Parameters
| Name | Type | Description |
|---|---|---|
props | DisplayPaneContainerProps | The propertis of the component. |
Returns
Inherited from
DisplayComponent<DisplayPaneContainerProps>.constructor
Defined in
src/sdk/components/FSComponent.ts:73
Properties
context
• Optional context: [] = undefined
The context on this component, if any.
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.
Inherited from
DisplayComponent.contextType
Defined in
src/sdk/components/FSComponent.ts:67
props
• props: DisplayPaneContainerProps & ComponentProps
The properties of the component.
Inherited from
DisplayComponent.props
Defined in
src/sdk/components/FSComponent.ts:61
Methods
destroy
▸ destroy(): void
Returns
void
Inherit Doc
Overrides
DisplayComponent.destroy
Defined in
src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/Shared/Components/DisplayPanes/DisplayPaneContainer.tsx:226
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.
Inherited from
DisplayComponent.getContext
Defined in
src/sdk/components/FSComponent.ts:106
isAwake
▸ isAwake(): boolean
Checks whether this container is awake.
Returns
boolean
Whether this container is awake.
Defined in
src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/Shared/Components/DisplayPanes/DisplayPaneContainer.tsx:118
onAfterRender
▸ onAfterRender(): void
Returns
void
Inherit Doc
Overrides
DisplayComponent.onAfterRender
Defined in
src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/Shared/Components/DisplayPanes/DisplayPaneContainer.tsx:86
onBeforeRender
▸ onBeforeRender(): void
A callback that is called before the component is rendered.
Returns
void
Inherited from
DisplayComponent.onBeforeRender
Defined in
src/sdk/components/FSComponent.ts:80
render
▸ render(): VNode
Returns
VNode
Inherit Doc
Overrides
DisplayComponent.render
Defined in
src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/Shared/Components/DisplayPanes/DisplayPaneContainer.tsx:190
sleep
▸ sleep(): void
Puts this container to sleep. This will put this container's child panes to sleep and pause updates.
Returns
void
Throws
Error if this container has been destroyed.
Defined in
src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/Shared/Components/DisplayPanes/DisplayPaneContainer.tsx:150
wake
▸ wake(): void
Wakes this container. This will wake this container's child panes and resume updates.
Returns
void
Throws
Error if this container has been destroyed.
Defined in
src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/Shared/Components/DisplayPanes/DisplayPaneContainer.tsx:126