Interface: UiView<P>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiView.ts:24

A view which displays content in a view stack.

Extends

• DisplayComponent<P>.UiInteractionHandler

Type Parameters

Type Parameter	Default type
P extends UiViewProps	UiViewProps

Properties

context?

optional context: [] = undefined

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

The context on this component, if any.

Inherited from

DisplayComponent.context

---

contextType?

readonly optional contextType: readonly [] = undefined

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

The type of context for this component, if any.

Inherited from

DisplayComponent.contextType

---

knobLabelState

readonly knobLabelState: SubscribableMap<UiKnobId, string> & Subscribable<UiKnobRequestedLabelState>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiView.ts:26

The bezel rotary knob label state requested by this view.

---

props

props: P & ComponentProps

Defined in: src/sdk/components/FSComponent.ts:61

The properties of the component.

Inherited from

DisplayComponent.props

Methods

destroy()

destroy(): void

Defined in: src/sdk/components/FSComponent.ts:98

Destroys this component.

Returns

void

Inherited from

DisplayComponent.destroy

---

getContext()

protected getContext(context): never

Defined in: src/sdk/components/FSComponent.ts:106

Gets a context data subscription from the context collection.

Parameters

Parameter	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

---

onAfterRender()

onAfterRender(node): void

Defined in: src/sdk/components/FSComponent.ts:87

A callback that is called after the component is rendered.

Parameters

Parameter	Type	Description
node	VNode	The component's VNode.

Returns

void

Inherited from

DisplayComponent.onAfterRender

---

onBeforeRender()

onBeforeRender(): void

Defined in: src/sdk/components/FSComponent.ts:80

A callback that is called before the component is rendered.

Returns

void

Inherited from

DisplayComponent.onBeforeRender

---

onClose()

onClose(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiView.ts:38

Responds to when this view is closed.

Returns

void

---

onOcclusionChange()

onOcclusionChange(occlusionType): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiView.ts:61

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

Parameters

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

Returns

void

---

onOpen()

onOpen(sizeMode, dimensions): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiView.ts:33

Responds to when this view is opened.

Parameters

Parameter	Type	Description
sizeMode	UiViewSizeMode	The new size mode of this view's container.
dimensions	ReadonlyFloat64Array	The new dimensions of this view's container, as [width, height] in pixels.

Returns

void

---

onPause()

onPause(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiView.ts:48

Responds to when this view is paused.

Returns

void

---

onResize()

onResize(sizeMode, dimensions): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiView.ts:55

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

Parameters

Parameter	Type	Description
sizeMode	UiViewSizeMode	The new size mode of this view's container.
dimensions	ReadonlyFloat64Array	The new dimensions of this view's container, as [width, height] in pixels.

Returns

void

---

onResume()

onResume(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiView.ts:43

Responds to when this view is resumed.

Returns

void

---

onUiInteractionEvent()

onUiInteractionEvent(event): boolean

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiInteraction.ts:90

Handles a UiInteractionEvent.

Parameters

Parameter	Type	Description
event	UiInteractionEvent	The event to handle.

Returns

boolean

Whether the event was handled.

Inherited from

UiInteractionHandler.onUiInteractionEvent

---

onUpdate()

onUpdate(time): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/UiSystem/UiView.ts:67

Called every update cycle.

Parameters

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

Returns

void

---

render()

abstract render(): null | VNode

Defined in: src/sdk/components/FSComponent.ts:93

Renders the component.

Returns

null | VNode

A JSX element to be rendered.

Inherited from

DisplayComponent.render