Abstract Class: AbstractMfdNrstFacilityPage<T, EntryType, P>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstFacilityPage.tsx:17

An abstract implementation of MfdNrstPage that displays a list of nearest facility waypoints sourced from a G3XNearestContext.

Extends

• AbstractMfdNrstPage<NearestFacilityWaypointTypeMap[T], EntryType, P>

Extended by

• MfdNrstAirportPage
• MfdNrstIntersectionPage
• MfdNrstNdbPage
• MfdNrstUserWaypointPage
• MfdNrstVorPage

Type Parameters

Type Parameter	Default type
T extends NearestWaypointFacilityType	-
EntryType extends NearestWaypointEntry<NearestFacilityWaypointTypeMap[T]>	NearestWaypointEntry<NearestFacilityWaypointTypeMap[T]>
P extends AbstractMfdNrstPageProps	AbstractMfdNrstPageProps

Constructors

Constructor

new AbstractMfdNrstFacilityPage<T, EntryType, P>(props): AbstractMfdNrstFacilityPage<T, EntryType, P>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstFacilityPage.tsx:42

Creates a new instance of AbstractMfdNrstFacilityPage.

Parameters

Parameter	Type	Description
props	P	This component's props.

Returns

AbstractMfdNrstFacilityPage<T, EntryType, P>

Overrides

AbstractMfdNrstPage.constructor

Properties

_iconSrc

protected readonly _iconSrc: Subject<string>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/PageNavigation/AbstractMfdPage.ts:17

Inherited from

AbstractMfdNrstPage._iconSrc

---

_knobLabelState

protected readonly _knobLabelState: FilteredMapSubject<UiKnobId, string>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/PageNavigation/AbstractMfdPage.ts:21

Inherited from

AbstractMfdNrstPage._knobLabelState

---

_selectedWaypoint

protected readonly _selectedWaypoint: Subject<null | NearestFacilityWaypointTypeMap[T]>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstPage.tsx:49

Inherited from

AbstractMfdNrstPage._selectedWaypoint

---

_title

protected readonly _title: Subject<string>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/PageNavigation/AbstractMfdPage.ts:13

Inherited from

AbstractMfdNrstPage._title

---

context?

optional context: [] = undefined

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

The context on this component, if any.

Inherited from

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

AbstractMfdNrstPage.contextType

---

iconSrc

readonly iconSrc: Subscribable<string>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/PageNavigation/AbstractMfdPage.ts:19

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

Inherited from

AbstractMfdNrstPage.iconSrc

---

isGpsDataFailedSub?

protected optional isGpsDataFailedSub: Subscription

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstFacilityPage.tsx:36

---

isOpen

protected isOpen: boolean = false

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstPage.tsx:61

Inherited from

AbstractMfdNrstPage.isOpen

---

isResumed

protected isResumed: boolean = false

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstPage.tsx:62

Inherited from

AbstractMfdNrstPage.isResumed

---

knobLabelState

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

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

The bezel rotary knob label state requested by this page.

Inherited from

AbstractMfdNrstPage.knobLabelState

---

lastUpdateTime?

protected optional lastUpdateTime: number

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstPage.tsx:64

Inherited from

AbstractMfdNrstPage.lastUpdateTime

---

listItemLengthPx

protected readonly listItemLengthPx: Subject<number>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstPage.tsx:45

Inherited from

AbstractMfdNrstPage.listItemLengthPx

---

listItemSpacingPx

protected readonly listItemSpacingPx: Subject<number>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstPage.tsx:46

Inherited from

AbstractMfdNrstPage.listItemSpacingPx

---

listItemsPerPage

protected readonly listItemsPerPage: Subject<number>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstPage.tsx:47

Inherited from

AbstractMfdNrstPage.listItemsPerPage

---

listRef

protected readonly listRef: NodeReference<UiNearestWaypointList<EntryType & DynamicListData>>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstPage.tsx:44

Inherited from

AbstractMfdNrstPage.listRef

---

nearestContext?

protected optional nearestContext: G3XNearestContext

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstFacilityPage.tsx:23

---

nearestFacilitiesUpdateSub?

protected optional nearestFacilitiesUpdateSub: Subscription

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstFacilityPage.tsx:35

---

nearestSubscription?

protected optional nearestSubscription: NearestSubscription<FacilityTypeMap[T]>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstFacilityPage.tsx:24

---

needTryFocusFirstListItem

protected needTryFocusFirstListItem: boolean = false

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstFacilityPage.tsx:33

---

planeHeadingTrue

protected readonly planeHeadingTrue: Subject<number>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstPage.tsx:57

The true heading of the airplane, in degrees, or NaN if heading data is invalid.

Inherited from

AbstractMfdNrstPage.planeHeadingTrue

---

ppos

protected readonly ppos: GeoPointSubject

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstPage.tsx:54

The position of the airplane.

Inherited from

AbstractMfdNrstPage.ppos

---

props

props: P & ComponentProps

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

The properties of the component.

Inherited from

AbstractMfdNrstPage.props

---

rootCssClass

protected readonly rootCssClass: SetSubject<string>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstPage.tsx:42

Inherited from

AbstractMfdNrstPage.rootCssClass

---

selectedWaypoint

readonly selectedWaypoint: Subscribable<null | Waypoint>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstPage.tsx:51

This page's selected waypoint.

Inherited from

AbstractMfdNrstPage.selectedWaypoint

---

title

readonly title: Subscribable<string>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/PageNavigation/AbstractMfdPage.ts:15

This page's title.

Inherited from

AbstractMfdNrstPage.title

---

unitsSettingManager

protected readonly unitsSettingManager: G3XUnitsUserSettingManager

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstPage.tsx:59

Inherited from

AbstractMfdNrstPage.unitsSettingManager

---

waypointArray

protected readonly waypointArray: NearestFacilityWaypointArray<T, EntryType>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstFacilityPage.tsx:26

---

GPS_FAIL_CLEAR_LIST_DELAY

protected readonly static GPS_FAIL_CLEAR_LIST_DELAY: 10000 = 10000

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstPage.tsx:40

Inherited from

AbstractMfdNrstPage.GPS_FAIL_CLEAR_LIST_DELAY

---

UPDATE_INTERVAL

protected readonly static UPDATE_INTERVAL: 1000 = 1000

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstPage.tsx:39

Inherited from

AbstractMfdNrstPage.UPDATE_INTERVAL

Methods

createWaypointEntry()

protected createWaypointEntry(waypoint): EntryType

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstPage.tsx:166

Creates a waypoint entry for a nearest facility search result.

Parameters

Parameter	Type	Description
waypoint	NearestFacilityWaypointTypeMap[T]	A nearest facility search result, as a Waypoint.

Returns

EntryType

A waypoint entry for the specified nearest facility search result.

Inherited from

AbstractMfdNrstPage.createWaypointEntry

---

destroy()

destroy(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstFacilityPage.tsx:191

Destroys this component.

Returns

void

Overrides

AbstractMfdNrstPage.destroy

---

doUpdate()

protected doUpdate(time): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstFacilityPage.tsx:128

Updates this page.

Parameters

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

Returns

void

Overrides

AbstractMfdNrstPage.doUpdate

---

getContext()

protected getContext(context): never

Defined in: src/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

AbstractMfdNrstPage.getContext

---

getNearestSubscription()

abstract protected getNearestSubscription(context): NearestSubscription<FacilityTypeMap[T]>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstFacilityPage.tsx:71

Gets this page's nearest facilities subscription from a nearest context.

Parameters

Parameter	Type	Description
context	G3XNearestContext	A nearest context.

Returns

NearestSubscription<FacilityTypeMap[T]>

This page's nearest facilities subscription from the specified nearest context.

---

getNoResultsText()

protected getNoResultsText(): string | Subscribable<string>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstPage.tsx:180

Gets the text to show when no nearest waypoints are available to display.

Returns

string | Subscribable<string>

The text to show when no nearest waypoints are available to display.

Inherited from

AbstractMfdNrstPage.getNoResultsText

---

getWaypointArray()

protected getWaypointArray(): SubscribableArray<EntryType>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstFacilityPage.tsx:186

Gets a subscribable array of nearest waypoints to display in this page's list.

Returns

SubscribableArray<EntryType>

A subscribable array of nearest waypoints to display in this page's list.

Overrides

AbstractMfdNrstPage.getWaypointArray

---

handleResize()

protected handleResize(sizeMode, dimensions): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstPage.tsx:112

Handles potential changes in the size mode or dimensions of this page's container.

Parameters

Parameter	Type	Description
sizeMode	MfdPageSizeMode	The new size mode of this page's container.
dimensions	ReadonlyFloat64Array	The new dimensions of this page's container, as [width, height] in pixels.

Returns

void

Inherited from

AbstractMfdNrstPage.handleResize

---

initNearestSearch()

protected initNearestSearch(): Promise<void>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstFacilityPage.tsx:51

Initializes this page's nearest waypoints search.

Returns

Promise<void>

---

onAfterRender()

onAfterRender(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstFacilityPage.tsx:74

A callback that is called after the component is rendered.

Returns

void

Overrides

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

AbstractMfdNrstPage.onBeforeRender

---

onClose()

onClose(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstFacilityPage.tsx:101

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

Returns

void

Overrides

AbstractMfdNrstPage.onClose

---

onOcclusionChange()

onOcclusionChange(occlusionType): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/PageNavigation/AbstractMfdPage.ts:64

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

Parameters

Parameter	Type	Description
occlusionType	UiViewOcclusionType	The new occlusion type applied to this page's parent UI view.

Returns

void

Inherited from

AbstractMfdNrstPage.onOcclusionChange

---

onOpen()

onOpen(sizeMode, dimensions): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstFacilityPage.tsx:91

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

Parameters

Parameter	Type	Description
sizeMode	MfdPageSizeMode	This page's size mode.
dimensions	ReadonlyFloat64Array	This page's dimensions, as [width, height] in pixels.

Returns

void

Overrides

AbstractMfdNrstPage.onOpen

---

onPause()

onPause(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstFacilityPage.tsx:121

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

Overrides

AbstractMfdNrstPage.onPause

---

onResize()

onResize(sizeMode, dimensions): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstPage.tsx:102

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

Parameters

Parameter	Type	Description
sizeMode	MfdPageSizeMode	This page's new size mode.
dimensions	ReadonlyFloat64Array	This page's new dimensions, as [width, height] in pixels.

Returns

void

Inherited from

AbstractMfdNrstPage.onResize

---

onResume()

onResume(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstFacilityPage.tsx:114

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

Overrides

AbstractMfdNrstPage.onResume

---

onStage()

onStage(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/PageNavigation/AbstractMfdPage.ts:26

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

Returns

void

Inherited from

AbstractMfdNrstPage.onStage

---

onUiInteractionEvent()

onUiInteractionEvent(event): boolean

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstPage.tsx:157

Handles a UiInteractionEvent.

Parameters

Parameter	Type	Description
event	UiInteractionEvent	The event to handle.

Returns

boolean

Whether the event was handled.

Inherited from

AbstractMfdNrstPage.onUiInteractionEvent

---

onUnstage()

onUnstage(): void

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

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

Returns

void

Inherited from

AbstractMfdNrstPage.onUnstage

---

onUpdate()

onUpdate(time): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstPage.tsx:127

Called every update cycle.

Parameters

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

Returns

void

Inherited from

AbstractMfdNrstPage.onUpdate

---

openWaypointInfoPopup()

protected openWaypointInfoPopup(waypoint): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstFacilityPage.tsx:176

Opens a waypoint information popup and sets it to display a waypoint.

Parameters

Parameter	Type	Description
waypoint	FacilityWaypoint	The waypoint for the popup to display.

Returns

void

---

reconcileListItemFocus()

protected reconcileListItemFocus(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstFacilityPage.tsx:147

Reconciles the UI focus state of this page's list. If the list is not empty, then the first item in the list will be focused if no other list item has UI focus. This operation is carried out immediately if this page is resumed and either positioning data is in a failed state or this page has been updated with a valid position for the player airplane. Otherwise, the operation is pended until the next update in which these conditions are met. If the list is empty, then no action is taken and any pending reconcilation operation is cancelled.

Returns

void

---

render()

render(): VNode

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstPage.tsx:185

Renders the component.

Returns

VNode

A JSX element to be rendered.

Inherited from

AbstractMfdNrstPage.render

---

renderListItem()

abstract protected renderListItem(data, index): VNode

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstPage.tsx:210

Renders an item for this page's nearest waypoint list.

Parameters

Parameter	Type	Description
data	EntryType	The nearest waypoint entry for which to render.
index	number	The index of the item.

Returns

VNode

A nearest waypoint list item, as a VNode.

Inherited from

AbstractMfdNrstPage.renderListItem

---

tryFocusFirstListItem()

protected tryFocusFirstListItem(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstFacilityPage.tsx:166

Attempts to focus the first item in this page's list if the list is not empty and no list item already has UI focus.

Returns

void

---

updateAirplaneData()

protected updateAirplaneData(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstPage.tsx:151

Updates this page's airplane data.

Returns

void

Inherited from

AbstractMfdNrstPage.updateAirplaneData