Interface: UiView<P>

A view which displays content in a view stack.

Type parameters

Name	Type
P	extends UiViewProps = UiViewProps

Hierarchy

• DisplayComponent<P>

• UiInteractionHandler

  ↳ UiView

Implemented by

• AbstractUiView

Properties

context

• Optional context: [] = undefined

The context on this component, if any.

Inherited from

DisplayComponent.context

Defined in

src/sdk/components/FSComponent.ts:64

---

contextType

• Optional Readonly contextType: readonly [] = undefined

The type of context for this component, if any.

Inherited from

DisplayComponent.contextType

Defined in

src/sdk/components/FSComponent.ts:67

---

knobLabelState

• Readonly knobLabelState: SubscribableMap<UiKnobId, string> & Subscribable<UiKnobRequestedLabelState>

The bezel rotary knob label state requested by this view.

Defined in

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

---

props

• props: P & ComponentProps

The properties of the component.

Inherited from

DisplayComponent.props

Defined in

src/sdk/components/FSComponent.ts:61

Methods

destroy

▸ destroy(): void

Destroys this component.

Returns

void

Inherited from

DisplayComponent.destroy

Defined in

src/sdk/components/FSComponent.ts:98

---

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

DisplayComponent.getContext

Defined in

src/sdk/components/FSComponent.ts:106

---

onAfterRender

▸ onAfterRender(node): void

A callback that is called after the component is rendered.

Parameters

Name	Type	Description
node	VNode	The component's VNode.

Returns

void

Inherited from

DisplayComponent.onAfterRender

Defined in

src/sdk/components/FSComponent.ts:87

---

onBeforeRender

▸ onBeforeRender(): void

A callback that is called before the component is rendered.

Returns

void

Inherited from

DisplayComponent.onBeforeRender

Defined in

src/sdk/components/FSComponent.ts:80

---

onClose

▸ onClose(): void

Responds to when this view is closed.

Returns

void

Defined in

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

---

onOcclusionChange

▸ onOcclusionChange(occlusionType): void

Responds to when the occlusion type applied to this view changes while this view is open.

Parameters

Name	Type	Description
occlusionType	UiViewOcclusionType	The new occlusion type applied to this view.

Returns

void

Defined in

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

---

onOpen

▸ onOpen(sizeMode, dimensions): void

Responds to when this view is opened.

Parameters

Name	Type	Description
sizeMode	UiViewSizeMode	The new size mode of this view's container.
dimensions	Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>	The new dimensions of this view's container, as [width, height] in pixels.

Returns

void

Defined in

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

---

onPause

▸ onPause(): void

Responds to when this view is paused.

Returns

void

Defined in

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

---

onResize

▸ onResize(sizeMode, dimensions): void

Responds when this view's container is resized while it is open.

Parameters

Name	Type	Description
sizeMode	UiViewSizeMode	The new size mode of this view's container.
dimensions	Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>	The new dimensions of this view's container, as [width, height] in pixels.

Returns

void

Defined in

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

---

onResume

▸ onResume(): void

Responds to when this view is resumed.

Returns

void

Defined in

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

---

onUiInteractionEvent

▸ onUiInteractionEvent(event): boolean

Handles a UiInteractionEvent.

Parameters

Name	Type	Description
event	UiInteractionEvent	The event to handle.

Returns

boolean

Whether the event was handled.

Inherited from

UiInteractionHandler.onUiInteractionEvent

Defined in

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

---

onUpdate

▸ onUpdate(time): void

Called every update cycle.

Parameters

Name	Type	Description
time	number	The current real (operating system) time, as a Javascript timestamp.

Returns

void

Defined in

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

---

render

▸ render(): null | VNode

Renders the component.

Returns

null | VNode

A JSX element to be rendered.

Inherited from

DisplayComponent.render

Defined in

src/sdk/components/FSComponent.ts:93