Class: ProcedurePreviewPaneView

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/ProcedurePreviewPane/ProcedurePreviewPaneView.tsx:55

A display pane view which displays a procedure preview.

Extends

• DisplayPaneView<ProcedurePreviewPaneViewProps, DisplayPaneViewEvent<ProcedurePreviewPaneViewEventTypes>>

Constructors

Constructor

new ProcedurePreviewPaneView(props): ProcedurePreviewPaneView

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

Creates an instance of a DisplayComponent.

Parameters

Parameter	Type	Description
props	ProcedurePreviewPaneViewProps	The propertis of the component.

Returns

ProcedurePreviewPaneView

Inherited from

DisplayPaneView.constructor

Properties

_title

protected readonly _title: Subject<string | VNode>

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPaneView.ts:21

Inherited from

DisplayPaneView._title

---

context?

optional context: [] = undefined

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

The context on this component, if any.

Inherited from

DisplayPaneView.context

---

contextType?

readonly optional contextType: readonly [] = undefined

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

The type of context for this component, if any.

Inherited from

DisplayPaneView.contextType

---

isPfd

readonly isPfd: boolean

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPaneView.ts:25

Inherited from

DisplayPaneView.isPfd

---

props

props: ProcedurePreviewPaneViewProps & ComponentProps

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

The properties of the component.

Inherited from

DisplayPaneView.props

---

title

readonly title: Subscribable<string | VNode>

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPaneView.ts:23

The title of this display pane view.

Inherited from

DisplayPaneView.title

Methods

destroy()

destroy(): void

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/ProcedurePreviewPane/ProcedurePreviewPaneView.tsx:394

Destroys this component.

Returns

void

Overrides

DisplayPaneView.destroy

---

getContext()

protected getContext(context): never

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

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

DisplayPaneView.getContext

---

onAfterRender()

onAfterRender(): void

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/ProcedurePreviewPane/ProcedurePreviewPaneView.tsx:157

A callback that is called after the component is rendered.

Returns

void

Overrides

DisplayPaneView.onAfterRender

---

onBeforeRender()

onBeforeRender(): void

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

A callback that is called before the component is rendered.

Returns

void

Inherited from

DisplayPaneView.onBeforeRender

---

onEvent()

onEvent(event): void

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/ProcedurePreviewPane/ProcedurePreviewPaneView.tsx:193

Called when a display pane view event is received by this view.

Parameters

Parameter	Type	Description
event	DisplayPaneViewEvent<ProcedurePreviewPaneViewEventTypes>	The event.

Returns

void

Overrides

DisplayPaneView.onEvent

---

onInteractionEvent()

onInteractionEvent(event): boolean

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/ProcedurePreviewPane/ProcedurePreviewPaneView.tsx:221

Called when this view receives an interaction event.

Parameters

Parameter	Type	Description
event	string	The interaction event.

Returns

boolean

Whether the interaction event was handled.

Overrides

DisplayPaneView.onInteractionEvent

---

onPause()

onPause(): void

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/ProcedurePreviewPane/ProcedurePreviewPaneView.tsx:170

Called when this view is hidden.

Returns

void

Overrides

DisplayPaneView.onPause

---

onResize()

onResize(size, width, height): void

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/ProcedurePreviewPane/ProcedurePreviewPaneView.tsx:178

Called when this view's parent pane is resized while this view is visible.

Parameters

Parameter	Type	Description
size	DisplayPaneSizeMode	The size of this view's parent pane.
width	number	The width of this view's parent pane, in pixels.
height	number	The height of this view's parent pane, in pixels.

Returns

void

Overrides

DisplayPaneView.onResize

---

onResume()

onResume(size, width, height): void

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/ProcedurePreviewPane/ProcedurePreviewPaneView.tsx:162

Called when this view is made visible.

Parameters

Parameter	Type	Description
size	DisplayPaneSizeMode	The size of this view's parent pane.
width	number	The width of this view's parent pane, in pixels.
height	number	The height of this view's parent pane, in pixels.

Returns

void

Overrides

DisplayPaneView.onResume

---

onUpdate()

onUpdate(time): void

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/ProcedurePreviewPane/ProcedurePreviewPaneView.tsx:183

Called every update cycle.

Parameters

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

Returns

void

Overrides

DisplayPaneView.onUpdate

---

render()

render(): VNode | null

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/ProcedurePreviewPane/ProcedurePreviewPaneView.tsx:387

Renders the component.

Returns

VNode | null

A JSX element to be rendered.

Overrides

DisplayPaneView.render