Lawtext core references

Lawtext core references / core/src/parser/std/virtualLine

core/src/parser/std/virtualLine

Enumerations

VirtualOnlyLineType

Defined in: core/src/parser/std/virtualLine.ts:15 (opens in a new tab)

The type identifiers of VirtualLine that are not included in LineType.

Enumeration Members

CAP

CAP: "CAP"

Defined in: core/src/parser/std/virtualLine.ts:20 (opens in a new tab)

DED

DED: "DED"

Defined in: core/src/parser/std/virtualLine.ts:17 (opens in a new tab)

IND

IND: "IND"

Defined in: core/src/parser/std/virtualLine.ts:16 (opens in a new tab)

TAG

TAG: "TAG"

Defined in: core/src/parser/std/virtualLine.ts:18 (opens in a new tab)

TSP

TSP: "TSP"

Defined in: core/src/parser/std/virtualLine.ts:19 (opens in a new tab)

Interfaces

• Dedent
• Indent

Type Aliases

PhysicalLine

PhysicalLine: { line: BlankLine; type: BNK; virtualIndentDepth: number; virtualRange: [number, number]; } | { line: TOCHeadLine; type: TOC; virtualIndentDepth: number; virtualRange: [number, number]; } | { line: ArticleGroupHeadLine; type: ARG | TAG; virtualIndentDepth: number; virtualRange: [number, number]; } | { line: AppdxItemHeadLine; type: APP; virtualIndentDepth: number; virtualRange: [number, number]; } | { line: SupplProvisionHeadLine; type: SPR | TSP; virtualIndentDepth: number; virtualRange: [number, number]; } | { line: SupplProvisionAppdxItemHeadLine; type: SPA; virtualIndentDepth: number; virtualRange: [number, number]; } | { line: ArticleLine; type: ART; virtualIndentDepth: number; virtualRange: [number, number]; } | { line: ParagraphItemLine; type: PIT; virtualIndentDepth: number; virtualRange: [number, number]; } | { line: TableColumnLine; type: TBL; virtualIndentDepth: number; virtualRange: [number, number]; } | { line: OtherLine; type: OTH | CAP; virtualIndentDepth: number; virtualRange: [number, number]; }

Defined in: core/src/parser/std/virtualLine.ts:28 (opens in a new tab)

VirtualLine

VirtualLine: PhysicalLine | Indent | Dedent

Defined in: core/src/parser/std/virtualLine.ts:10 (opens in a new tab)

The extension of CST with the structure of indent blocks.

A VirtualLine represents either a physical line or indent/dedent in the lawtext. The VirtualLine object has a property named type with the type of VirtualLineType, and the different types of VirtualLine are distinguished by that property.

VirtualLineType

VirtualLineType: LineType | VirtualOnlyLineType

Defined in: core/src/parser/std/virtualLine.ts:26 (opens in a new tab)

The identifiers that distinguish the different types of VirtualLine.

Functions

isVirtualLine()

isVirtualLine(line): line is VirtualLine

Defined in: core/src/parser/std/virtualLine.ts:100 (opens in a new tab)

Parameters

line

VirtualLine | Line

Returns

line is VirtualLine

toVirtualLines()

toVirtualLines(lines): VirtualLine[]

Defined in: core/src/parser/std/virtualLine.ts:111 (opens in a new tab)

The parsing logic that converts a sequence of Lines to VirtualLines.

Parameters

lines

Line[]

Returns

VirtualLine[]