Skip to main content

Class: UiPane

A UI pane which can be resized to be full-size, half-size, or hidden. Any UiPaneContent components that are rendered as descendants of a UI pane will be notified of certain events related to the pane, including changes to the pane's size, changes to its waking state, and update ticks.

Hierarchy

Constructors

constructor

new UiPane(props): UiPane

Creates an instance of a DisplayComponent.

Parameters

NameTypeDescription
propsUiPanePropsThe propertis of the component.

Returns

UiPane

Inherited from

DisplayComponent<UiPaneProps>.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: UiPaneProps & 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-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/UiPane.tsx:242


getContext

getContext(context): never

Gets a context data subscription from the context collection.

Parameters

NameTypeDescription
contextneverThe 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 pane is awake.

Returns

boolean

Whether this pane is awake.

Defined in

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


onAfterRender

onAfterRender(thisNode): void

Parameters

NameType
thisNodeVNode

Returns

void

Inherit Doc

Overrides

DisplayComponent.onAfterRender

Defined in

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


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-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/UiPane.tsx:223


sleep

sleep(): void

Puts this pane to sleep. This will pause this pane's active view (if one exists) and suspend handling of display pane view events.

Returns

void

Throws

Error if this pane has been destroyed.

Defined in

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


update

update(time): void

Updates this display pane. Has no effect if this display pane is not visible.

Parameters

NameTypeDescription
timenumberThe current real (operating system) time, as a Javascript timestamp.

Returns

void

Defined in

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


wake

wake(): void

Wakes this pane. This will resume this pane's active view (if one exists) and resume handling of display pane view events.

Returns

void

Throws

Error if this pane has been destroyed.

Defined in

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