Skip to main content

Interface: WeightBalancePaneViewPanel

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/WeightBalancePane/WeightBalancePaneViewPanel.ts:6

A panel for the weight and balance pane.

Extends​

Properties​

context?​

optional context: [] = undefined

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

The context on this component, if any.

Inherited from​

DisplayComponent.context


contextType?​

readonly optional contextType: readonly [] = undefined

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

The type of context for this component, if any.

Inherited from​

DisplayComponent.contextType


props​

props: any

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

The properties of the component.

Inherited from​

DisplayComponent.props

Methods​

destroy()​

destroy(): void

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

Destroys this component.

Returns​

void

Inherited from​

DisplayComponent.destroy


getContext()​

protected getContext(context): never

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

Gets a context data subscription from the context collection.

Parameters​

ParameterTypeDescription
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


onAfterRender()​

onAfterRender(node): void

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

A callback that is called after the component is rendered.

Parameters​

ParameterTypeDescription
nodeVNodeThe component's VNode.

Returns​

void

Inherited from​

DisplayComponent.onAfterRender


onBeforeRender()​

onBeforeRender(): void

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

A callback that is called before the component is rendered.

Returns​

void

Inherited from​

DisplayComponent.onBeforeRender


onPause()​

onPause(): void

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/WeightBalancePane/WeightBalancePaneViewPanel.ts:18

A method which is called when this panel is paused. The panel is paused when it is hidden and immediately before it is resized.

Returns​

void


onResume()​

onResume(isPaneInFullMode): void

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/WeightBalancePane/WeightBalancePaneViewPanel.ts:12

A method which is called when this panel is resumed. The panel is resumed when it is un-hidden and immediately after it is resized.

Parameters​

ParameterTypeDescription
isPaneInFullModebooleanWhether this panel's parent pane is in Full display mode.

Returns​

void


onUpdate()​

onUpdate(time): void

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/WeightBalancePane/WeightBalancePaneViewPanel.ts:25

A method which is called when this panel is paused. The panel is paused when it is hidden and immediately before it is resized.

Parameters​

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

Returns​

void


render()​

abstract render(): VNode | null

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

Renders the component.

Returns​

VNode | null

A JSX element to be rendered.

Inherited from​

DisplayComponent.render