Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ISection

A section in an Argdown document. Sections can contain other sections as children. They are derived from headings and used to derive groups (clusters) in argument maps.

Hierarchy

Index

Properties

children

children: ISection[]

Optional color

color: undefined | string

Optional data

data: any

Optional endColumn

endColumn: undefined | number

Optional endLine

endLine: undefined | number

Optional endOffset

endOffset: undefined | number

Optional fontColor

fontColor: undefined | string

Optional heading

heading: IRuleNode

id

id: string

An automatically generated id unique among sections

Optional isClosed

isClosed: undefined | false | true

Optional isGroup

isGroup: undefined | false | true

Should this section be used as a group in the argument map?

If isGroup is undefined, the section will be used as a group if level > maxLevel - groupDepth.

level

level: number

Optional parent

parent: ISection

Optional ranges

ranges: IRange[]

Optional startColumn

startColumn: undefined | number

Optional startLine

startLine: undefined | number

Optional startOffset

startOffset: undefined | number

Optional tags

tags: string[]

Optional text

text: undefined | string

Optional title

title: undefined | string

type

type: SECTION

Generated using TypeDoc