Skip to main content

Interface: PfdInstrumentsPluginComponent

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/PfdInstruments/PfdInstrumentsPluginComponent.ts:8

A display component that is rendered by a plugin into a PFD instruments view.

Extends

  • DisplayComponent<any>

Properties

context?

optional context: [] = undefined

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

The context on this component, if any.

Inherited from

DisplayComponent.context


contextType?

readonly optional contextType: readonly [] = undefined

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

The type of context for this component, if any.

Inherited from

DisplayComponent.contextType


isPfdInstrumentsPluginComponent

readonly isPfdInstrumentsPluginComponent: true

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/PfdInstruments/PfdInstrumentsPluginComponent.ts:10

Flags this component as a PFD instruments plugin component.


props

props: any

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

The properties of the component.

Inherited from

DisplayComponent.props

Methods

destroy()

destroy(): void

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

Destroys this component.

Returns

void

Inherited from

DisplayComponent.destroy


getContext()

protected getContext(context): never

Defined in: src/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

DisplayComponent.getContext


onAfterRender()

onAfterRender(node): void

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

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:80

A callback that is called before the component is rendered.

Returns

void

Inherited from

DisplayComponent.onBeforeRender


onClose()

onClose(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/PfdInstruments/PfdInstrumentsPluginComponent.ts:22

Responds to when this component's parent view is closed.

Returns

void


onOcclusionChange()

onOcclusionChange(occlusionType): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/PfdInstruments/PfdInstrumentsPluginComponent.ts:45

Responds to when the occlusion type applied to this component's parent view changes while the view is open.

Parameters

ParameterTypeDescription
occlusionTypeUiViewOcclusionTypeThe new occlusion type applied to the view.

Returns

void


onOpen()

onOpen(sizeMode, dimensions): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/PfdInstruments/PfdInstrumentsPluginComponent.ts:17

Responds to when this component's parent view is opened.

Parameters

ParameterTypeDescription
sizeModeUiViewSizeModeThe new size mode of the view's container.
dimensionsReadonlyFloat64ArrayThe new dimensions of the view's container, as [width, height] in pixels.

Returns

void


onPause()

onPause(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/PfdInstruments/PfdInstrumentsPluginComponent.ts:32

Responds to when this component's parent view is paused.

Returns

void


onResize()

onResize(sizeMode, dimensions): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/PfdInstruments/PfdInstrumentsPluginComponent.ts:39

Responds when this component's parent view's container is resized while it is open.

Parameters

ParameterTypeDescription
sizeModeUiViewSizeModeThe new size mode of the view's container.
dimensionsReadonlyFloat64ArrayThe new dimensions of the view's container, as [width, height] in pixels.

Returns

void


onResume()

onResume(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/PfdInstruments/PfdInstrumentsPluginComponent.ts:27

Responds to when this component's parent view is resumed.

Returns

void


onUpdate()

onUpdate(time): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/PfdInstruments/PfdInstrumentsPluginComponent.ts:51

Called every update cycle.

Parameters

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

Returns

void


render()

abstract render(): null | VNode

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

Renders the component.

Returns

null | VNode

A JSX element to be rendered.

Inherited from

DisplayComponent.render