Abstract Class: AbstractMfdNrstPage<W, EntryType, P>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstPage.tsx:33
An abstract implementation of MfdNrstPage
that displays a list of nearest waypoints.
Extends
Extended by
Type Parameters
Type Parameter | Default type |
---|---|
W extends Waypoint | Waypoint |
EntryType extends NearestWaypointEntry <W > | NearestWaypointEntry <W > |
P extends AbstractMfdNrstPageProps | AbstractMfdNrstPageProps |
Implements
MfdNrstPage
<P
>
Constructors
Constructor
new AbstractMfdNrstPage<
W
,EntryType
,P
>(props
):AbstractMfdNrstPage
<W
,EntryType
,P
>
Defined in: src/sdk/components/FSComponent.ts:73
Creates an instance of a DisplayComponent.
Parameters
Parameter | Type | Description |
---|---|---|
props | P | The propertis of the component. |
Returns
AbstractMfdNrstPage
<W
, EntryType
, P
>
Inherited from
Properties
_iconSrc
protected
readonly
_iconSrc:Subject
<string
>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/PageNavigation/AbstractMfdPage.ts:17
Inherited from
_knobLabelState
protected
readonly
_knobLabelState:FilteredMapSubject
<UiKnobId
,string
>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/PageNavigation/AbstractMfdPage.ts:21
Inherited from
AbstractMfdPage
._knobLabelState
_selectedWaypoint
protected
readonly
_selectedWaypoint:Subject
<null
|W
>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstPage.tsx:49
_title
protected
readonly
_title:Subject
<string
>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/PageNavigation/AbstractMfdPage.ts:13
Inherited from
context?
optional
context: [] =undefined
Defined in: src/sdk/components/FSComponent.ts:64
The context on this component, if any.
Implementation of
Inherited from
contextType?
readonly
optional
contextType: readonly [] =undefined
Defined in: src/sdk/components/FSComponent.ts:67
The type of context for this component, if any.
Implementation of
Inherited from
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.
Implementation of
Inherited from
isOpen
protected
isOpen:boolean
=false
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstPage.tsx:61
isResumed
protected
isResumed:boolean
=false
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstPage.tsx:62
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.
Implementation of
Inherited from
AbstractMfdPage
.knobLabelState
lastUpdateTime?
protected
optional
lastUpdateTime:number
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstPage.tsx:64
listItemLengthPx
protected
readonly
listItemLengthPx:Subject
<number
>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstPage.tsx:45
listItemSpacingPx
protected
readonly
listItemSpacingPx:Subject
<number
>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstPage.tsx:46
listItemsPerPage
protected
readonly
listItemsPerPage:Subject
<number
>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstPage.tsx:47
listRef
protected
readonly
listRef:NodeReference
<UiNearestWaypointList
<EntryType
&DynamicListData
>>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstPage.tsx:44
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.
ppos
protected
readonly
ppos:GeoPointSubject
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstPage.tsx:54
The position of the airplane.
props
props:
P
&ComponentProps
Defined in: src/sdk/components/FSComponent.ts:61
The properties of the component.
Implementation of
Inherited from
rootCssClass
protected
readonly
rootCssClass:SetSubject
<string
>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstPage.tsx:42
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.
Implementation of
title
readonly
title:Subscribable
<string
>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/PageNavigation/AbstractMfdPage.ts:15
This page's title.
Implementation of
Inherited from
unitsSettingManager
protected
readonly
unitsSettingManager:G3XUnitsUserSettingManager
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstPage.tsx:59
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
UPDATE_INTERVAL
protected
readonly
static
UPDATE_INTERVAL:1000
=1000
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstPage.tsx:39
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 | W | A nearest facility search result, as a Waypoint. |
Returns
EntryType
A waypoint entry for the specified nearest facility search result.
destroy()
destroy():
void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstPage.tsx:213
Destroys this component.
Returns
void
Implementation of
Overrides
doUpdate()
protected
doUpdate(time
):void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstPage.tsx:144
Updates this page.
Parameters
Parameter | Type | Description |
---|---|---|
time | number | The current real (operating system) time, as a Javascript timestamp. |
Returns
void
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.
Implementation of
Inherited from
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.
getWaypointArray()
abstract
protected
getWaypointArray():SubscribableArray
<EntryType
>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstPage.tsx:174
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.
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
onAfterRender()
onAfterRender():
void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstPage.tsx:67
A callback that is called after the component is rendered.
Returns
void
Implementation of
Overrides
onBeforeRender()
onBeforeRender():
void
Defined in: src/sdk/components/FSComponent.ts:80
A callback that is called before the component is rendered.
Returns
void
Implementation of
Inherited from
AbstractMfdPage
.onBeforeRender
onClose()
onClose():
void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstPage.tsx:86
Responds to when this page is closed. A page is closed if it is no longer visible.
Returns
void
Implementation of
Overrides
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
Implementation of
Inherited from
AbstractMfdPage
.onOcclusionChange
onOpen()
onOpen(
sizeMode
,dimensions
):void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstPage.tsx:80
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
Implementation of
Overrides
onPause()
onPause():
void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstPage.tsx:97
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
Implementation of
Overrides
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
Implementation of
Overrides
onResume()
onResume():
void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/NrstView/AbstractMfdNrstPage.tsx:92
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
Implementation of
Overrides
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
Implementation of
Inherited from
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.
Implementation of
MfdNrstPage
.onUiInteractionEvent
Overrides
AbstractMfdPage
.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
Implementation of
Inherited from
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
Implementation of
Overrides
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.
Implementation of
Overrides
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.
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