Class: ChecklistPaneViewItem

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/ChecklistPane/ChecklistPaneViewItemList.tsx:243

A display for a checklist item.

Extends

• DisplayComponent<ChecklistPaneViewItemProps>

Constructors

Constructor

new ChecklistPaneViewItem(props): ChecklistPaneViewItem

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

Creates an instance of a DisplayComponent.

Parameters

Parameter	Type	Description
props	ChecklistPaneViewItemProps	The propertis of the component.

Returns

ChecklistPaneViewItem

Inherited from

DisplayComponent<ChecklistPaneViewItemProps>.constructor

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

---

item

readonly item: GarminChecklistItem

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/ChecklistPane/ChecklistPaneViewItemList.tsx:248

This display's checklist item.

---

props

props: ChecklistPaneViewItemProps & 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/workingtitle-instruments-g3000/html_ui/Shared/Components/ChecklistPane/ChecklistPaneViewItemList.tsx:380

Returns

void

Inherit Doc

Overrides

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

---

getLinkTargetIndexes()

getLinkTargetIndexes(): undefined | readonly [number, number, number]

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/ChecklistPane/ChecklistPaneViewItemList.tsx:283

Gets the indexes of the link target of this display's item.

Returns

undefined | readonly [number, number, number]

The indexes of the link target of this display's item, or undefined if this display's item is not a link item or if the link could not be resolved.

Throws

Error if this display has not been rendered to the DOM.

---

getRootElement()

getRootElement(): HTMLDivElement

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/ChecklistPane/ChecklistPaneViewItemList.tsx:257

Gets this display's root element.

Returns

HTMLDivElement

This display's root element.

Throws

Error if this display has not been rendered to the DOM.

---

isToggleable()

isToggleable(): boolean

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/ChecklistPane/ChecklistPaneViewItemList.tsx:266

Checks whether this display's item has a user-toggleable state.

Returns

boolean

Whether this display's item has a user-toggleable state.

Throws

Error if this display has not been rendered to the DOM.

---

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

---

refreshStyling()

refreshStyling(): void

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/ChecklistPane/ChecklistPaneViewItemList.tsx:306

Applies any currently staged refresh of this display's styling. This method should be called after stageRefreshStyling().

Returns

void

---

render()

render(): VNode

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/ChecklistPane/ChecklistPaneViewItemList.tsx:314

Returns

VNode

Inherit Doc

Overrides

DisplayComponent.render

---

stageRefreshStyling()

stageRefreshStyling(): void

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/ChecklistPane/ChecklistPaneViewItemList.tsx:295

Stages a refresh of this display's styling. This will pre-compute refreshed styles for this display but will not apply the refreshed styles. Calling refreshStyling() after this method will apply the staged refresh. This method should be called whenever the display's width changes.

Returns

void