Skip to main content

Class: PFDDirectTo

Defined in: workingtitle-instruments-g1000/html_ui/PFD/Components/UI/DirectTo/PFDDirectTo.tsx:11

The PFD direct-to popout.

Extends​

Constructors​

Constructor​

new PFDDirectTo(props): PFDDirectTo

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiControlGroup.tsx:36

Parameters​

ParameterType
propsDirectToProps

Returns​

PFDDirectTo

Inherit Doc​

Inherited from​

DirectTo.constructor

Properties​

context?​

optional context: [] = undefined

Defined in: sdk/components/FSComponent.ts:67

The context on this component, if any.

Inherited from​

DirectTo.context


contextType?​

readonly optional contextType: readonly [] = undefined

Defined in: sdk/components/FSComponent.ts:70

The type of context for this component, if any.

Inherited from​

DirectTo.contextType


controller​

protected readonly controller: DirectToController

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/DirectTo/DirectTo.tsx:52

Inherited from​

DirectTo.controller


courseOnesRef​

protected readonly courseOnesRef: NodeReference<NumberInput>

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/DirectTo/DirectTo.tsx:45

Inherited from​

DirectTo.courseOnesRef


courseTensRef​

protected readonly courseTensRef: NodeReference<NumberInput>

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/DirectTo/DirectTo.tsx:46

Inherited from​

DirectTo.courseTensRef


focusSubject​

protected focusSubject: Subject<boolean>

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiControlGroup.tsx:33

Inherited from​

DirectTo.focusSubject


inputData​

inputData: Subject<DirectToInputData | undefined>

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiView.tsx:36

Inherited from​

DirectTo.inputData


isOpen​

protected isOpen: boolean = false

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/DirectTo/DirectTo.tsx:56

Inherited from​

DirectTo.isOpen


onAccept​

onAccept: SubEventInterface<PFDDirectTo, undefined>

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiView.tsx:40

Inherited from​

DirectTo.onAccept


onClose​

onClose: SubEventInterface<PFDDirectTo, void>

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiView.tsx:39

Inherited from​

DirectTo.onClose


onOpen​

onOpen: SubEventInterface<PFDDirectTo, void>

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiView.tsx:38

Inherited from​

DirectTo.onOpen


planeHeading​

protected readonly planeHeading: Subject<number>

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/DirectTo/DirectTo.tsx:49

Inherited from​

DirectTo.planeHeading


planePos​

protected readonly planePos: GeoPointSubject

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/DirectTo/DirectTo.tsx:48

Inherited from​

DirectTo.planePos


props​

props: DirectToProps & ComponentProps

Defined in: sdk/components/FSComponent.ts:64

The properties of the component.

Inherited from​

DirectTo.props


scrollController​

protected scrollController: ScrollController

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiControlGroup.tsx:32

Inherited from​

DirectTo.scrollController


store​

protected readonly store: DirectToStore

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/DirectTo/DirectTo.tsx:51

Inherited from​

DirectTo.store


unitSettingManager​

protected readonly unitSettingManager: UnitsUserSettingManager<UnitsUserSettingTypes>

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/DirectTo/DirectTo.tsx:54

Inherited from​

DirectTo.unitSettingManager


viewContainerRef​

protected readonly viewContainerRef: NodeReference<HTMLDivElement>

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiView.tsx:32

Inherited from​

DirectTo.viewContainerRef


viewResult​

viewResult: undefined

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiView.tsx:34

Inherited from​

DirectTo.viewResult

Methods​

accept()​

accept(result?, closeView?): void

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiView.tsx:108

Confirms the view result and closes the view.

Parameters​

ParameterTypeDefault valueDescription
result?undefinedundefinedProvide the view result if not already set.
closeView?booleantrueIndicates if the view should be closed after confirming the result.

Returns​

void

Inherited from​

DirectTo.accept


blur()​

blur(): void

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiControlGroup.tsx:71

Method to unfocus this control group

Returns​

void

Inherited from​

DirectTo.blur


close()​

close(quickclose): void

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiView.tsx:65

Closes the view.

Parameters​

ParameterTypeDefault valueDescription
quickclosebooleanfalsebool stating whether to quickclose the child.

Returns​

void

Inherited from​

DirectTo.close


destroy()​

destroy(): void

Defined in: sdk/components/FSComponent.ts:101

Destroys this component.

Returns​

void

Inherited from​

DirectTo.destroy


focus()​

focus(dir): void

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiControlGroup.tsx:61

Method to focus this control group

Parameters​

ParameterTypeDefault valueDescription
dirEntryDirection'top'The direction of entry.

Returns​

void

Inherited from​

DirectTo.focus


getActivateScrollIndex()​

protected getActivateScrollIndex(): number

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/DirectTo/DirectTo.tsx:104

Method to get the activate scroll index for this instance.

Returns​

number

The Activate Scroll Index.

Inherited from​

DirectTo.getActivateScrollIndex


getContext()​

protected getContext(context): never

Defined in: sdk/components/FSComponent.ts:109

Gets a context data subscription from the context collection.

Parameters​

ParameterTypeDescription
contextneverThe 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​

DirectTo.getContext


getHighlightElement()​

getHighlightElement(): Element | null

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiControlGroup.tsx:125

This is just a dummy that exists here to be compatible with the union type of ScrollableControl

Returns​

Element | null

null

Inherited from​

DirectTo.getHighlightElement


getIsFocusable()​

getIsFocusable(): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiControlGroup.tsx:88

Gets a boolean indicating if this control is able to be focused.

Returns​

boolean

true

Inherited from​

DirectTo.getIsFocusable


getIsFocused()​

getIsFocused(): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiControlGroup.tsx:80

Method to check if this UiControlGroup is in focus

Returns​

boolean

true if the control group is in focus, false otherwise

Inherited from​

DirectTo.getIsFocused


gotoActivateButton()​

protected gotoActivateButton(): void

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/DirectTo/DirectTo.tsx:96

Returns​

void

Inherit Doc​

Inherited from​

DirectTo.gotoActivateButton


notifyViewOpened()​

protected notifyViewOpened(): void

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiView.tsx:131

Notifies subscribers that the view has been opened.

Returns​

void

Inherited from​

DirectTo.notifyViewOpened


onAfterRender()​

onAfterRender(node): void

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/DirectTo/DirectTo.tsx:63

A callback that is called after the component is rendered.

Parameters​

ParameterTypeDescription
nodeVNodeThe component's VNode.

Returns​

void

Inherited from​

DirectTo.onAfterRender


onBeforeRender()​

onBeforeRender(): void

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiControlGroup.tsx:51

A callback that is called before the component is rendered.

Returns​

void

Inherited from​

DirectTo.onBeforeRender


onBlurred()​

protected onBlurred(): void

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiControlGroup.tsx:244

A callback which is called when this control group is blurred.

Returns​

void

Inherited from​

DirectTo.onBlurred


onFocused()​

protected onFocused(): void

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiControlGroup.tsx:237

A callback which is called when this control group is focused.

Returns​

void

Inherited from​

DirectTo.onFocused


onHoldButtonPressed()​

onHoldButtonPressed(): void

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/DirectTo/DirectTo.tsx:111

Callback for when the Hold button is pressed.

Returns​

void

Inherited from​

DirectTo.onHoldButtonPressed


onInputDataSet()​

onInputDataSet(directToInputData): void

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/DirectTo/DirectTo.tsx:70

Method to be overridden by view inheriting UiView to do something when the input data is set.

Parameters​

ParameterTypeDescription
directToInputDataDirectToInputData | undefinedThe data that was set.

Returns​

void

Inherited from​

DirectTo.onInputDataSet


onInteractionEvent()​

onInteractionEvent(evt): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/DirectTo/DirectTo.tsx:85

Handler for interaction events to be handled by the view.

Parameters​

ParameterTypeDescription
evtFmsHEventThe HEvenet.

Returns​

boolean

true if the event was handled in this group

Inherited from​

DirectTo.onInteractionEvent


onLoadExecuted()​

protected onLoadExecuted(): void

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/DirectTo/DirectTo.tsx:233

A callback which is called when the Load action is executed.

Returns​

void

Inherited from​

DirectTo.onLoadExecuted


onScrollToggled()​

protected onScrollToggled(enabled): void

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiControlGroup.tsx:97

A method called when the control group scroll is toggled.

Parameters​

ParameterTypeDescription
enabledbooleanif the scroll is enabled.

Returns​

void

Inherited from​

DirectTo.onScrollToggled


onViewClosed()​

protected onViewClosed(): void

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/DirectTo/DirectTo.tsx:126

Method to be overridden by view inheriting UiView to do something when the dialog opens.

Returns​

void

Inherited from​

DirectTo.onViewClosed


onViewOpened()​

protected onViewOpened(): void

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/DirectTo/DirectTo.tsx:116

Method to be overridden by view inheriting UiView to do something when the view opens.

Returns​

void

Inherited from​

DirectTo.onViewOpened


onViewPaused()​

protected onViewPaused(): void

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiView.tsx:179

Method to be overridden by view inheriting UiView to do something when the dialog opens.

Returns​

void

Inherited from​

DirectTo.onViewPaused


onViewResumed()​

protected onViewResumed(): void

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiView.tsx:174

Method to be overridden by view inheriting UiView to do something when the dialog opens.

Returns​

void

Inherited from​

DirectTo.onViewResumed


open()​

open(isSubView, zIndex?): void

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiView.tsx:47

Shows the view.

Parameters​

ParameterTypeDescription
isSubViewbooleanWhether the view is being displayed as a subview.
zIndex?numberThe z-index to assign on the view container.

Returns​

void

Inherited from​

DirectTo.open


pause()​

pause(): void

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiView.tsx:201

Pauses the view (usually only called by ViewService).

Returns​

void

Inherited from​

DirectTo.pause


processHEvent()​

processHEvent(evt): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiControlGroup.tsx:134

Handles HEvents and routes them to the subdialog when existant.

Parameters​

ParameterTypeDescription
evtFmsHEventThe received event.

Returns​

boolean

true if the event was handled in this control group, false otherwise.

Inherited from​

DirectTo.processHEvent


processScrollEvent()​

protected processScrollEvent(evt): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiView.tsx:119

Attempts to handle scroll events.

Parameters​

ParameterTypeDescription
evtFmsHEventThe received event.

Returns​

boolean

whether the event was handled.

Inherited from​

DirectTo.processScrollEvent


register()​

protected register(ctrl, unregister): void

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiControlGroup.tsx:226

Register/Unregisters a UiControl with the scroll controller.

Parameters​

ParameterTypeDefault valueDescription
ctrlScrollableControlundefinedThe UiControl to register.
unregisterbooleanfalseIndicates if the UiControl should be unregistered.

Returns​

void

Inherited from​

DirectTo.register


render()​

render(): VNode

Defined in: workingtitle-instruments-g1000/html_ui/PFD/Components/UI/DirectTo/PFDDirectTo.tsx:13

Renders the component.

Returns​

VNode

A JSX element to be rendered.

Overrides​

DirectTo.render


renderBearing()​

protected renderBearing(cssClass?): VNode

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/DirectTo/DirectTo.tsx:173

Renders a component which displays the bearing to the store's selected waypoint.

Parameters​

ParameterTypeDescription
cssClass?stringCSS class(es) to apply to the root of the component.

Returns​

VNode

a component which displays the bearing to the store's selected waypoint, as a VNode.

Inherited from​

DirectTo.renderBearing


renderCourseInput()​

protected renderCourseInput(cssClass?): VNode

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/DirectTo/DirectTo.tsx:203

Renders a component which allows the user to input the direct-to course.

Parameters​

ParameterTypeDescription
cssClass?stringCSS class(es) to apply to the root of the component.

Returns​

VNode

A component which allows the user to input the direct-to course, as a VNode.

Inherited from​

DirectTo.renderCourseInput


renderDistance()​

protected renderDistance(cssClass?): VNode

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/DirectTo/DirectTo.tsx:188

Renders a component which displays the distance to the store's selected waypoint.

Parameters​

ParameterTypeDescription
cssClass?stringCSS class(es) to apply to the root of the component.

Returns​

VNode

a component which displays the distance to the store's selected waypoint, as a VNode.

Inherited from​

DirectTo.renderDistance


renderWaypointInput()​

protected renderWaypointInput(): VNode

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/DirectTo/DirectTo.tsx:153

Renders a waypoint input component.

Returns​

VNode

a waypoint input component, as a VNode.

Inherited from​

DirectTo.renderWaypointInput


resume()​

resume(): void

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiView.tsx:208

Resumes the view (usually only called by ViewService).

Returns​

void

Inherited from​

DirectTo.resume


routeEventToControl()​

protected routeEventToControl(evt, control): boolean

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiControlGroup.tsx:176

Routes an interaction event to a UiControl.

Parameters​

ParameterTypeDescription
evtFmsHEventAn interaction event.
controlUiControlThe UiControl to which to route the event.

Returns​

boolean

Whether the event was handled by the UiControl.

Inherited from​

DirectTo.routeEventToControl


setCourse()​

protected setCourse(): void

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/DirectTo/DirectTo.tsx:79

Sets the course subject based on the number input fields.

Returns​

void

Inherited from​

DirectTo.setCourse


setInput()​

setInput(input): this

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiView.tsx:97

Set data on this view.

Parameters​

ParameterTypeDescription
inputDirectToInputData | undefinedThe input data.

Returns​

this

This view instance for chain commands.

Inherited from​

DirectTo.setInput


setScrollEnabled()​

setScrollEnabled(enabled): void

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiControlGroup.tsx:113

Sets the scroll enabled state

Parameters​

ParameterTypeDescription
enabledbooleanindicating if scrolling should be enabled

Returns​

void

Inherited from​

DirectTo.setScrollEnabled


setZIndex()​

setZIndex(zIndex): void

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiView.tsx:88

Sets this view's z-index.

Parameters​

ParameterTypeDescription
zIndexnumber | undefinedThe new z-indez. If not defined, the view's z-index will be reset.

Returns​

void

Inherited from​

DirectTo.setZIndex


toggleScroll()​

toggleScroll(): void

Defined in: workingtitle-instruments-g1000/html_ui/Shared/UI/UiControlGroup.tsx:104

Toggles the scroll highlighting

Returns​

void

Inherited from​

DirectTo.toggleScroll