Class: ChecklistPaneViewItemList
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/ChecklistPane/ChecklistPaneViewItemList.tsx:39
A list that displays checklist items.
Extends
DisplayComponent
<ChecklistPaneViewItemListProps
>
Constructors
Constructor
new ChecklistPaneViewItemList(
props
):ChecklistPaneViewItemList
Defined in: src/sdk/components/FSComponent.ts:73
Creates an instance of a DisplayComponent.
Parameters
Parameter | Type | Description |
---|---|---|
props | ChecklistPaneViewItemListProps | The propertis of the component. |
Returns
ChecklistPaneViewItemList
Inherited from
DisplayComponent<ChecklistPaneViewItemListProps>.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
props
props:
ChecklistPaneViewItemListProps
&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:212
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
getRenderedItem()
getRenderedItem(
index
):undefined
|NodeInstance
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/ChecklistPane/ChecklistPaneViewItemList.tsx:81
Gets the rendered instance of a data item in this list.
Parameters
Parameter | Type | Description |
---|---|---|
index | number | The index of the data item for which to get the rendered instance. |
Returns
undefined
| NodeInstance
The rendered instance of the specified data item, or undefined
if index
is out of bounds.
onAfterRender()
onAfterRender():
void
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/ChecklistPane/ChecklistPaneViewItemList.tsx:63
Returns
void
Inherit Doc
Overrides
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:88
Refreshes this list's styling. This method should be called whenever the list's width or height changes.
Returns
void
render()
render():
VNode
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/ChecklistPane/ChecklistPaneViewItemList.tsx:157
Returns
VNode
Inherit Doc
Overrides
DisplayComponent.render