Lawtext core references / core/src/node/cst/line / ParagraphItemLine
Class: ParagraphItemLine<TTag>
core/src/node/cst/line.ParagraphItemLine
A first line of a paragraph, item, and subitem. Please see the source code of $paragraphItemLine for the detailed syntax.
Type parameters
| Name | Type |
|---|---|
TTag | extends typeof paragraphItemTags[number] | null = typeof paragraphItemTags[number] | null |
Hierarchy
-
WithControlsLine<PIT>↳
ParagraphItemLine
Table of contents
Constructors
Properties
Accessors
Methods
Constructors
constructor
• new ParagraphItemLine<TTag>(options): ParagraphItemLine<TTag>
Type parameters
| Name | Type |
|---|---|
TTag | extends null | "Paragraph" | "Item" | "Subitem1" | "Subitem2" | "Subitem3" | "Subitem4" | "Subitem5" | "Subitem6" | "Subitem7" | "Subitem8" | "Subitem9" | "Subitem10" = null | "Paragraph" | "Item" | "Subitem1" | "Subitem2" | "Subitem3" | "Subitem4" | "Subitem5" | "Subitem6" | "Subitem7" | "Subitem8" | "Subitem9" | "Subitem10" |
Parameters
| Name | Type |
|---|---|
options | ParagraphItemLineOptions<TTag> |
Returns
ParagraphItemLine<TTag>
Overrides
WithControlsLine<LineType.PIT>.constructor
Defined in
core/src/node/cst/line.ts:489 (opens in a new tab)
Properties
controls
• controls: Controls
Overrides
WithControlsLine.controls
Defined in
core/src/node/cst/line.ts:485 (opens in a new tab)
indentTexts
• indentTexts: string[]
Inherited from
WithControlsLine.indentTexts
Defined in
core/src/node/cst/line.ts:73 (opens in a new tab)
lineEndText
• lineEndText: string
Inherited from
WithControlsLine.lineEndText
Defined in
core/src/node/cst/line.ts:50 (opens in a new tab)
mainTag
• mainTag: TTag
Defined in
core/src/node/cst/line.ts:484 (opens in a new tab)
midSpace
• midSpace: string
Defined in
core/src/node/cst/line.ts:487 (opens in a new tab)
range
• range: null | [start: number, end: number]
Inherited from
WithControlsLine.range
Defined in
core/src/node/cst/line.ts:49 (opens in a new tab)
sentencesArray
• sentencesArray: SentencesArray
Defined in
core/src/node/cst/line.ts:488 (opens in a new tab)
title
• title: string
Defined in
core/src/node/cst/line.ts:486 (opens in a new tab)
type
• type: PIT
Inherited from
WithControlsLine.type
Defined in
core/src/node/cst/line.ts:48 (opens in a new tab)
Accessors
controlsEndPos
• get controlsEndPos(): null | number
Returns
null | number
Inherited from
WithControlsLine.controlsEndPos
Defined in
core/src/node/cst/line.ts:124 (opens in a new tab)
indentsEndPos
• get indentsEndPos(): null | number
Returns
null | number
Inherited from
WithControlsLine.indentsEndPos
Defined in
core/src/node/cst/line.ts:93 (opens in a new tab)
midSpaceRange
• get midSpaceRange(): null | [number, number]
Returns
null | [number, number]
Defined in
core/src/node/cst/line.ts:503 (opens in a new tab)
sentencesArrayRange
• get sentencesArrayRange(): null | [number, number]
Returns
null | [number, number]
Defined in
core/src/node/cst/line.ts:508 (opens in a new tab)
titleRange
• get titleRange(): null | [number, number]
Returns
null | [number, number]
Defined in
core/src/node/cst/line.ts:499 (opens in a new tab)
Methods
controlsRangeTexts
▸ controlsRangeTexts(): [range: null | [start: number, end: number], text: string, description: string][]
Returns
[range: null | [start: number, end: number], text: string, description: string][]
Inherited from
WithControlsLine.controlsRangeTexts
Defined in
core/src/node/cst/line.ts:116 (opens in a new tab)
indentRangeTexts
▸ indentRangeTexts(): [range: null | [start: number, end: number], text: string, description: string][]
Returns
[range: null | [start: number, end: number], text: string, description: string][]
Inherited from
WithControlsLine.indentRangeTexts
Defined in
core/src/node/cst/line.ts:80 (opens in a new tab)
lineEndTextRange
▸ lineEndTextRange(): null | [start: number, end: number]
Returns
null | [start: number, end: number]
Inherited from
WithControlsLine.lineEndTextRange
Defined in
core/src/node/cst/line.ts:62 (opens in a new tab)
rangeTexts
▸ rangeTexts(): [range: null | [start: number, end: number], text: string, description: string][]
Returns
[range: null | [start: number, end: number], text: string, description: string][]
Overrides
WithControlsLine.rangeTexts
Defined in
core/src/node/cst/line.ts:523 (opens in a new tab)
text
▸ text(): string
Returns
string
Inherited from
WithControlsLine.text
Defined in
core/src/node/cst/line.ts:58 (opens in a new tab)
withTag
▸ withTag<TNewTag>(tag): ParagraphItemLine<TNewTag>
Type parameters
| Name | Type |
|---|---|
TNewTag | extends null | "Paragraph" | "Item" | "Subitem1" | "Subitem2" | "Subitem3" | "Subitem4" | "Subitem5" | "Subitem6" | "Subitem7" | "Subitem8" | "Subitem9" | "Subitem10" |
Parameters
| Name | Type |
|---|---|
tag | TNewTag |
Returns
ParagraphItemLine<TNewTag>