Interface: MfdPage<P>
An MFD page.
Type parameters
| Name | Type |
|---|---|
P | extends MfdPageProps = MfdPageProps |
Hierarchy
DisplayComponent<P>↳
MfdPage↳↳
MfdNrstPage
Implemented by
Properties
context
• Optional context: [] = undefined
The context on this component, if any.
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.
Inherited from
DisplayComponent.contextType
Defined in
src/sdk/components/FSComponent.ts:67
iconSrc
• Readonly iconSrc: Subscribable<string>
The file path to this page's icon's image asset.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/PageNavigation/MfdPage.ts:28
knobLabelState
• Readonly knobLabelState: SubscribableMap<UiKnobId, string> & Subscribable<UiKnobRequestedLabelState>
The bezel rotary knob label state requested by this page.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/PageNavigation/MfdPage.ts:31
props
• props: P & ComponentProps
The properties of the component.
Inherited from
DisplayComponent.props
Defined in
src/sdk/components/FSComponent.ts:61
title
• Readonly title: Subscribable<string>
This page's title.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/PageNavigation/MfdPage.ts:25
Methods
destroy
▸ destroy(): void
Destroys this component.
Returns
void
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
| 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
src/sdk/components/FSComponent.ts:106
onAfterRender
▸ onAfterRender(node): void
A callback that is called after the component is rendered.
Parameters
| Name | Type | Description |
|---|---|---|
node | VNode | The component's VNode. |
Returns
void
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
Inherited from
DisplayComponent.onBeforeRender
Defined in
src/sdk/components/FSComponent.ts:80
onClose
▸ onClose(): void
Responds to when this page is closed. A page is closed if it is no longer visible.
Returns
void
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/PageNavigation/MfdPage.ts:53
onOcclusionChange
▸ onOcclusionChange(occlusionType): void
Responds to when the occlusion type applied to this page's parent UI view changes while this page is open.
Parameters
| Name | Type | Description |
|---|---|---|
occlusionType | UiViewOcclusionType | The new occlusion type applied to this page's parent UI view. |
Returns
void
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/PageNavigation/MfdPage.ts:78
onOpen
▸ onOpen(sizeMode, dimensions): void
Responds to when this page is opened. A page is opened if it has been selected, has become active, and is visible.
Parameters
| Name | Type | Description |
|---|---|---|
sizeMode | MfdPageSizeMode | This page's size mode. |
dimensions | Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">> | This page's dimensions, as [width, height] in pixels. |
Returns
void
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/PageNavigation/MfdPage.ts:48
onPause
▸ onPause(): void
Responds to when this page is paused. A page is paused if it is no longer open as the top-most view in its view stack.
Returns
void
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/PageNavigation/MfdPage.ts:65
onResize
▸ onResize(sizeMode, dimensions): void
Responds when this page's parent UI view is resized while it is resumed.
Parameters
| Name | Type | Description |
|---|---|---|
sizeMode | MfdPageSizeMode | This page's new size mode. |
dimensions | Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">> | This page's new dimensions, as [width, height] in pixels. |
Returns
void
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/PageNavigation/MfdPage.ts:72
onResume
▸ onResume(): void
Responds to when this page is resumed. A page is resumed when it has been opened as part of the top-most view in its view stack.
Returns
void
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/PageNavigation/MfdPage.ts:59
onStage
▸ onStage(): void
Responds to when this page is staged. A page is staged if it has been selected.
Returns
void
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/PageNavigation/MfdPage.ts:36
onUiInteractionEvent
▸ onUiInteractionEvent(event): boolean
Handles a UiInteractionEvent.
Parameters
| Name | Type | Description |
|---|---|---|
event | UiInteractionEvent | The event to handle. |
Returns
boolean
Whether the event was handled.
Inherited from
UiInteractionHandler.onUiInteractionEvent
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/UiInteraction.ts:90
onUnstage
▸ onUnstage(): void
Responds to when this page is unstaged. A page is unstaged if it is no longer selected.
Returns
void
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/PageNavigation/MfdPage.ts:41
onUpdate
▸ onUpdate(time): void
Called every update cycle.
Parameters
| Name | Type | Description |
|---|---|---|
time | number | The current real (operating system) time, as a Javascript timestamp. |
Returns
void
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/PageNavigation/MfdPage.ts:84
render
▸ render(): null | VNode
Renders the component.
Returns
null | VNode
A JSX element to be rendered.
Inherited from
DisplayComponent.render
Defined in
src/sdk/components/FSComponent.ts:93