Class: ChecklistPaneView

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/ChecklistPane/ChecklistPaneView.tsx:36

A display pane view which displays checklists.

Extends

• DisplayPaneView<ChecklistPaneViewProps, DisplayPaneViewEvent<ChecklistPaneViewEventTypes>>

Constructors

Constructor

new ChecklistPaneView(props): ChecklistPaneView

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

Creates an instance of a DisplayComponent.

Parameters

Parameter	Type	Description
props	ChecklistPaneViewProps	The propertis of the component.

Returns

ChecklistPaneView

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:64

The context on this component, if any.

Inherited from

DisplayPaneView.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

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: ChecklistPaneViewProps & ComponentProps

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

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/ChecklistPane/ChecklistPaneView.tsx:580

Destroys this component.

Returns

void

Overrides

DisplayPaneView.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

DisplayPaneView.getContext

---

onAfterRender()

onAfterRender(): void

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/ChecklistPane/ChecklistPaneView.tsx:69

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:80

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/ChecklistPane/ChecklistPaneView.tsx:163

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

Parameters

Parameter	Type	Description
event	DisplayPaneViewEvent<ChecklistPaneViewEventTypes>	The event.

Returns

void

Overrides

DisplayPaneView.onEvent

---

onPause()

onPause(): void

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/ChecklistPane/ChecklistPaneView.tsx:134

Called when this view is hidden.

Returns

void

Overrides

DisplayPaneView.onPause

---

onResize()

onResize(): void

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/ChecklistPane/ChecklistPaneView.tsx:150

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

Returns

void

Overrides

DisplayPaneView.onResize

---

onResume()

onResume(): void

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/ChecklistPane/ChecklistPaneView.tsx:94

Called when this view is made visible.

Returns

void

Overrides

DisplayPaneView.onResume

---

onUpdate()

onUpdate(): void

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/ChecklistPane/ChecklistPaneView.tsx:155

Called every update cycle.

Returns

void

Overrides

DisplayPaneView.onUpdate

---

render()

render(): null | VNode

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/ChecklistPane/ChecklistPaneView.tsx:519

Renders the component.

Returns

null | VNode

A JSX element to be rendered.

Overrides

DisplayPaneView.render