Interface: FPLHeaderProps

The properties for the FPLHeader component.

Hierarchy

• G1000UiControlProps

  ↳ FPLHeaderProps

Properties

children

• Optional children: DisplayChildren[]

The children of the display component.

Inherited from

G1000UiControlProps.children

Defined in

sdk/components/FSComponent.ts:122

---

facilities

• facilities: FacilityInfo

Info about origin and destination facilities

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/FPL/FPLHeader.tsx:14

---

fms

• fms: Fms<any>

The fms.

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/FPL/FPLHeader.tsx:12

---

getFocusPositionOnScroll

• Optional getFocusPositionOnScroll: (direction: ScrollDirection) => FocusPosition

A function which returns how the control should focus its children when it is focused from a scroll.

Type declaration

▸ (direction): FocusPosition

A function which returns how the control should focus its children when it is focused from a scroll.

Parameters

Name	Type
direction	ScrollDirection

Returns

FocusPosition

Inherited from

G1000UiControlProps.getFocusPositionOnScroll

Defined in

sdk/components/controls/HardwareUiControl.tsx:56

---

innerKnobScroll

• Optional innerKnobScroll: boolean

Whether or not the inner FMS knob scrolls also by default.

Inherited from

G1000UiControlProps.innerKnobScroll

Defined in

sdk/components/controls/HardwareUiControl.tsx:32

---

isolateScroll

• Optional isolateScroll: boolean

When enabled, scroll commands will not propagate from this control to its parent while the control is focused.

Inherited from

G1000UiControlProps.isolateScroll

Defined in

sdk/components/controls/HardwareUiControl.tsx:38

---

on0

• on0: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.on0

---

on1

• on1: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.on1

---

on2

• on2: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.on2

---

on3

• on3: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.on3

---

on4

• on4: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.on4

---

on5

• on5: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.on5

---

on6

• on6: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.on6

---

on7

• on7: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.on7

---

on8

• on8: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.on8

---

on9

• on9: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.on9

---

onA

• onA: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onA

---

onAfterScroll

• Optional onAfterScroll: (control: HardwareUiControl<Record<string, any>, HardwareUiControlProps>, index: number) => void

An event called when the scroll operation has completed.

Type declaration

▸ (control, index): void

An event called when the scroll operation has completed.

Parameters

Name	Type
control	HardwareUiControl<Record<string, any>, HardwareUiControlProps>
index	number

Returns

void

Inherited from

G1000UiControlProps.onAfterScroll

Defined in

sdk/components/controls/HardwareUiControl.tsx:62

---

onB

• onB: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onB

---

onBKSP

• onBKSP: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onBKSP

---

onBlurred

• Optional onBlurred: (source: HardwareUiControl<Record<string, any>, HardwareUiControlProps>) => void

An event called when the control loses focus.

Type declaration

▸ (source): void

An event called when the control loses focus.

Parameters

Name	Type
source	HardwareUiControl<Record<string, any>, HardwareUiControlProps>

Returns

void

Inherited from

G1000UiControlProps.onBlurred

Defined in

sdk/components/controls/HardwareUiControl.tsx:47

---

onC

• onC: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onC

---

onClr

• onClr: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onClr

---

onClrLong

• onClrLong: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onClrLong

---

onCom

• onCom: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onCom

---

onCrs

• onCrs: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onCrs

---

onD

• onD: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onD

---

onDestroyed

• Optional onDestroyed: (source: HardwareUiControl<Record<string, any>, HardwareUiControlProps>) => void

An event called when the control is destroyed.

Type declaration

▸ (source): void

An event called when the control is destroyed.

Parameters

Name	Type
source	HardwareUiControl<Record<string, any>, HardwareUiControlProps>

Returns

void

Inherited from

G1000UiControlProps.onDestroyed

Defined in

sdk/components/controls/HardwareUiControl.tsx:71

---

onDirectTo

• onDirectTo: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onDirectTo

---

onDisabled

• Optional onDisabled: (source: HardwareUiControl<Record<string, any>, HardwareUiControlProps>) => void

An event called when the control is disabled.

Type declaration

▸ (source): void

An event called when the control is disabled.

Parameters

Name	Type
source	HardwareUiControl<Record<string, any>, HardwareUiControlProps>

Returns

void

Inherited from

G1000UiControlProps.onDisabled

Defined in

sdk/components/controls/HardwareUiControl.tsx:50

---

onDot

• onDot: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onDot

---

onE

• onE: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onE

---

onEnabled

• Optional onEnabled: (source: HardwareUiControl<Record<string, any>, HardwareUiControlProps>) => void

An event called when the control is enabled.

Type declaration

▸ (source): void

An event called when the control is enabled.

Parameters

Name	Type
source	HardwareUiControl<Record<string, any>, HardwareUiControlProps>

Returns

void

Inherited from

G1000UiControlProps.onEnabled

Defined in

sdk/components/controls/HardwareUiControl.tsx:53

---

onEnter

• onEnter: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onEnter

---

onF

• onF: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onF

---

onFPL

• onFPL: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onFPL

---

onFocused

• Optional onFocused: (source: HardwareUiControl<Record<string, any>, HardwareUiControlProps>) => void

An event called when the control is focused.

Type declaration

▸ (source): void

An event called when the control is focused.

Parameters

Name	Type
source	HardwareUiControl<Record<string, any>, HardwareUiControlProps>

Returns

void

Inherited from

G1000UiControlProps.onFocused

Defined in

sdk/components/controls/HardwareUiControl.tsx:44

---

onG

• onG: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onG

---

onH

• onH: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onH

---

onHome

• onHome: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onHome

---

onI

• onI: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onI

---

onInnerControlKnobDec

• onInnerControlKnobDec: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onInnerControlKnobDec

---

onInnerControlKnobInc

• onInnerControlKnobInc: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onInnerControlKnobInc

---

onInnerControlKnobPush

• onInnerControlKnobPush: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onInnerControlKnobPush

---

onJ

• onJ: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onJ

---

onJoystickDown

• onJoystickDown: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onJoystickDown

---

onJoystickLeft

• onJoystickLeft: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onJoystickLeft

---

onJoystickPush

• onJoystickPush: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onJoystickPush

---

onJoystickRight

• onJoystickRight: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onJoystickRight

---

onJoystickUp

• onJoystickUp: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onJoystickUp

---

onK

• onK: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onK

---

onL

• onL: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onL

---

onLowerKnobDec

• onLowerKnobDec: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onLowerKnobDec

---

onLowerKnobInc

• onLowerKnobInc: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onLowerKnobInc

---

onM

• onM: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onM

---

onMenu

• onMenu: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onMenu

---

onN

• onN: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onN

---

onNav

• onNav: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onNav

---

onO

• onO: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onO

---

onOuterControlKnobDec

• onOuterControlKnobDec: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onOuterControlKnobDec

---

onOuterControlKnobInc

• onOuterControlKnobInc: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onOuterControlKnobInc

---

onP

• onP: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onP

---

onPlusMinus

• onPlusMinus: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onPlusMinus

---

onProc

• onProc: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onProc

---

onQ

• onQ: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onQ

---

onR

• onR: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onR

---

onRangeDec

• onRangeDec: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onRangeDec

---

onRangeInc

• onRangeInc: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onRangeInc

---

onRegistered

• Optional onRegistered: (source: HardwareUiControl<Record<string, any>, HardwareUiControlProps>) => void

An event called when a control is registered with this control.

Type declaration

▸ (source): void

An event called when a control is registered with this control.

Parameters

Name	Type
source	HardwareUiControl<Record<string, any>, HardwareUiControlProps>

Returns

void

Inherited from

G1000UiControlProps.onRegistered

Defined in

sdk/components/controls/HardwareUiControl.tsx:65

---

onS

• onS: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onS

---

onSPC

• onSPC: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onSPC

---

onScroll

• Optional onScroll: (direction: ScrollDirection) => boolean

An event called when the control is scrolled.

Type declaration

▸ (direction): boolean

An event called when the control is scrolled.

Parameters

Name	Type
direction	ScrollDirection

Returns

boolean

Inherited from

G1000UiControlProps.onScroll

Defined in

sdk/components/controls/HardwareUiControl.tsx:59

---

onT

• onT: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onT

---

onU

• onU: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onU

---

onUnregistered

• Optional onUnregistered: (source: HardwareUiControl<Record<string, any>, HardwareUiControlProps>) => void

An event called when a control is unregistered with this control.

Type declaration

▸ (source): void

An event called when a control is unregistered with this control.

Parameters

Name	Type
source	HardwareUiControl<Record<string, any>, HardwareUiControlProps>

Returns

void

Inherited from

G1000UiControlProps.onUnregistered

Defined in

sdk/components/controls/HardwareUiControl.tsx:68

---

onUpperKnobDec

• onUpperKnobDec: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onUpperKnobDec

---

onUpperKnobInc

• onUpperKnobInc: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onUpperKnobInc

---

onUpperKnobPush

• onUpperKnobPush: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onUpperKnobPush

---

onV

• onV: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onV

---

onW

• onW: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onW

---

onX

• onX: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onX

---

onXpdr

• onXpdr: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onXpdr

---

onY

• onY: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onY

---

onZ

• onZ: undefined | UiControlEventHandler<G1000UiControl<G1000UiControlProps>>

Inherited from

G1000UiControlProps.onZ

---

reconcileChildBlur

• Optional reconcileChildBlur: (index: number, child: HardwareUiControl<Record<string, any>, HardwareUiControlProps>) => number | BlurReconciliation

A function which reconciles the focus state of the control's children when the control is focused with no focused children after a child has been blurred.

Param

The index of the child control that was blurred.

Param

The child control that was blurred.

Type declaration

▸ (index, child): number | BlurReconciliation

A function which reconciles the focus state of the control's children when the control is focused with no focused children after a child has been blurred.

Parameters

Name	Type	Description
index	number	The index of the child control that was blurred.
child	HardwareUiControl<Record<string, any>, HardwareUiControlProps>	The child control that was blurred.

Returns

number | BlurReconciliation

The index of the child to focus, or a blur reconciliation strategy.

Inherited from

G1000UiControlProps.reconcileChildBlur

Defined in

sdk/components/controls/HardwareUiControl.tsx:80

---

ref

• Optional ref: NodeReference<any>

A reference to the display component.

Inherited from

G1000UiControlProps.ref

Defined in

sdk/components/FSComponent.ts:125

---

requireChildFocus

• Optional requireChildFocus: boolean

Whether the control requires one of its child controls to be focused for itself to be focused.

Inherited from

G1000UiControlProps.requireChildFocus

Defined in

sdk/components/controls/HardwareUiControl.tsx:41

---

scrollContainer

• Optional scrollContainer: NodeReference<HTMLElement>

The scroll container to scroll to when this item is focused.

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/FPL/FPLHeader.tsx:18

---

segment

• segment: FlightPlanSegment

The flight plan segment associated with this header.

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/UI/FPL/FPLHeader.tsx:16