Class: MfdPageContainer

A container for MFD pages.

Hierarchy

• DisplayComponent<MfdPageContainerProps>

  ↳ MfdPageContainer

Implements

• UiInteractionHandler

Constructors

constructor

• new MfdPageContainer(props): MfdPageContainer

Creates an instance of a DisplayComponent.

Parameters

Name	Type	Description
props	MfdPageContainerProps	The propertis of the component.

Returns

MfdPageContainer

Inherited from

DisplayComponent<MfdPageContainerProps>.constructor

Defined in

src/sdk/components/FSComponent.ts:73

Properties

activePageEntry

• Readonly activePageEntry: Subscribable<null | MfdPageEntry>

This container's current active page, or null if there is no active page.

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/PageNavigation/MfdPageContainer.tsx:85

---

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

---

props

• props: MfdPageContainerProps & ComponentProps

The properties of the component.

Inherited from

DisplayComponent.props

Defined in

src/sdk/components/FSComponent.ts:61

---

stagedPageEntry

• Readonly stagedPageEntry: Subscribable<null | MfdPageEntry>

This container's current staged page, or null if there is no staged page.

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/PageNavigation/MfdPageContainer.tsx:81

Methods

destroy

▸ destroy(): void

Returns

void

Inherit Doc

Overrides

DisplayComponent.destroy

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/PageNavigation/MfdPageContainer.tsx:507

---

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

---

isAwake

▸ isAwake(): boolean

Checks whether this container is awake.

Returns

boolean

Whether this container is awake.

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/PageNavigation/MfdPageContainer.tsx:122

---

isResumed

▸ isResumed(): boolean

Checks whether this container is resumed.

Returns

boolean

Whether this container is resumed.

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/PageNavigation/MfdPageContainer.tsx:130

---

onAfterRender

▸ onAfterRender(): void

Returns

void

Inherit Doc

Overrides

DisplayComponent.onAfterRender

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/PageNavigation/MfdPageContainer.tsx:107

---

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

---

onUiInteractionEvent

▸ onUiInteractionEvent(event): boolean

Handles a UiInteractionEvent.

Parameters

Name	Type	Description
event	UiInteractionEvent	The event to handle.

Returns

boolean

Whether the event was handled.

Implementation of

UiInteractionHandler.onUiInteractionEvent

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/PageNavigation/MfdPageContainer.tsx:354

---

pause

▸ pause(): void

Pauses this container. This will pause the active page (if one exists). Has no effect if this container is asleep.

Returns

void

Throws

Error if this container has been destroyed.

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/PageNavigation/MfdPageContainer.tsx:203

---

render

▸ render(): VNode

Returns

VNode

Inherit Doc

Overrides

DisplayComponent.render

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/PageNavigation/MfdPageContainer.tsx:491

---

resume

▸ resume(): void

Resumes this container. This will resume the active page (if one exists). Has no effect if this container is asleep.

Returns

void

Throws

Error if this container has been destroyed.

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/PageNavigation/MfdPageContainer.tsx:180

---

setOcclusion

▸ setOcclusion(occlusionType): void

Sets the type of occlusion applied to this container's parent UI view.

Parameters

Name	Type	Description
occlusionType	UiViewOcclusionType	The type of occlusion to set.

Returns

void

Throws

Error if this container has been destroyed.

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/PageNavigation/MfdPageContainer.tsx:251

---

setSize

▸ setSize(sizeMode, dimensions): void

Sets the size of this container.

Parameters

Name	Type	Description
sizeMode	MfdPageSizeMode	The new size mode.
dimensions	Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>	The new dimensions, as [width, height] in pixels.

Returns

void

Throws

Error if this container has been destroyed.

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/PageNavigation/MfdPageContainer.tsx:226

---

sleep

▸ sleep(): void

Puts this container to sleep. This will pause and close the active page (if one exists).

Returns

void

Throws

Error if this container has been destroyed.

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/PageNavigation/MfdPageContainer.tsx:156

---

update

▸ update(time): void

Updates this container.

Parameters

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

Returns

void

Throws

Error if this container has been destroyed.

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/PageNavigation/MfdPageContainer.tsx:266

---

wake

▸ wake(): void

Wakes this container. This will open the active page (if one exists).

Returns

void

Throws

Error if this container has been destroyed.

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/PageNavigation/MfdPageContainer.tsx:138