Class: AbstractMfdNrstFacilityPage<T, EntryType, P>
An abstract implementation of MfdNrstPage
that displays a list of nearest facility waypoints sourced from a
G3XNearestContext
.
Type parameters
Name | Type |
---|---|
T | extends NearestWaypointFacilityType |
EntryType | extends NearestWaypointEntry <NearestFacilityWaypointTypeMap [T ]> = NearestWaypointEntry <NearestFacilityWaypointTypeMap [T ]> |
P | extends AbstractMfdNrstPageProps = AbstractMfdNrstPageProps |
Hierarchy
AbstractMfdNrstPage
<NearestFacilityWaypointTypeMap
[T
],EntryType
,P
>↳
AbstractMfdNrstFacilityPage
Constructors
constructor
• new AbstractMfdNrstFacilityPage<T
, EntryType
, P
>(props
): AbstractMfdNrstFacilityPage
<T
, EntryType
, P
>
Creates a new instance of AbstractMfdNrstFacilityPage.
Type parameters
Name | Type |
---|---|
T | extends NearestWaypointFacilityType |
EntryType | extends NearestWaypointEntry <NearestFacilityWaypointTypeMap [T ]> = NearestWaypointEntry <NearestFacilityWaypointTypeMap [T ]> |
P | extends AbstractMfdNrstPageProps = AbstractMfdNrstPageProps |
Parameters
Name | Type | Description |
---|---|---|
props | P | This component's props. |
Returns
AbstractMfdNrstFacilityPage
<T
, EntryType
, P
>
Overrides
AbstractMfdNrstPage.constructor
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/NrstView/AbstractMfdNrstFacilityPage.tsx:42
Properties
_iconSrc
• Protected
Readonly
_iconSrc: Subject
<string
>
Inherited from
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/PageNavigation/AbstractMfdPage.ts:17
_knobLabelState
• Protected
Readonly
_knobLabelState: FilteredMapSubject
<UiKnobId
, string
>
Inherited from
AbstractMfdNrstPage._knobLabelState
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/PageNavigation/AbstractMfdPage.ts:21
_selectedWaypoint
• Protected
Readonly
_selectedWaypoint: Subject
<null
| NearestFacilityWaypointTypeMap
[T
]>
Inherited from
AbstractMfdNrstPage._selectedWaypoint
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/NrstView/AbstractMfdNrstPage.tsx:49
_title
• Protected
Readonly
_title: Subject
<string
>
Inherited from
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/PageNavigation/AbstractMfdPage.ts:13
context
• Optional
context: [] = undefined
The context on this component, if any.
Inherited from
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
AbstractMfdNrstPage.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.
Inherited from
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/PageNavigation/AbstractMfdPage.ts:19
isGpsDataFailedSub
• Protected
Optional
isGpsDataFailedSub: Subscription
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/NrstView/AbstractMfdNrstFacilityPage.tsx:36
isOpen
• Protected
isOpen: boolean
= false
Inherited from
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/NrstView/AbstractMfdNrstPage.tsx:61
isResumed
• Protected
isResumed: boolean
= false
Inherited from
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/NrstView/AbstractMfdNrstPage.tsx:62
knobLabelState
• Readonly
knobLabelState: SubscribableMap
<UiKnobId
, string
> & Subscribable
<UiKnobRequestedLabelState
>
The bezel rotary knob label state requested by this page.
Inherited from
AbstractMfdNrstPage.knobLabelState
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/PageNavigation/AbstractMfdPage.ts:23
lastUpdateTime
• Protected
Optional
lastUpdateTime: number
Inherited from
AbstractMfdNrstPage.lastUpdateTime
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/NrstView/AbstractMfdNrstPage.tsx:64
listItemLengthPx
• Protected
Readonly
listItemLengthPx: Subject
<number
>
Inherited from
AbstractMfdNrstPage.listItemLengthPx
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/NrstView/AbstractMfdNrstPage.tsx:45
listItemSpacingPx
• Protected
Readonly
listItemSpacingPx: Subject
<number
>
Inherited from
AbstractMfdNrstPage.listItemSpacingPx
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/NrstView/AbstractMfdNrstPage.tsx:46
listItemsPerPage
• Protected
Readonly
listItemsPerPage: Subject
<number
>
Inherited from
AbstractMfdNrstPage.listItemsPerPage
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/NrstView/AbstractMfdNrstPage.tsx:47
listRef
• Protected
Readonly
listRef: NodeReference
<UiNearestWaypointList
<EntryType
& DynamicListData
>>
Inherited from
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/NrstView/AbstractMfdNrstPage.tsx:44
nearestContext
• Protected
Optional
nearestContext: G3XNearestContext
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/NrstView/AbstractMfdNrstFacilityPage.tsx:23
nearestFacilitiesUpdateSub
• Protected
Optional
nearestFacilitiesUpdateSub: Subscription
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/NrstView/AbstractMfdNrstFacilityPage.tsx:35
nearestSubscription
• Protected
Optional
nearestSubscription: NearestSubscription
<FacilityTypeMap
[T
]>
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/NrstView/AbstractMfdNrstFacilityPage.tsx:24
needTryFocusFirstListItem
• Protected
needTryFocusFirstListItem: boolean
= false
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/NrstView/AbstractMfdNrstFacilityPage.tsx:33
planeHeadingTrue
• Protected
Readonly
planeHeadingTrue: Subject
<number
>
The true heading of the airplane, in degrees, or NaN
if heading data is invalid.
Inherited from
AbstractMfdNrstPage.planeHeadingTrue
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/NrstView/AbstractMfdNrstPage.tsx:57
ppos
• Protected
Readonly
ppos: GeoPointSubject
The position of the airplane.
Inherited from
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/NrstView/AbstractMfdNrstPage.tsx:54
props
• props: P
& ComponentProps
The properties of the component.
Inherited from
Defined in
src/sdk/components/FSComponent.ts:61
rootCssClass
• Protected
Readonly
rootCssClass: SetSubject
<string
>
Inherited from
AbstractMfdNrstPage.rootCssClass
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/NrstView/AbstractMfdNrstPage.tsx:42
selectedWaypoint
• Readonly
selectedWaypoint: Subscribable
<null
| Waypoint
>
This page's selected waypoint.
Inherited from
AbstractMfdNrstPage.selectedWaypoint
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/NrstView/AbstractMfdNrstPage.tsx:51
title
• Readonly
title: Subscribable
<string
>
This page's title.
Inherited from
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/PageNavigation/AbstractMfdPage.ts:15
unitsSettingManager
• Protected
Readonly
unitsSettingManager: G3XUnitsUserSettingManager
Inherited from
AbstractMfdNrstPage.unitsSettingManager
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/NrstView/AbstractMfdNrstPage.tsx:59
waypointArray
• Protected
Readonly
waypointArray: NearestFacilityWaypointArray
<T
, EntryType
>
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/NrstView/AbstractMfdNrstFacilityPage.tsx:26
GPS_FAIL_CLEAR_LIST_DELAY
▪ Static
Protected
Readonly
GPS_FAIL_CLEAR_LIST_DELAY: 10000
Inherited from
AbstractMfdNrstPage.GPS_FAIL_CLEAR_LIST_DELAY
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/NrstView/AbstractMfdNrstPage.tsx:40
UPDATE_INTERVAL
▪ Static
Protected
Readonly
UPDATE_INTERVAL: 1000
Inherited from
AbstractMfdNrstPage.UPDATE_INTERVAL
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/NrstView/AbstractMfdNrstPage.tsx:39
Methods
createWaypointEntry
▸ createWaypointEntry(waypoint
): EntryType
Creates a waypoint entry for a nearest facility search result.
Parameters
Name | 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
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/NrstView/AbstractMfdNrstPage.tsx:166
destroy
▸ destroy(): void
Destroys this component.
Returns
void
Overrides
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/NrstView/AbstractMfdNrstFacilityPage.tsx:191
doUpdate
▸ doUpdate(time
): void
Updates this page.
Parameters
Name | Type | Description |
---|---|---|
time | number | The current real (operating system) time, as a Javascript timestamp. |
Returns
void
Overrides
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/NrstView/AbstractMfdNrstFacilityPage.tsx:128
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
AbstractMfdNrstPage.getContext
Defined in
src/sdk/components/FSComponent.ts:106
getNearestSubscription
▸ getNearestSubscription(context
): NearestSubscription
<FacilityTypeMap
[T
]>
Gets this page's nearest facilities subscription from a nearest context.
Parameters
Name | Type | Description |
---|---|---|
context | G3XNearestContext | A nearest context. |
Returns
NearestSubscription
<FacilityTypeMap
[T
]>
This page's nearest facilities subscription from the specified nearest context.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/NrstView/AbstractMfdNrstFacilityPage.tsx:71
getNoResultsText
▸ getNoResultsText(): string
| Subscribable
<string
>
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
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/NrstView/AbstractMfdNrstPage.tsx:180
getWaypointArray
▸ getWaypointArray(): SubscribableArray
<EntryType
>
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
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/NrstView/AbstractMfdNrstFacilityPage.tsx:186
handleResize
▸ handleResize(sizeMode
, dimensions
): void
Handles potential changes in the size mode or dimensions of this page's container.
Parameters
Name | Type | Description |
---|---|---|
sizeMode | MfdPageSizeMode | The new size mode of this page's container. |
dimensions | Readonly <Omit <Float64Array , "set" | "sort" | "copyWithin" >> | The new dimensions of this page's container, as [width, height] in pixels. |
Returns
void
Inherited from
AbstractMfdNrstPage.handleResize
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/NrstView/AbstractMfdNrstPage.tsx:112
initNearestSearch
▸ initNearestSearch(): Promise
<void
>
Initializes this page's nearest waypoints search.
Returns
Promise
<void
>
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/NrstView/AbstractMfdNrstFacilityPage.tsx:51
onAfterRender
▸ onAfterRender(): void
A callback that is called after the component is rendered.
Returns
void
Overrides
AbstractMfdNrstPage.onAfterRender
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/NrstView/AbstractMfdNrstFacilityPage.tsx:74
onBeforeRender
▸ onBeforeRender(): void
A callback that is called before the component is rendered.
Returns
void
Inherited from
AbstractMfdNrstPage.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
Overrides
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/NrstView/AbstractMfdNrstFacilityPage.tsx:101
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
Inherited from
AbstractMfdNrstPage.onOcclusionChange
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/PageNavigation/AbstractMfdPage.ts:64
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
Overrides
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/NrstView/AbstractMfdNrstFacilityPage.tsx:91
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
Overrides
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/NrstView/AbstractMfdNrstFacilityPage.tsx:121
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
Inherited from
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/NrstView/AbstractMfdNrstPage.tsx:102
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
Overrides
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/NrstView/AbstractMfdNrstFacilityPage.tsx:114
onStage
▸ onStage(): void
Responds to when this page is staged. A page is staged if it has been selected.
Returns
void
Inherited from
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/PageNavigation/AbstractMfdPage.ts:26
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
AbstractMfdNrstPage.onUiInteractionEvent
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/NrstView/AbstractMfdNrstPage.tsx:157
onUnstage
▸ onUnstage(): void
Responds to when this page is unstaged. A page is unstaged if it is no longer selected.
Returns
void
Inherited from
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/PageNavigation/AbstractMfdPage.ts:31
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
Inherited from
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/NrstView/AbstractMfdNrstPage.tsx:127
openWaypointInfoPopup
▸ openWaypointInfoPopup(waypoint
): void
Opens a waypoint information popup and sets it to display a waypoint.
Parameters
Name | Type | Description |
---|---|---|
waypoint | FacilityWaypoint <Facility > | The waypoint for the popup to display. |
Returns
void
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/NrstView/AbstractMfdNrstFacilityPage.tsx:176
reconcileListItemFocus
▸ reconcileListItemFocus(): void
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
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/NrstView/AbstractMfdNrstFacilityPage.tsx:147
render
▸ render(): VNode
Renders the component.
Returns
VNode
A JSX element to be rendered.
Inherited from
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/NrstView/AbstractMfdNrstPage.tsx:185
renderListItem
▸ renderListItem(data
, index
): VNode
Renders an item for this page's nearest waypoint list.
Parameters
Name | 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
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/NrstView/AbstractMfdNrstPage.tsx:210
tryFocusFirstListItem
▸ tryFocusFirstListItem(): void
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
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/NrstView/AbstractMfdNrstFacilityPage.tsx:166
updateAirplaneData
▸ updateAirplaneData(): void
Updates this page's airplane data.
Returns
void
Inherited from
AbstractMfdNrstPage.updateAirplaneData
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/NrstView/AbstractMfdNrstPage.tsx:151