Class: TextPagesContainer
Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/MFD/Components/TextPagesContainer.tsx:61
Container for MFD text pages
Extends
DisplayComponent
<TextPagesContainerProps
>
Implements
Constructors
Constructor
new TextPagesContainer(
props
):TextPagesContainer
Defined in: sdk/components/FSComponent.ts:73
Creates an instance of a DisplayComponent.
Parameters
Parameter | Type | Description |
---|---|---|
props | TextPagesContainerProps | The propertis of the component. |
Returns
TextPagesContainer
Inherited from
DisplayComponent<TextPagesContainerProps>.constructor
Properties
context?
optional
context: [] =undefined
Defined in: sdk/components/FSComponent.ts:64
The context on this component, if any.
Inherited from
DisplayComponent.context
contextType?
readonly
optional
contextType: readonly [] =undefined
Defined in: sdk/components/FSComponent.ts:67
The type of context for this component, if any.
Inherited from
DisplayComponent.contextType
props
props:
TextPagesContainerProps
&ComponentProps
Defined in: sdk/components/FSComponent.ts:61
The properties of the component.
Inherited from
DisplayComponent.props
Methods
addTextPage()
addTextPage(
key
,render
):void
Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/MFD/Components/TextPagesContainer.tsx:146
Adds an MFD text page, given a key and a function returning a VNode
Parameters
Parameter | Type | Description |
---|---|---|
key | WT21MfdTextPage | the page's key |
render | (ref ) => VNode | a function rendering the page, given a reference to set on the page component |
Returns
void
Implementation of
MfdTextPagesContext
.addTextPage
destroy()
destroy():
void
Defined in: sdk/components/FSComponent.ts:98
Destroys this component.
Returns
void
Inherited from
DisplayComponent.destroy
electricityHide()
electricityHide():
void
Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/MFD/Components/TextPagesContainer.tsx:88
Hide the MFD HSI based on electricity status.
Returns
void
electricityShow()
electricityShow():
void
Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/MFD/Components/TextPagesContainer.tsx:83
Show the MFD HSI based on electricity status.
Returns
void
getContext()
protected
getContext(context
):never
Defined in: 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.
Inherited from
DisplayComponent.getContext
modeHide()
modeHide():
void
Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/MFD/Components/TextPagesContainer.tsx:98
Hide the MFD HSI based on MFD mode.
Returns
void
modeShow()
modeShow():
void
Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/MFD/Components/TextPagesContainer.tsx:93
Show the MFD HSI based on MFD mode.
Returns
void
onAfterRender()
onAfterRender(
node
):void
Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/MFD/Components/TextPagesContainer.tsx:103
Parameters
Parameter | Type |
---|---|
node | VNode |
Returns
void
Inherit Doc
Overrides
DisplayComponent.onAfterRender
onBeforeRender()
onBeforeRender():
void
Defined in: sdk/components/FSComponent.ts:80
A callback that is called before the component is rendered.
Returns
void
Inherited from
DisplayComponent.onBeforeRender
render()
render():
null
|VNode
Defined in: workingtitle-instruments-wt21/instruments/html_ui/Pages/VCockpit/Instruments/WT21/MFD/Components/TextPagesContainer.tsx:153
Returns
null
| VNode
Inherit Doc
Overrides
DisplayComponent.render