Skip to main content

Class: ChecklistTextItem

Defined in: workingtitle-instruments-epic2/instruments/html_ui/Pages/VCockpit/Instruments/NavSystems/Epic2v2/MFD/LowerMFD/Components/SystemConfigWindow/Checklist/ChecklistTextItem.tsx:16

An Epic 2 checklist item

Extends​

Constructors​

Constructor​

new ChecklistTextItem(props): ChecklistTextItem

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

Creates an instance of a DisplayComponent.

Parameters​

ParameterTypeDescription
propsChecklistTextItemPropsThe propertis of the component.

Returns​

ChecklistTextItem

Inherited from​

ChecklistItemBase.constructor

Properties​

baseRef​

protected readonly baseRef: NodeReference<HTMLDivElement>

Defined in: workingtitle-instruments-epic2/instruments/html_ui/Pages/VCockpit/Instruments/NavSystems/Epic2v2/MFD/LowerMFD/Components/SystemConfigWindow/Checklist/ChecklistItemBase.tsx:19

Inherited from​

ChecklistItemBase.baseRef


context?​

optional context: [] = undefined

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

The context on this component, if any.

Inherited from​

ChecklistItemBase.context


contextType?​

readonly optional contextType: readonly [] = undefined

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

The type of context for this component, if any.

Inherited from​

ChecklistItemBase.contextType


props​

props: ChecklistTextItemProps & ComponentProps

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

The properties of the component.

Inherited from​

ChecklistItemBase.props


textRows​

readonly textRows: string[]

Defined in: workingtitle-instruments-epic2/instruments/html_ui/Pages/VCockpit/Instruments/NavSystems/Epic2v2/MFD/LowerMFD/Components/SystemConfigWindow/Checklist/ChecklistTextItem.tsx:17

Overrides​

ChecklistItemBase.textRows


MAX_CHARACTERS_PER_ROW​

static MAX_CHARACTERS_PER_ROW: number = 18

Defined in: workingtitle-instruments-epic2/instruments/html_ui/Pages/VCockpit/Instruments/NavSystems/Epic2v2/MFD/LowerMFD/Components/SystemConfigWindow/Checklist/ChecklistItemBase.tsx:16

Inherited from​

ChecklistItemBase.MAX_CHARACTERS_PER_ROW

Methods​

destroy()​

destroy(): void

Defined in: sdk/components/FSComponent.ts:101

Destroys this component.

Returns​

void

Inherited from​

ChecklistItemBase.destroy


getContext()​

protected getContext(context): never

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

Gets a context data subscription from the context collection.

Parameters​

ParameterTypeDescription
contextneverThe 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​

ChecklistItemBase.getContext


onAfterRender()​

onAfterRender(node): void

Defined in: sdk/components/FSComponent.ts:90

A callback that is called after the component is rendered.

Parameters​

ParameterTypeDescription
nodeVNodeThe component's VNode.

Returns​

void

Inherited from​

ChecklistItemBase.onAfterRender


onBeforeRender()​

onBeforeRender(): void

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

A callback that is called before the component is rendered.

Returns​

void

Inherited from​

ChecklistItemBase.onBeforeRender


render()​

render(): VNode

Defined in: workingtitle-instruments-epic2/instruments/html_ui/Pages/VCockpit/Instruments/NavSystems/Epic2v2/MFD/LowerMFD/Components/SystemConfigWindow/Checklist/ChecklistTextItem.tsx:20

Renders the component.

Returns​

VNode

A JSX element to be rendered.

Overrides​

ChecklistItemBase.render


setLastItemOnPage()​

setLastItemOnPage(isLast): void

Defined in: workingtitle-instruments-epic2/instruments/html_ui/Pages/VCockpit/Instruments/NavSystems/Epic2v2/MFD/LowerMFD/Components/SystemConfigWindow/Checklist/ChecklistItemBase.tsx:61

Sets whether this item is the last item on the page

Parameters​

ParameterTypeDescription
isLastbooleanIs it the last item?

Returns​

void

Inherited from​

ChecklistItemBase.setLastItemOnPage


splitStringToRows()​

static splitStringToRows(input): string[]

Defined in: workingtitle-instruments-epic2/instruments/html_ui/Pages/VCockpit/Instruments/NavSystems/Epic2v2/MFD/LowerMFD/Components/SystemConfigWindow/Checklist/ChecklistItemBase.tsx:29

When given an input string, it will split the string into 18 character rows. Splitting at the last space, hyphen or slash before the character limit.

Parameters​

ParameterTypeDescription
inputstringThe input string

Returns​

string[]

An array of strings that don't breach the 18 character limit.

Inherited from​

ChecklistItemBase.splitStringToRows