Class: PFDHold
A class that displays the PFD hold dialog.
Hierarchy
↳
PFDHold
Constructors
constructor
• new PFDHold(props
): PFDHold
Creates an instance of PFDHold.
Parameters
Name | Type | Description |
---|---|---|
props | HoldProps | The props for this instance. |
Returns
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/Hold/Hold.tsx:49
Properties
context
• Optional
context: [] = undefined
The context on this component, if any.
Inherited from
Defined in
sdk/components/FSComponent.ts:64
contextType
• Optional
Readonly
contextType: readonly [] = undefined
The type of context for this component, if any.
Inherited from
Defined in
sdk/components/FSComponent.ts:67
controller
• Protected
Readonly
controller: HoldController
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/Hold/Hold.tsx:42
distanceInput
• Protected
Readonly
distanceInput: NodeReference
<TimeDistanceInput
>
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/Hold/Hold.tsx:43
focusSubject
• Protected
focusSubject: Subject
<boolean
>
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:33
inputData
• inputData: Subject
<undefined
| HoldInputData
>
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:36
onAccept
• onAccept: SubEventInterface
<PFDHold
, undefined
>
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:40
onClose
• onClose: SubEventInterface
<PFDHold
, void
>
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:39
onOpen
• onOpen: SubEventInterface
<PFDHold
, void
>
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:38
props
• props: HoldProps
& ComponentProps
The properties of the component.
Inherited from
Defined in
sdk/components/FSComponent.ts:61
scrollController
• Protected
scrollController: ScrollController
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:32
store
• Protected
Readonly
store: HoldStore
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/Hold/Hold.tsx:41
viewContainerRef
• Protected
Readonly
viewContainerRef: NodeReference
<HTMLDivElement
>
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:32
viewResult
• viewResult: undefined
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:34
Methods
accept
▸ accept(result?
, closeView?
): void
Confirms the view result and closes the view.
Parameters
Name | Type | Default value | Description |
---|---|---|---|
result? | undefined | undefined | Provide the view result if not already set. |
closeView | boolean | true | Indicates if the view should be closed after confirming the result. |
Returns
void
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:108
blur
▸ blur(): void
Method to unfocus this control group
Returns
void
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:71
close
▸ close(quickclose?
): void
Closes the view.
Parameters
Name | Type | Default value | Description |
---|---|---|---|
quickclose | boolean | false | bool stating whether to quickclose the child. |
Returns
void
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:65
createDirectionStringSubscribable
▸ createDirectionStringSubscribable(): Subscribable
<string
>
Creates a subscribable which provides a direction string based on the set hold inbound course.
Returns
Subscribable
<string
>
A subscribable which provides a direction string based on the set hold inbound course.
Inherited from
Hold.createDirectionStringSubscribable
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/Hold/Hold.tsx:108
createLegNameSubscribable
▸ createLegNameSubscribable(): Subscribable
<string
>
Creates a subscribable which provides the name of the selected flight plan leg.
Returns
Subscribable
<string
>
A subscribable which provides the name of the selected flight plan leg.
Inherited from
Hold.createLegNameSubscribable
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/Hold/Hold.tsx:91
destroy
▸ destroy(): void
Destroys this component.
Returns
void
Inherited from
Defined in
sdk/components/FSComponent.ts:98
focus
▸ focus(dir?
): void
Method to focus this control group
Parameters
Name | Type | Default value | Description |
---|---|---|---|
dir | EntryDirection | 'top' | The direction of entry. |
Returns
void
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:61
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
Defined in
sdk/components/FSComponent.ts:106
getHighlightElement
▸ getHighlightElement(): null
| Element
This is just a dummy that exists here to be compatible with the union type of ScrollableControl
Returns
null
| Element
null
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:125
getIsFocusable
▸ getIsFocusable(): boolean
Gets a boolean indicating if this control is able to be focused.
Returns
boolean
true
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:88
getIsFocused
▸ getIsFocused(): boolean
Method to check if this UiControlGroup is in focus
Returns
boolean
true if the control group is in focus, false otherwise
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:80
notifyViewOpened
▸ notifyViewOpened(): void
Notifies subscribers that the view has been opened.
Returns
void
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:131
onAfterRender
▸ onAfterRender(): void
A callback that is called after the component is rendered.
Returns
void
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/Hold/Hold.tsx:58
onBeforeRender
▸ onBeforeRender(): void
Returns
void
Inherit Doc
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:51
onBlurred
▸ onBlurred(): void
A callback which is called when this control group is blurred.
Returns
void
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:244
onFocused
▸ onFocused(): void
A callback which is called when this control group is focused.
Returns
void
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:237
onInputDataSet
▸ onInputDataSet(input
): void
Method to be overridden by view inheriting UiView to do something when the input data is set.
Parameters
Name | Type | Description |
---|---|---|
input | undefined | HoldInputData | The data that was set. |
Returns
void
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/Hold/Hold.tsx:74
onInteractionEvent
▸ onInteractionEvent(evt
): boolean
Handler for interaction events to be handled by the view.
Parameters
Name | Type | Description |
---|---|---|
evt | FmsHEvent | The HEvenet. |
Returns
boolean
true if the event was handled in this group
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/Hold/Hold.tsx:63
onScrollToggled
▸ onScrollToggled(enabled
): void
A method called when the control group scroll is toggled.
Parameters
Name | Type | Description |
---|---|---|
enabled | boolean | if the scroll is enabled. |
Returns
void
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:97
onViewClosed
▸ onViewClosed(): void
Method to be overridden by view inheriting UiView to do something when the dialog opens.
Returns
void
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/Hold/Hold.tsx:83
onViewOpened
▸ onViewOpened(): void
Method to be overridden by view inheriting UiView to do something when the view opens.
Returns
void
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:169
onViewPaused
▸ onViewPaused(): void
Method to be overridden by view inheriting UiView to do something when the dialog opens.
Returns
void
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:179
onViewResumed
▸ onViewResumed(): void
Method to be overridden by view inheriting UiView to do something when the dialog opens.
Returns
void
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:174
open
▸ open(isSubView
, zIndex?
): void
Shows the view.
Parameters
Name | Type | Description |
---|---|---|
isSubView | boolean | Whether the view is being displayed as a subview. |
zIndex? | number | The z-index to assign on the view container. |
Returns
void
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:47
pause
▸ pause(): void
Pauses the view (usually only called by ViewService).
Returns
void
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:201
processHEvent
▸ processHEvent(evt
): boolean
Handles HEvents and routes them to the subdialog when existant.
Parameters
Name | Type | Description |
---|---|---|
evt | FmsHEvent | The received event. |
Returns
boolean
true if the event was handled in this control group, false otherwise.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:134
processScrollEvent
▸ processScrollEvent(evt
): boolean
Attempts to handle scroll events.
Parameters
Name | Type | Description |
---|---|---|
evt | FmsHEvent | The received event. |
Returns
boolean
whether the event was handled.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:119
register
▸ register(ctrl
, unregister?
): void
Register/Unregisters a UiControl with the scroll controller.
Parameters
Name | Type | Default value | Description |
---|---|---|---|
ctrl | ScrollableControl | undefined | The UiControl to register. |
unregister | boolean | false | Indicates if the UiControl should be unregistered. |
Returns
void
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:226
render
▸ render(): VNode
Renders the PFD hold dialog.
Returns
VNode
The rendered VNode.
Overrides
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/PFD/Components/UI/Hold/PFDHold.tsx:20
resume
▸ resume(): void
Resumes the view (usually only called by ViewService).
Returns
void
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:208
routeEventToControl
▸ routeEventToControl(evt
, control
): boolean
Routes an interaction event to a UiControl.
Parameters
Name | Type | Description |
---|---|---|
evt | FmsHEvent | An interaction event. |
control | UiControl <UiControlProps > | The UiControl to which to route the event. |
Returns
boolean
Whether the event was handled by the UiControl.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:176
setInput
▸ setInput(input
): this
Set data on this view.
Parameters
Name | Type | Description |
---|---|---|
input | undefined | HoldInputData | The input data. |
Returns
this
This view instance for chain commands.
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:97
setScrollEnabled
▸ setScrollEnabled(enabled
): void
Sets the scroll enabled state
Parameters
Name | Type | Description |
---|---|---|
enabled | boolean | indicating if scrolling should be enabled |
Returns
void
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:113
setZIndex
▸ setZIndex(zIndex
): void
Sets this view's z-index.
Parameters
Name | Type | Description |
---|---|---|
zIndex | undefined | number | The new z-indez. If not defined, the view's z-index will be reset. |
Returns
void
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiView.tsx:88
toggleScroll
▸ toggleScroll(): void
Toggles the scroll highlighting
Returns
void
Inherited from
Defined in
workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/UiControlGroup.tsx:104