Library
core
src
node
cst
line
classes
Tocheadline

Lawtext core referencesDocs


Lawtext core references / core/src/node/cst/line / TOCHeadLine

Class: TOCHeadLine

A head line of a TOC (Table Of Contents). Please see the source code of $tocHeadLine for the detailed syntax.

Extends

  • WithControlsLine<TOC>

Constructors

new TOCHeadLine()

new TOCHeadLine(options): TOCHeadLine

Parameters

options: TOCHeadLineOptions

Returns

TOCHeadLine

Overrides

WithControlsLine<LineType.TOC>.constructor

Defined in

core/src/node/cst/line.ts:167 (opens in a new tab)

Properties

controls

controls: Controls

Inherited from

WithControlsLine.controls

Defined in

core/src/node/cst/line.ts:109 (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)


range

range: null | [number, number]

Inherited from

WithControlsLine.range

Defined in

core/src/node/cst/line.ts:49 (opens in a new tab)


title

title: string

Defined in

core/src/node/cst/line.ts:166 (opens in a new tab)


type

type: TOC

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)


titleRange

get titleRange(): null | [number, number]

Returns

null | [number, number]

Defined in

core/src/node/cst/line.ts:173 (opens in a new tab)

Methods

controlsRangeTexts()

controlsRangeTexts(): [null | [number, number], string, string][]

Returns

[null | [number, number], string, string][]

Inherited from

WithControlsLine.controlsRangeTexts

Defined in

core/src/node/cst/line.ts:116 (opens in a new tab)


indentRangeTexts()

indentRangeTexts(): [null | [number, number], string, string][]

Returns

[null | [number, number], string, string][]

Inherited from

WithControlsLine.indentRangeTexts

Defined in

core/src/node/cst/line.ts:80 (opens in a new tab)


lineEndTextRange()

lineEndTextRange(): null | [number, number]

Returns

null | [number, number]

Inherited from

WithControlsLine.lineEndTextRange

Defined in

core/src/node/cst/line.ts:62 (opens in a new tab)


rangeTexts()

rangeTexts(): [null | [number, number], string, string][]

Returns

[null | [number, number], string, string][]

Overrides

WithControlsLine.rangeTexts

Defined in

core/src/node/cst/line.ts:184 (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)