Skip to Content
LibraryCoreSrcNodeCstLineClassesClass: TOCHeadLine

Lawtext core references


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

Class: TOCHeadLine

Defined in: core/src/node/cst/line.ts:165 

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

Extends

  • WithControlsLine<TOC>

Constructors

Constructor

new TOCHeadLine(options): TOCHeadLine

Defined in: core/src/node/cst/line.ts:167 

Parameters

options

TOCHeadLineOptions

Returns

TOCHeadLine

Overrides

WithControlsLine<LineType.TOC>.constructor

Properties

controls

controls: Controls

Defined in: core/src/node/cst/line.ts:109 

Inherited from

WithControlsLine.controls


indentTexts

indentTexts: string[]

Defined in: core/src/node/cst/line.ts:73 

Inherited from

WithControlsLine.indentTexts


lineEndText

lineEndText: string

Defined in: core/src/node/cst/line.ts:50 

Inherited from

WithControlsLine.lineEndText


range

range: [number, number] | null

Defined in: core/src/node/cst/line.ts:49 

Inherited from

WithControlsLine.range


title

title: string

Defined in: core/src/node/cst/line.ts:166 


type

type: TOC

Defined in: core/src/node/cst/line.ts:48 

Inherited from

WithControlsLine.type

Accessors

controlsEndPos

Get Signature

get controlsEndPos(): number | null

Defined in: core/src/node/cst/line.ts:124 

Returns

number | null

Inherited from

WithControlsLine.controlsEndPos


indentsEndPos

Get Signature

get indentsEndPos(): number | null

Defined in: core/src/node/cst/line.ts:93 

Returns

number | null

Inherited from

WithControlsLine.indentsEndPos


titleRange

Get Signature

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

Defined in: core/src/node/cst/line.ts:173 

Returns

[number, number] | null

Methods

controlsRangeTexts()

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

Defined in: core/src/node/cst/line.ts:116 

Returns

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

Inherited from

WithControlsLine.controlsRangeTexts


indentRangeTexts()

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

Defined in: core/src/node/cst/line.ts:80 

Returns

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

Inherited from

WithControlsLine.indentRangeTexts


lineEndTextRange()

lineEndTextRange(): [number, number] | null

Defined in: core/src/node/cst/line.ts:62 

Returns

[number, number] | null

Inherited from

WithControlsLine.lineEndTextRange


rangeTexts()

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

Defined in: core/src/node/cst/line.ts:184 

Returns

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

Overrides

WithControlsLine.rangeTexts


text()

text(): string

Defined in: core/src/node/cst/line.ts:58 

Returns

string

Inherited from

WithControlsLine.text

© 2017-2026 yamachi