Class: DisplayOverlayLayer<P>

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/DisplayOverlay/DisplayOverlayLayer.tsx:22

An overlay layer that renders UI elements on top of the main content of a G3000 GDU or GTC display.

Extends

• DisplayComponent<P>

Type Parameters

Type Parameter	Default type
P extends DisplayOverlayLayerProps	DisplayOverlayLayerProps

Constructors

Constructor

new DisplayOverlayLayer<P>(props): DisplayOverlayLayer<P>

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

Creates an instance of a DisplayComponent.

Parameters

Parameter	Type	Description
props	P	The propertis of the component.

Returns

DisplayOverlayLayer<P>

Inherited from

DisplayComponent.constructor

Properties

components

protected readonly components: DisplayOverlayComponent[] = []

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/DisplayOverlay/DisplayOverlayLayer.tsx:25

---

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: P & ComponentProps

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

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(thisNode): void

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/DisplayOverlay/DisplayOverlayLayer.tsx:28

A callback that is called after the component is rendered.

Parameters

Parameter	Type	Description
thisNode	VNode	The component's VNode.

Returns

void

Overrides

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

---

onInteractionEvent()

onInteractionEvent(event): boolean

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/DisplayOverlay/DisplayOverlayLayer.tsx:79

Handles an interaction event. The event will be routed to each of this layer's DisplayOverlayComponent descendants in order of render. If this layer is not visible, then the event will not be routed and will remain unhandled.

Parameters

Parameter	Type	Description
event	string	The interaction event to handle.

Returns

boolean

Whether the interaction event was handled.

---

onVisibilityChanged()

protected onVisibilityChanged(isVisible): void

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/DisplayOverlay/DisplayOverlayLayer.tsx:58

Responds to when the visibility of this layer changes.

Parameters

Parameter	Type	Description
isVisible	boolean	Whether this layer is visible.

Returns

void

---

registerComponent()

protected registerComponent(component): void

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/DisplayOverlay/DisplayOverlayLayer.tsx:50

Registers a component with this layer.

Parameters

Parameter	Type	Description
component	DisplayOverlayComponent	The component to register.

Returns

void

---

render()

render(): VNode

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/DisplayOverlay/DisplayOverlayLayer.tsx:92

Renders the component.

Returns

VNode

A JSX element to be rendered.

Overrides

DisplayComponent.render