Lawtext core references / core/src/node/cst/line / TOCHeadLine
Class: TOCHeadLine
Defined in: core/src/node/cst/line.ts:165 (opens in a new tab)
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
Defined in: core/src/node/cst/line.ts:167 (opens in a new tab)
Parameters
options
TOCHeadLineOptions
Returns
Overrides
WithControlsLine<LineType.TOC>.constructor
Properties
controls
controls:
Controls
Defined in: core/src/node/cst/line.ts:109 (opens in a new tab)
Inherited from
WithControlsLine.controls
indentTexts
indentTexts:
string[]
Defined in: core/src/node/cst/line.ts:73 (opens in a new tab)
Inherited from
WithControlsLine.indentTexts
lineEndText
lineEndText:
string
Defined in: core/src/node/cst/line.ts:50 (opens in a new tab)
Inherited from
WithControlsLine.lineEndText
range
range:
null| [number,number]
Defined in: core/src/node/cst/line.ts:49 (opens in a new tab)
Inherited from
WithControlsLine.range
title
title:
string
Defined in: core/src/node/cst/line.ts:166 (opens in a new tab)
type
type:
TOC
Defined in: core/src/node/cst/line.ts:48 (opens in a new tab)
Inherited from
WithControlsLine.type
Accessors
controlsEndPos
Get Signature
get controlsEndPos():
null|number
Defined in: core/src/node/cst/line.ts:124 (opens in a new tab)
Returns
null | number
Inherited from
WithControlsLine.controlsEndPos
indentsEndPos
Get Signature
get indentsEndPos():
null|number
Defined in: core/src/node/cst/line.ts:93 (opens in a new tab)
Returns
null | number
Inherited from
WithControlsLine.indentsEndPos
titleRange
Get Signature
get titleRange():
null| [number,number]
Defined in: core/src/node/cst/line.ts:173 (opens in a new tab)
Returns
null | [number, number]
Methods
controlsRangeTexts()
controlsRangeTexts(): [
null| [number,number],string,string][]
Defined in: core/src/node/cst/line.ts:116 (opens in a new tab)
Returns
[null | [number, number], string, string][]
Inherited from
WithControlsLine.controlsRangeTexts
indentRangeTexts()
indentRangeTexts(): [
null| [number,number],string,string][]
Defined in: core/src/node/cst/line.ts:80 (opens in a new tab)
Returns
[null | [number, number], string, string][]
Inherited from
WithControlsLine.indentRangeTexts
lineEndTextRange()
lineEndTextRange():
null| [number,number]
Defined in: core/src/node/cst/line.ts:62 (opens in a new tab)
Returns
null | [number, number]
Inherited from
WithControlsLine.lineEndTextRange
rangeTexts()
rangeTexts(): [
null| [number,number],string,string][]
Defined in: core/src/node/cst/line.ts:184 (opens in a new tab)
Returns
[null | [number, number], string, string][]
Overrides
WithControlsLine.rangeTexts
text()
text():
string
Defined in: core/src/node/cst/line.ts:58 (opens in a new tab)
Returns
string
Inherited from
WithControlsLine.text