Lawtext core references / core/src/parser/std/virtualLine
Module: core/src/parser/std/virtualLine
Table of contents
Enumerations
Interfaces
Type Aliases
Functions
Type Aliases
PhysicalLine
Ƭ PhysicalLine: { line: BlankLine ; type: BNK ; virtualIndentDepth: number ; virtualRange: [start: number, end: number] } | { line: TOCHeadLine ; type: TOC ; virtualIndentDepth: number ; virtualRange: [start: number, end: number] } | { line: ArticleGroupHeadLine ; type: ARG | TAG ; virtualIndentDepth: number ; virtualRange: [start: number, end: number] } | { line: AppdxItemHeadLine ; type: APP ; virtualIndentDepth: number ; virtualRange: [start: number, end: number] } | { line: SupplProvisionHeadLine ; type: SPR | TSP ; virtualIndentDepth: number ; virtualRange: [start: number, end: number] } | { line: SupplProvisionAppdxItemHeadLine ; type: SPA ; virtualIndentDepth: number ; virtualRange: [start: number, end: number] } | { line: ArticleLine ; type: ART ; virtualIndentDepth: number ; virtualRange: [start: number, end: number] } | { line: ParagraphItemLine ; type: PIT ; virtualIndentDepth: number ; virtualRange: [start: number, end: number] } | { line: TableColumnLine ; type: TBL ; virtualIndentDepth: number ; virtualRange: [start: number, end: number] } | { line: OtherLine ; type: OTH | CAP ; virtualIndentDepth: number ; virtualRange: [start: number, end: number] }
Defined in
core/src/parser/std/virtualLine.ts:27 (opens in a new tab)
VirtualLine
Ƭ VirtualLine: PhysicalLine | Indent | Dedent
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.
Defined in
core/src/parser/std/virtualLine.ts:9 (opens in a new tab)
VirtualLineType
Ƭ VirtualLineType: LineType | VirtualOnlyLineType
The identifiers that distinguish the different types of VirtualLine.
Defined in
core/src/parser/std/virtualLine.ts:25 (opens in a new tab)
Functions
isVirtualLine
▸ isVirtualLine(line): line is VirtualLine
Parameters
| Name | Type |
|---|---|
line | VirtualLine | Line |
Returns
line is VirtualLine
Defined in
core/src/parser/std/virtualLine.ts:99 (opens in a new tab)
toVirtualLines
▸ toVirtualLines(lines): VirtualLine[]
The parsing logic that converts a sequence of Lines to VirtualLines.
Parameters
| Name | Type |
|---|---|
lines | Line[] |