Abstract Class: GtcNearestWaypointPage<T, EntryType, P>
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Pages/NearestPages/GtcNearestWaypointPage.tsx:36
A GTC nearest waypoint page.
Extends
GtcView<P>
Extended by
GtcNearestAirportPageGtcNearestIntersectionPageGtcNearestNdbPageGtcNearestUserWaypointPageGtcNearestVorPageGtcNearestWeatherPage
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends NearestWaypointFacilityType | - |
EntryType extends NearestWaypointEntry<NearestWaypointTypeMap[T]> | NearestWaypointEntry<NearestWaypointTypeMap[T]> |
P extends GtcNearestWaypointPageProps | GtcNearestWaypointPageProps |
Constructors
Constructor
new GtcNearestWaypointPage<
T,EntryType,P>(props):GtcNearestWaypointPage<T,EntryType,P>
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Pages/NearestPages/GtcNearestWaypointPage.tsx:108
Constructor.
Parameters
| Parameter | Type | Description |
|---|---|---|
props | P | This component's props. |
Returns
GtcNearestWaypointPage<T, EntryType, P>
Throws
Error if a display pane index is not defined for this view.
Overrides
Properties
_activeComponent
protectedreadonly_activeComponent:Subject<null|GtcInteractionHandler>
Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcView.ts:34
Inherited from
_sidebarState
protectedreadonly_sidebarState:GtcSidebarState
Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcView.ts:36
Inherited from
_title
protectedreadonly_title:Subject<undefined|string>
Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcView.ts:40
Inherited from
bus
protectedreadonlybus:EventBus
Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcView.ts:31
Inherited from
context?
optionalcontext: [] =undefined
Defined in: sdk/components/FSComponent.ts:64
The context on this component, if any.
Inherited from
contextType?
readonlyoptionalcontextType: readonly [] =undefined
Defined in: sdk/components/FSComponent.ts:67
The type of context for this component, if any.
Inherited from
displayPaneIndex
protectedreadonlydisplayPaneIndex:ControllableDisplayPaneIndex
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Pages/NearestPages/GtcNearestWaypointPage.tsx:53
displayPaneSettings
protectedreadonlydisplayPaneSettings:UserSettingManager<DisplayPaneSettings>
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Pages/NearestPages/GtcNearestWaypointPage.tsx:54
facWaypointCache
protectedreadonlyfacWaypointCache:GarminFacilityWaypointCache
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Pages/NearestPages/GtcNearestWaypointPage.tsx:56
gtcService
protectedreadonlygtcService:GtcService
Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcView.ts:32
Inherited from
hasSelectedWaypoint
protectedreadonlyhasSelectedWaypoint:MappedSubscribable<boolean>
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Pages/NearestPages/GtcNearestWaypointPage.tsx:71
Whether a waypoint is selected.
headingPipe?
protectedoptionalheadingPipe:Subscription
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Pages/NearestPages/GtcNearestWaypointPage.tsx:98
isGpsDataFailedSub?
protectedoptionalisGpsDataFailedSub:Subscription
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Pages/NearestPages/GtcNearestWaypointPage.tsx:99
isGpsDrSub?
protectedoptionalisGpsDrSub:Subscription
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Pages/NearestPages/GtcNearestWaypointPage.tsx:100
isPaused
protectedisPaused:boolean=true
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Pages/NearestPages/GtcNearestWaypointPage.tsx:93
listItemHeight
protectedreadonlylistItemHeight:70|130
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Pages/NearestPages/GtcNearestWaypointPage.tsx:82
listItemSpacing
protectedreadonlylistItemSpacing:1|2
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Pages/NearestPages/GtcNearestWaypointPage.tsx:83
listRef
protectedreadonlylistRef:NodeReference<GtcList<EntryType&DynamicListData>>
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Pages/NearestPages/GtcNearestWaypointPage.tsx:44
nearestContext?
protectedoptionalnearestContext:G3000NearestContext
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Pages/NearestPages/GtcNearestWaypointPage.tsx:58
nearestFacilitiesUpdateSub?
protectedoptionalnearestFacilitiesUpdateSub:Subscription
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Pages/NearestPages/GtcNearestWaypointPage.tsx:95
nearestSubscription?
protectedoptionalnearestSubscription:NearestSubscription<FacilityTypeMap[T]>
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Pages/NearestPages/GtcNearestWaypointPage.tsx:59
optionsPopupKey
abstractprotectedreadonlyoptionsPopupKey:string
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Pages/NearestPages/GtcNearestWaypointPage.tsx:49
The view key for this page's options popup.
planeHeadingTrue
protectedreadonlyplaneHeadingTrue:Subject<number>
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Pages/NearestPages/GtcNearestWaypointPage.tsx:80
The true heading of the airplane, in degrees, or NaN if heading data is invalid.
ppos
protectedreadonlyppos:GeoPointSubject
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Pages/NearestPages/GtcNearestWaypointPage.tsx:77
The position of the airplane.
pposPipe?
protectedoptionalpposPipe:Subscription
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Pages/NearestPages/GtcNearestWaypointPage.tsx:97
props
props:
P&ComponentProps
Defined in: sdk/components/FSComponent.ts:61
The properties of the component.
Inherited from
publisher
protectedreadonlypublisher:Publisher<DisplayPaneControlEvents<NearestPaneViewEventTypes>>
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Pages/NearestPages/GtcNearestWaypointPage.tsx:51
resetMapRange
protectedresetMapRange:boolean=false
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Pages/NearestPages/GtcNearestWaypointPage.tsx:89
rootCssClass
protectedreadonlyrootCssClass:SetSubject<string>
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Pages/NearestPages/GtcNearestWaypointPage.tsx:46
selectedFacility
protectedreadonlyselectedFacility:Subject<null|FacilityTypeMap[T]>
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Pages/NearestPages/GtcNearestWaypointPage.tsx:74
The facility associated with the selected waypoint.
selectedFacilityPipe?
protectedoptionalselectedFacilityPipe:Subscription
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Pages/NearestPages/GtcNearestWaypointPage.tsx:96
selectedWaypoint
protectedreadonlyselectedWaypoint:Subject<null|NearestWaypointTypeMap[T]>
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Pages/NearestPages/GtcNearestWaypointPage.tsx:69
The selected waypoint, or null if there is no selected waypoint.
showOnMap
protectedreadonlyshowOnMap:Subject<boolean>
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Pages/NearestPages/GtcNearestWaypointPage.tsx:87
showOnMapIcao
protectedreadonlyshowOnMapIcao:MappedSubscribable<IcaoValue>
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Pages/NearestPages/GtcNearestWaypointPage.tsx:88
showOnMapSub?
protectedoptionalshowOnMapSub:Subscription
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Pages/NearestPages/GtcNearestWaypointPage.tsx:101
showOnMapType
abstractprotectedreadonlyshowOnMapType:NearestPaneSelectionType
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Pages/NearestPages/GtcNearestWaypointPage.tsx:86
The view key for this page's options popup.
sidebarState
readonlysidebarState:SidebarStateReadonly
Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcView.ts:38
The GTC sidebar state (labels and buttons) requested by this view.
Inherited from
title
readonlytitle:Subscribable<undefined|string>
Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcView.ts:42
This view's title.
Inherited from
unitsSettingManager
protectedreadonlyunitsSettingManager:UnitsUserSettingManager<UnitsUserSettingTypes>
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Pages/NearestPages/GtcNearestWaypointPage.tsx:91
waypointArray
protectedreadonlywaypointArray:NearestWaypointArray<T,EntryType>
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Pages/NearestPages/GtcNearestWaypointPage.tsx:61
GPS_FAIL_CLEAR_LIST_DELAY
protectedreadonlystaticGPS_FAIL_CLEAR_LIST_DELAY:10000=10000
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Pages/NearestPages/GtcNearestWaypointPage.tsx:42
Methods
createWaypointEntry()
protectedcreateWaypointEntry(waypoint):EntryType
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Pages/NearestPages/GtcNearestWaypointPage.tsx:231
Creates a waypoint entry for a nearest facility search result.
Parameters
| Parameter | Type | Description |
|---|---|---|
waypoint | NearestWaypointTypeMap[T] | 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: workingtitle-instruments-g3000/html_ui/GTC/Pages/NearestPages/GtcNearestWaypointPage.tsx:302
Destroys this component.
Returns
void
Overrides
getContext()
protectedgetContext(context):never
Defined in: 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
getCssClass()
abstractprotectedgetCssClass():string
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Pages/NearestPages/GtcNearestWaypointPage.tsx:279
Gets the CSS class for this page's root element.
Returns
string
The CSS class for this page's root element.
getHeaderTypeLabel()
abstractprotectedgetHeaderTypeLabel():string
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Pages/NearestPages/GtcNearestWaypointPage.tsx:285
Gets the label for the type column of this page's header .
Returns
string
The label for the type column of this page's header.
getNearestSubscription()
abstractprotectedgetNearestSubscription(context):NearestSubscription<FacilityTypeMap[T]>
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Pages/NearestPages/GtcNearestWaypointPage.tsx:150
Gets this page's nearest facilities subscription from a nearest context.
Parameters
| Parameter | Type | Description |
|---|---|---|
context | G3000NearestContext | A nearest context. |
Returns
NearestSubscription<FacilityTypeMap[T]>
This page's nearest facilities subscription from the specified nearest context.
initNearestSearch()
protectedinitNearestSearch():Promise<void>
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Pages/NearestPages/GtcNearestWaypointPage.tsx:134
Initializes this page's nearest waypoints search.
Returns
Promise<void>
onAfterRender()
onAfterRender():
void
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Pages/NearestPages/GtcNearestWaypointPage.tsx:153
A callback that is called after the component is rendered.
Returns
void
Overrides
onBeforeRender()
onBeforeRender():
void
Defined in: sdk/components/FSComponent.ts:80
A callback that is called before the component is rendered.
Returns
void
Inherited from
onClose()
onClose():
void
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Pages/NearestPages/GtcNearestWaypointPage.tsx:197
A method that is called when this view is closed. A view is closed when it does not appear in the most recent history state of its parent view stack.
Returns
void
Overrides
onGtcInteractionEvent()
onGtcInteractionEvent(
event):boolean
Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcView.ts:97
Called when there is an interaction event when this is the active view.
Parameters
| Parameter | Type | Description |
|---|---|---|
event | GtcInteractionEvent | The event. |
Returns
boolean
Whether the event was handled or not.
Inherited from
onInUse()
onInUse():
void
Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcView.ts:48
A method that is called when this view comes into use. A view is in-use when it appears in at least one history state of its parent view stack.
Returns
void
Inherited from
onOpen()
onOpen():
void
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Pages/NearestPages/GtcNearestWaypointPage.tsx:192
A method that is called when this view is opened. A view is open when it appears in the most recent history state of its parent view stack.
Returns
void
Overrides
onOutOfUse()
onOutOfUse():
void
Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcView.ts:56
A method that is called when this view goes out of use. A view is out-of-use when it does not appear in any history states of its parent view stack.
Returns
void
Inherited from
onPause()
onPause():
void
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Pages/NearestPages/GtcNearestWaypointPage.tsx:214
A method that is called when this view is paused. A view is paused when it is not the active view.
Returns
void
Overrides
onResume()
onResume():
void
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Pages/NearestPages/GtcNearestWaypointPage.tsx:203
A method that is called when this view is resumed. A view is resumed when it is the active view.
Returns
void
Overrides
render()
render():
VNode
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Pages/NearestPages/GtcNearestWaypointPage.tsx:248
Renders the component.
Returns
A JSX element to be rendered.
Overrides
renderAdditionalHeaderColumns()
abstractprotectedrenderAdditionalHeaderColumns():null|VNode
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Pages/NearestPages/GtcNearestWaypointPage.tsx:291
Renders additional header columns.
Returns
null | VNode
Additional header columns, as a VNode, or null if there are no additional columns.
renderListItem()
abstractprotectedrenderListItem(data,index):VNode
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Pages/NearestPages/GtcNearestWaypointPage.tsx:299
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
A nearest waypoint list item, as a VNode.
sendSelectionData()
protectedsendSelectionData(data):void
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Pages/NearestPages/GtcNearestWaypointPage.tsx:239
Sends waypoint selection data to the display pane controlled by this page.
Parameters
| Parameter | Type | Description |
|---|---|---|
data | NearestPaneSelectionData | The data to send. |
Returns
void