Interface: DisplayOverlayComponent

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/DisplayOverlay/DisplayOverlayComponent.ts:6

A display component that is rendered into a display overlay layer.

Extends

• DisplayComponent<any>

Extended by

• PfdDisplayOverlayComponent
• MfdDisplayOverlayComponent

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

---

isDisplayOverlayComponent

readonly isDisplayOverlayComponent: true

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/DisplayOverlay/DisplayOverlayComponent.ts:8

Flags this component as a display overlay 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

Parameter	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

---

onAfterRender()

onAfterRender(node): void

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

A callback that is called after the component is rendered.

Parameters

Parameter	Type	Description
node	VNode	The 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

---

onInteractionEvent()

onInteractionEvent(event): boolean

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/DisplayOverlay/DisplayOverlayComponent.ts:25

A method that is called when this component receives an interaction event.

Parameters

Parameter	Type	Description
event	string	The interaction event.

Returns

boolean

Whether the interaction event was handled.

---

onSleep()

onSleep(): void

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/DisplayOverlay/DisplayOverlayComponent.ts:18

A method that is called when this component's parent overlay layer is hidden.

Returns

void

---

onWake()

onWake(): void

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/DisplayOverlay/DisplayOverlayComponent.ts:13

A method that is called when this component's parent overlay layer is made visible.

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