Interface: GenericUiViewProps

Component props for GenericUiView.

Hierarchy

• UiViewProps

  ↳ GenericUiViewProps

Properties

children

• Optional children: DisplayChildren[]

The children of the display component.

Inherited from

UiViewProps.children

Defined in

src/sdk/components/FSComponent.ts:122

---

containerRef

• containerRef: NodeReference<HTMLElement>

A reference to the root element of the view's container.

Inherited from

UiViewProps.containerRef

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/UiView.ts:18

---

createFocusController

• Optional createFocusController: () => UiFocusController

A function which creates the view's UI focus controller. If not defined, then a default focus controller will be created.

Type declaration

▸ (): UiFocusController

A function which creates the view's UI focus controller. If not defined, then a default focus controller will be created.

Returns

UiFocusController

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/GenericUiView.tsx:29

---

onAfterRender

• Optional onAfterRender: (thisNode: VNode, members: GenericUiViewMembers) => void

A function which is called after the view is rendered.

Type declaration

▸ (thisNode, members): void

A function which is called after the view is rendered.

Parameters

Name	Type
thisNode	VNode
members	GenericUiViewMembers

Returns

void

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/GenericUiView.tsx:32

---

onClose

• Optional onClose: (members: GenericUiViewMembers) => void

A function which is called when the view is closed.

Type declaration

▸ (members): void

A function which is called when the view is closed.

Parameters

Name	Type
members	GenericUiViewMembers

Returns

void

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/GenericUiView.tsx:38

---

onDestroy

• Optional onDestroy: () => void

A function which is called when the view is destroyed.

Type declaration

▸ (): void

A function which is called when the view is destroyed.

Returns

void

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/GenericUiView.tsx:62

---

onOcclusionChange

• Optional onOcclusionChange: (occlusionType: UiViewOcclusionType, members: GenericUiViewMembers) => void

A function which is called when the occlusion type applied to the view changes while the view is open.

Type declaration

▸ (occlusionType, members): void

A function which is called when the occlusion type applied to the view changes while the view is open.

Parameters

Name	Type
occlusionType	UiViewOcclusionType
members	GenericUiViewMembers

Returns

void

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/GenericUiView.tsx:50

---

onOpen

• Optional onOpen: (sizeMode: UiViewSizeMode, dimensions: Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>, members: GenericUiViewMembers) => void

A function which is called when the view is opened.

Type declaration

▸ (sizeMode, dimensions, members): void

A function which is called when the view is opened.

Parameters

Name	Type
sizeMode	UiViewSizeMode
dimensions	Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>
members	GenericUiViewMembers

Returns

void

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/GenericUiView.tsx:35

---

onPause

• Optional onPause: (members: GenericUiViewMembers) => void

A function which is called when the view is paused.

Type declaration

▸ (members): void

A function which is called when the view is paused.

Parameters

Name	Type
members	GenericUiViewMembers

Returns

void

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/GenericUiView.tsx:44

---

onResize

• Optional onResize: (sizeMode: UiViewSizeMode, dimensions: Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>, members: GenericUiViewMembers) => void

A function which is called when the view is resized while it is open.

Type declaration

▸ (sizeMode, dimensions, members): void

A function which is called when the view is resized while it is open.

Parameters

Name	Type
sizeMode	UiViewSizeMode
dimensions	Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>
members	GenericUiViewMembers

Returns

void

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/GenericUiView.tsx:47

---

onResume

• Optional onResume: (members: GenericUiViewMembers) => void

A function which is called when the view is resumed.

Type declaration

▸ (members): void

A function which is called when the view is resumed.

Parameters

Name	Type
members	GenericUiViewMembers

Returns

void

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/GenericUiView.tsx:41

---

onUiInteractionEvent

• Optional onUiInteractionEvent: (event: UiInteractionEvent, members: GenericUiViewMembers) => boolean

A function which handles interaction events routed to the view. If not defined, then the view will delegate interaction event handling to its UI focus controller.

Type declaration

▸ (event, members): boolean

A function which handles interaction events routed to the view. If not defined, then the view will delegate interaction event handling to its UI focus controller.

Parameters

Name	Type
event	UiInteractionEvent
members	GenericUiViewMembers

Returns

boolean

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/GenericUiView.tsx:59

---

onUpdate

• Optional onUpdate: (time: number, members: GenericUiViewMembers) => void

A function which is called every update cycle.

Type declaration

▸ (time, members): void

A function which is called every update cycle.

Parameters

Name	Type
time	number
members	GenericUiViewMembers

Returns

void

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/GenericUiView.tsx:53

---

ref

• Optional ref: NodeReference<any>

A reference to the display component.

Inherited from

UiViewProps.ref

Defined in

src/sdk/components/FSComponent.ts:125

---

uiService

• uiService: UiService

The UI service instance.

Inherited from

UiViewProps.uiService

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/UiView.ts:15