Skip to main content

Class: PfdInstrumentContainer

Defined in: workingtitle-instruments-g3000/html_ui/PFD/Components/InstrumentContainer/PfdInstrumentContainer.tsx:128

A container for the main PFD instrument display.

Extends​

Constructors​

Constructor​

new PfdInstrumentContainer(props): PfdInstrumentContainer

Defined in: workingtitle-instruments-g3000/html_ui/PFD/Components/InstrumentContainer/PfdInstrumentContainer.tsx:246

Parameters​

ParameterType
propsPfdInstrumentContainerProps

Returns​

PfdInstrumentContainer

Inherit Doc​

Overrides​

DisplayPaneView<PfdInstrumentContainerProps>.constructor

Properties​

_title​

protected readonly _title: Subject<string | VNode>

Defined in: workingtitle-instruments-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPaneView.ts:21

Inherited from​

DisplayPaneView._title


context?​

optional context: [] = undefined

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

The context on this component, if any.

Inherited from​

DisplayPaneView.context


contextType?​

readonly optional contextType: readonly [] = undefined

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

The type of context for this component, if any.

Inherited from​

DisplayPaneView.contextType


isPfd​

readonly isPfd: boolean

Defined in: workingtitle-instruments-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPaneView.ts:25

Inherited from​

DisplayPaneView.isPfd


props​

props: PfdInstrumentContainerProps & ComponentProps

Defined in: sdk/components/FSComponent.ts:61

The properties of the component.

Inherited from​

DisplayPaneView.props


title​

readonly title: Subscribable<string | VNode>

Defined in: workingtitle-instruments-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPaneView.ts:23

The title of this display pane view.

Inherited from​

DisplayPaneView.title

Methods​

destroy()​

destroy(): void

Defined in: workingtitle-instruments-g3000/html_ui/PFD/Components/InstrumentContainer/PfdInstrumentContainer.tsx:706

Returns​

void

Inherit Doc​

Overrides​

DisplayPaneView.destroy


getContext()​

protected getContext(context): never

Defined in: sdk/components/FSComponent.ts:106

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​

DisplayPaneView.getContext


onAfterRender()​

onAfterRender(thisNode): void

Defined in: workingtitle-instruments-g3000/html_ui/PFD/Components/InstrumentContainer/PfdInstrumentContainer.tsx:319

Parameters​

ParameterType
thisNodeVNode

Returns​

void

Inherit Doc​

Overrides​

DisplayPaneView.onAfterRender


onBeforeRender()​

onBeforeRender(): void

Defined in: sdk/components/FSComponent.ts:80

A callback that is called before the component is rendered.

Returns​

void

Inherited from​

DisplayPaneView.onBeforeRender


onEvent()​

onEvent(event): void

Defined in: workingtitle-instruments-g3000/html_ui/PFD/Components/InstrumentContainer/PfdInstrumentContainer.tsx:423

Parameters​

ParameterType
eventDisplayPaneViewEvent

Returns​

void

Inherit Doc​

Overrides​

DisplayPaneView.onEvent


onPause()​

onPause(): void

Defined in: workingtitle-instruments-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPaneView.ts:40

Called when this view is hidden.

Returns​

void

Inherited from​

DisplayPaneView.onPause


onResize()​

onResize(size, width, height): void

Defined in: workingtitle-instruments-g3000/html_ui/PFD/Components/InstrumentContainer/PfdInstrumentContainer.tsx:392

Parameters​

ParameterType
sizeDisplayPaneSizeMode
widthnumber
heightnumber

Returns​

void

Inherit Doc​

Overrides​

DisplayPaneView.onResize


onResume()​

onResume(size, width, height): void

Defined in: workingtitle-instruments-g3000/html_ui/PFD/Components/InstrumentContainer/PfdInstrumentContainer.tsx:386

Parameters​

ParameterType
sizeDisplayPaneSizeMode
widthnumber
heightnumber

Returns​

void

Inherit Doc​

Overrides​

DisplayPaneView.onResume


onUpdate()​

onUpdate(time): void

Defined in: workingtitle-instruments-g3000/html_ui/PFD/Components/InstrumentContainer/PfdInstrumentContainer.tsx:416

Parameters​

ParameterType
timenumber

Returns​

void

Inherit Doc​

Overrides​

DisplayPaneView.onUpdate


render()​

render(): VNode

Defined in: workingtitle-instruments-g3000/html_ui/PFD/Components/InstrumentContainer/PfdInstrumentContainer.tsx:445

Returns​

VNode

Inherit Doc​

Overrides​

DisplayPaneView.render