Skip to main content

Class: AbstractPfdInset<P>

An abstract implementation of PfdInset.

Type parameters

NameType
Pextends PfdInsetProps = PfdInsetProps

Hierarchy

Implements

Constructors

constructor

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

Creates an instance of a DisplayComponent.

Type parameters

NameType
Pextends PfdInsetProps = PfdInsetProps

Parameters

NameTypeDescription
propsPThe propertis of the component.

Returns

AbstractPfdInset<P>

Inherited from

DisplayComponent<P>.constructor

Defined in

src/sdk/components/FSComponent.ts:73

Properties

context

Optional context: [] = undefined

The context on this component, if any.

Implementation of

PfdInset.context

Inherited from

DisplayComponent.context

Defined in

src/sdk/components/FSComponent.ts:64


contextType

Optional Readonly contextType: readonly [] = undefined

The type of context for this component, if any.

Implementation of

PfdInset.contextType

Inherited from

DisplayComponent.contextType

Defined in

src/sdk/components/FSComponent.ts:67


props

props: P & ComponentProps

The properties of the component.

Implementation of

PfdInset.props

Inherited from

DisplayComponent.props

Defined in

src/sdk/components/FSComponent.ts:61

Methods

destroy

destroy(): void

Destroys this component.

Returns

void

Implementation of

PfdInset.destroy

Inherited from

DisplayComponent.destroy

Defined in

src/sdk/components/FSComponent.ts:98


getContext

getContext(context): never

Gets a context data subscription from the context collection.

Parameters

NameTypeDescription
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.

Implementation of

PfdInset.getContext

Inherited from

DisplayComponent.getContext

Defined in

src/sdk/components/FSComponent.ts:106


onAfterRender

onAfterRender(node): void

A callback that is called after the component is rendered.

Parameters

NameTypeDescription
nodeVNodeThe component's VNode.

Returns

void

Implementation of

PfdInset.onAfterRender

Inherited from

DisplayComponent.onAfterRender

Defined in

src/sdk/components/FSComponent.ts:87


onBeforeRender

onBeforeRender(): void

A callback that is called before the component is rendered.

Returns

void

Implementation of

PfdInset.onBeforeRender

Inherited from

DisplayComponent.onBeforeRender

Defined in

src/sdk/components/FSComponent.ts:80


onClose

onClose(): void

Responds to when this inset is closed.

Returns

void

Implementation of

PfdInset.onClose

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/GduDisplay/Gdu460/PfdInstruments/Inset/AbstractPfdInset.ts:17


onOpen

onOpen(sizeMode, dimensions): void

Responds to when this inset is opened.

Parameters

NameTypeDescription
sizeModePfdInsetSizeModeThe new size mode of this view's container.
dimensionsReadonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>The new dimensions of this view's container, as [width, height] in pixels.

Returns

void

Implementation of

PfdInset.onOpen

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/GduDisplay/Gdu460/PfdInstruments/Inset/AbstractPfdInset.ts:12


onResize

onResize(sizeMode, dimensions): void

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

Parameters

NameTypeDescription
sizeModePfdInsetSizeModeThe new size mode of this inset's container.
dimensionsReadonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>The new dimensions of this inset's container, as [width, height] in pixels.

Returns

void

Implementation of

PfdInset.onResize

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/GduDisplay/Gdu460/PfdInstruments/Inset/AbstractPfdInset.ts:23


onUpdate

onUpdate(time): void

Called every update cycle.

Parameters

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

Returns

void

Implementation of

PfdInset.onUpdate

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/GduDisplay/Gdu460/PfdInstruments/Inset/AbstractPfdInset.ts:29


render

render(): null | VNode

Renders the component.

Returns

null | VNode

A JSX element to be rendered.

Implementation of

PfdInset.render

Inherited from

DisplayComponent.render

Defined in

src/sdk/components/FSComponent.ts:93