Abstract Class: AbstractPfdInset<P>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/GduDisplay/Gdu460/PfdInstruments/Inset/AbstractPfdInset.ts:9

An abstract implementation of PfdInset.

Extends

• DisplayComponent<P>

Extended by

• PfdFlightPlanInset
• PfdMapInset
• PfdNearestAirportsInset
• PfdTrafficInset

Type Parameters

Type Parameter	Default type
P extends PfdInsetProps	PfdInsetProps

Implements

• PfdInset<P>

Constructors

Constructor

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

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

Creates an instance of a DisplayComponent.

Parameters

Parameter	Type	Description
props	P	The propertis of the component.

Returns

AbstractPfdInset<P>

Inherited from

DisplayComponent<P>.constructor

Properties

context?

optional context: [] = undefined

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

The context on this component, if any.

Implementation of

PfdInset.context

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.

Implementation of

PfdInset.contextType

Inherited from

DisplayComponent.contextType

---

props

props: P & ComponentProps

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

The properties of the component.

Implementation of

PfdInset.props

Inherited from

DisplayComponent.props

Methods

destroy()

destroy(): void

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

Destroys this component.

Returns

void

Implementation of

PfdInset.destroy

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.

Implementation of

PfdInset.getContext

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

Implementation of

PfdInset.onAfterRender

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

Implementation of

PfdInset.onBeforeRender

Inherited from

DisplayComponent.onBeforeRender

---

onClose()

onClose(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/GduDisplay/Gdu460/PfdInstruments/Inset/AbstractPfdInset.ts:17

Responds to when this inset is closed.

Returns

void

Implementation of

PfdInset.onClose

---

onOpen()

onOpen(sizeMode, dimensions): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/GduDisplay/Gdu460/PfdInstruments/Inset/AbstractPfdInset.ts:12

Responds to when this inset is opened.

Parameters

Parameter	Type	Description
sizeMode	PfdInsetSizeMode	The new size mode of this view's container.
dimensions	ReadonlyFloat64Array	The new dimensions of this view's container, as [width, height] in pixels.

Returns

void

Implementation of

PfdInset.onOpen

---

onResize()

onResize(sizeMode, dimensions): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/GduDisplay/Gdu460/PfdInstruments/Inset/AbstractPfdInset.ts:23

Responds when this inset's container is resized while it is open.

Parameters

Parameter	Type	Description
sizeMode	PfdInsetSizeMode	The new size mode of this inset's container.
dimensions	ReadonlyFloat64Array	The new dimensions of this inset's container, as [width, height] in pixels.

Returns

void

Implementation of

PfdInset.onResize

---

onUpdate()

onUpdate(time): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/GduDisplay/Gdu460/PfdInstruments/Inset/AbstractPfdInset.ts:29

Called every update cycle.

Parameters

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

Returns

void

Implementation of

PfdInset.onUpdate

---

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.

Implementation of

PfdInset.render

Inherited from

DisplayComponent.render