Class: PfdInsetContainer

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/GduDisplay/Gdu460/PfdInstruments/Inset/PfdInsetContainer.tsx:52

A container for PFD insets.

Extends

• DisplayComponent<PfdInsetContainerProps>

Constructors

Constructor

new PfdInsetContainer(props): PfdInsetContainer

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

Creates an instance of a DisplayComponent.

Parameters

Parameter	Type	Description
props	PfdInsetContainerProps	The propertis of the component.

Returns

PfdInsetContainer

Inherited from

DisplayComponent.constructor

Properties

activeInsetEntry

readonly activeInsetEntry: Subscribable<PfdInsetEntry | null>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/GduDisplay/Gdu460/PfdInstruments/Inset/PfdInsetContainer.tsx:78

This container's current active inset, or null if there is no active inset.

---

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: PfdInsetContainerProps & 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/workingtitle-instruments-g3x-touch/html_ui/GduDisplay/Gdu460/PfdInstruments/Inset/PfdInsetContainer.tsx:310

Destroys this component.

Returns

void

Overrides

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

---

isAwake()

isAwake(): boolean

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/GduDisplay/Gdu460/PfdInstruments/Inset/PfdInsetContainer.tsx:105

Checks whether this container is awake.

Returns

boolean

Whether this container is awake.

---

onAfterRender()

onAfterRender(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/GduDisplay/Gdu460/PfdInstruments/Inset/PfdInsetContainer.tsx:92

A callback that is called after the component is rendered.

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

---

render()

render(): VNode

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/GduDisplay/Gdu460/PfdInstruments/Inset/PfdInsetContainer.tsx:294

Renders the component.

Returns

VNode

A JSX element to be rendered.

Overrides

DisplayComponent.render

---

setSize()

setSize(sizeMode): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/GduDisplay/Gdu460/PfdInstruments/Inset/PfdInsetContainer.tsx:155

Sets the size of this container.

Parameters

Parameter	Type	Description
sizeMode	PfdInsetSizeMode	The new size mode.

Returns

void

Throws

Error if this container has been destroyed.

---

sleep()

sleep(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/GduDisplay/Gdu460/PfdInstruments/Inset/PfdInsetContainer.tsx:131

Puts this container to sleep. This will close the active inset (if one exists).

Returns

void

Throws

Error if this container has been destroyed.

---

update()

update(time): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/GduDisplay/Gdu460/PfdInstruments/Inset/PfdInsetContainer.tsx:181

Updates this container.

Parameters

Parameter	Type	Description
time	number	The current real (operating system) time, as a Javascript timestamp in milliseconds.

Returns

void

Throws

Error if this container has been destroyed.

---

wake()

wake(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/GduDisplay/Gdu460/PfdInstruments/Inset/PfdInsetContainer.tsx:113

Wakes this container. This will open the active inset (if one exists).

Returns

void

Throws

Error if this container has been destroyed.