Class: GtcWaypointDialog
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Dialog/GtcWaypointDialog.tsx:89
A dialog which allows the user to select a waypoint.
Extends
Implements
GtcDialogView
<GtcWaypointDialogInput
<G3000WaypointSearchType
>,Facility
>
Constructors
Constructor
new GtcWaypointDialog(
props
):GtcWaypointDialog
Defined in: sdk/components/FSComponent.ts:73
Creates an instance of a DisplayComponent.
Parameters
Parameter | Type | Description |
---|---|---|
props | GtcWaypointDialogProps | The propertis of the component. |
Returns
GtcWaypointDialog
Inherited from
Properties
_activeComponent
protected
readonly
_activeComponent:Subject
<null
|GtcInteractionHandler
>
Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcView.ts:34
Inherited from
_sidebarState
protected
readonly
_sidebarState:GtcSidebarState
Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcView.ts:36
Inherited from
_title
protected
readonly
_title:Subject
<undefined
|string
>
Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcView.ts:40
Inherited from
bus
protected
readonly
bus:EventBus
Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcView.ts:31
Inherited from
context?
optional
context: [] =undefined
Defined in: sdk/components/FSComponent.ts:64
The context on this component, if any.
Inherited from
contextType?
readonly
optional
contextType: readonly [] =undefined
Defined in: sdk/components/FSComponent.ts:67
The type of context for this component, if any.
Inherited from
gtcService
protected
readonly
gtcService:GtcService
Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcView.ts:32
Inherited from
props
props:
GtcWaypointDialogProps
&ComponentProps
Defined in: sdk/components/FSComponent.ts:61
The properties of the component.
Inherited from
sidebarState
readonly
sidebarState: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
readonly
title:Subscribable
<undefined
|string
>
Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcView.ts:42
This view's title.
Inherited from
Methods
destroy()
destroy():
void
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Dialog/GtcWaypointDialog.tsx:540
Destroys this component.
Returns
void
Overrides
getContext()
protected
getContext(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
onAfterRender()
onAfterRender(
thisNode
):void
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Dialog/GtcWaypointDialog.tsx:139
A callback that is called after the component is rendered.
Parameters
Parameter | Type | Description |
---|---|---|
thisNode | VNode | The component's VNode. |
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/Dialog/GtcWaypointDialog.tsx:182
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/Dialog/GtcWaypointDialog.tsx:187
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.
Overrides
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(
wasPreviouslyOpened
):void
Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcView.ts:67
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.
Parameters
Parameter | Type | Description |
---|---|---|
wasPreviouslyOpened | boolean | True when this view was open in a previous view stack (like if the go back button was used to reach this page). |
Returns
void
Inherited from
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/GtcService/GtcView.ts:89
A method that is called when this view is paused. A view is paused when it is not the active view.
Returns
void
Inherited from
onResume()
onResume():
void
Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcView.ts:82
A method that is called when this view is resumed. A view is resumed when it is the active view.
Returns
void
Inherited from
render()
render():
VNode
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Dialog/GtcWaypointDialog.tsx:486
Renders the component.
Returns
VNode
A JSX element to be rendered.
Overrides
request()
request<
T
>(input
):Promise
<GtcDialogResult
<SearchTypeMap
[T
]>>
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Dialog/GtcWaypointDialog.tsx:147
Requests a value from this dialog.
Type Parameters
Type Parameter |
---|
T extends G3000WaypointSearchType |
Parameters
Parameter | Type | Description |
---|---|---|
input | GtcWaypointDialogInput <T > | Input parameters defining the request. |
Returns
Promise
<GtcDialogResult
<SearchTypeMap
[T
]>>
A Promise which is fulfilled with the result of the request. The result will indicate whether the request was cancelled, and if the request was not cancelled, it will also contain the requested value.