Class: TextPagesContainer

Container for MFD text pages

Hierarchy

• DisplayComponent<TextPagesContainerProps>

  ↳ TextPagesContainer

Implements

• MfdTextPagesContext

Constructors

constructor

• new TextPagesContainer(props): TextPagesContainer

Creates an instance of a DisplayComponent.

Parameters

Name	Type	Description
props	TextPagesContainerProps	The propertis of the component.

Returns

TextPagesContainer

Inherited from

DisplayComponent<TextPagesContainerProps>.constructor

Defined in

sdk/components/FSComponent.ts:73

Properties

context

• Optional context: [] = undefined

The context on this component, if any.

Inherited from

DisplayComponent.context

Defined in

sdk/components/FSComponent.ts:64

---

contextType

• Optional Readonly contextType: readonly [] = undefined

The type of context for this component, if any.

Inherited from

DisplayComponent.contextType

Defined in

sdk/components/FSComponent.ts:67

---

props

• props: TextPagesContainerProps & ComponentProps

The properties of the component.

Inherited from

DisplayComponent.props

Defined in

sdk/components/FSComponent.ts:61

Methods

addTextPage

▸ addTextPage(key, render): void

Adds an MFD text page, given a key and a function returning a VNode

Parameters

Name	Type	Description
key	WT21MfdTextPage	the page's key
render	(ref: NodeReference<MfdTextPageComponent<MfdTextPageProps>>) => VNode	a function rendering the page, given a reference to set on the page component

Returns

void

Implementation of

MfdTextPagesContext.addTextPage

Defined in

workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/MFD/Components/TextPagesContainer.tsx:146

---

destroy

▸ destroy(): void

Destroys this component.

Returns

void

Inherited from

DisplayComponent.destroy

Defined in

sdk/components/FSComponent.ts:98

---

electricityHide

▸ electricityHide(): void

Hide the MFD HSI based on electricity status.

Returns

void

Defined in

workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/MFD/Components/TextPagesContainer.tsx:88

---

electricityShow

▸ electricityShow(): void

Show the MFD HSI based on electricity status.

Returns

void

Defined in

workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/MFD/Components/TextPagesContainer.tsx:83

---

getContext

▸ getContext(context): never

Gets a context data subscription from the context collection.

Parameters

Name	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

Defined in

sdk/components/FSComponent.ts:106

---

modeHide

▸ modeHide(): void

Hide the MFD HSI based on MFD mode.

Returns

void

Defined in

workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/MFD/Components/TextPagesContainer.tsx:98

---

modeShow

▸ modeShow(): void

Show the MFD HSI based on MFD mode.

Returns

void

Defined in

workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/MFD/Components/TextPagesContainer.tsx:93

---

onAfterRender

▸ onAfterRender(node): void

Parameters

Name	Type
node	VNode

Returns

void

Inherit Doc

Overrides

DisplayComponent.onAfterRender

Defined in

workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/MFD/Components/TextPagesContainer.tsx:103

---

onBeforeRender

▸ onBeforeRender(): void

A callback that is called before the component is rendered.

Returns

void

Inherited from

DisplayComponent.onBeforeRender

Defined in

sdk/components/FSComponent.ts:80

---

render

▸ render(): null | VNode

Returns

null | VNode

Inherit Doc

Overrides

DisplayComponent.render

Defined in

workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/MFD/Components/TextPagesContainer.tsx:153