Skip to main content

Interface: MfdPage<P>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/PageNavigation/MfdPage.ts:23

An MFD page.

Extends

Extended by

Type Parameters

Type ParameterDefault type
P extends MfdPagePropsMfdPageProps

Properties

context?

optional context: [] = undefined

Defined in: src/sdk/components/FSComponent.ts:64

The context on this component, if any.

Inherited from

DisplayComponent.context


contextType?

readonly optional contextType: readonly [] = undefined

Defined in: src/sdk/components/FSComponent.ts:67

The type of context for this component, if any.

Inherited from

DisplayComponent.contextType


iconSrc

readonly iconSrc: Subscribable<string>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/PageNavigation/MfdPage.ts:28

The file path to this page's icon's image asset.


knobLabelState

readonly knobLabelState: SubscribableMap<UiKnobId, string> & Subscribable<UiKnobRequestedLabelState>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/PageNavigation/MfdPage.ts:31

The bezel rotary knob label state requested by this page.


props

props: P & ComponentProps

Defined in: src/sdk/components/FSComponent.ts:61

The properties of the component.

Inherited from

DisplayComponent.props


title

readonly title: Subscribable<string>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/PageNavigation/MfdPage.ts:25

This page's title.

Methods

destroy()

destroy(): void

Defined in: src/sdk/components/FSComponent.ts:98

Destroys this component.

Returns

void

Inherited from

DisplayComponent.destroy


getContext()

protected getContext(context): never

Defined in: src/sdk/components/FSComponent.ts:106

Gets a context data subscription from the context collection.

Parameters

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

Inherited from

DisplayComponent.getContext


onAfterRender()

onAfterRender(node): void

Defined in: src/sdk/components/FSComponent.ts:87

A callback that is called after the component is rendered.

Parameters

ParameterTypeDescription
nodeVNodeThe component's VNode.

Returns

void

Inherited from

DisplayComponent.onAfterRender


onBeforeRender()

onBeforeRender(): void

Defined in: src/sdk/components/FSComponent.ts:80

A callback that is called before the component is rendered.

Returns

void

Inherited from

DisplayComponent.onBeforeRender


onClose()

onClose(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/PageNavigation/MfdPage.ts:53

Responds to when this page is closed. A page is closed if it is no longer visible.

Returns

void


onOcclusionChange()

onOcclusionChange(occlusionType): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/PageNavigation/MfdPage.ts:78

Responds to when the occlusion type applied to this page's parent UI view changes while this page is open.

Parameters

ParameterTypeDescription
occlusionTypeUiViewOcclusionTypeThe new occlusion type applied to this page's parent UI view.

Returns

void


onOpen()

onOpen(sizeMode, dimensions): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/PageNavigation/MfdPage.ts:48

Responds to when this page is opened. A page is opened if it has been selected, has become active, and is visible.

Parameters

ParameterTypeDescription
sizeModeMfdPageSizeModeThis page's size mode.
dimensionsReadonlyFloat64ArrayThis page's dimensions, as [width, height] in pixels.

Returns

void


onPause()

onPause(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/PageNavigation/MfdPage.ts:65

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


onResize()

onResize(sizeMode, dimensions): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/PageNavigation/MfdPage.ts:72

Responds when this page's parent UI view is resized while it is resumed.

Parameters

ParameterTypeDescription
sizeModeMfdPageSizeModeThis page's new size mode.
dimensionsReadonlyFloat64ArrayThis page's new dimensions, as [width, height] in pixels.

Returns

void


onResume()

onResume(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/PageNavigation/MfdPage.ts:59

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


onStage()

onStage(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/PageNavigation/MfdPage.ts:36

Responds to when this page is staged. A page is staged if it has been selected.

Returns

void


onUiInteractionEvent()

onUiInteractionEvent(event): boolean

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiInteraction.ts:90

Handles a UiInteractionEvent.

Parameters

ParameterTypeDescription
eventUiInteractionEventThe event to handle.

Returns

boolean

Whether the event was handled.

Inherited from

UiInteractionHandler.onUiInteractionEvent


onUnstage()

onUnstage(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/PageNavigation/MfdPage.ts:41

Responds to when this page is unstaged. A page is unstaged if it is no longer selected.

Returns

void


onUpdate()

onUpdate(time): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/PageNavigation/MfdPage.ts:84

Called every update cycle.

Parameters

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

Returns

void


render()

abstract render(): null | VNode

Defined in: src/sdk/components/FSComponent.ts:93

Renders the component.

Returns

null | VNode

A JSX element to be rendered.

Inherited from

DisplayComponent.render