ISectionConfig | @argdown/core

Hierarchy

ISection
- ISectionConfig

Index

Properties

arguments
children
color
data
endColumn
endLine
endOffset
fontColor
heading
id
isClosed
isGroup
level
parent
ranges
startColumn
startLine
startOffset
statements
tags
text
title
type

Properties

Optional arguments

arguments: string[]

children

children: ISection[]

Optional color

color: string

Optional data

data: any

Optional endColumn

endColumn: number

Optional endLine

endLine: number

Optional endOffset

endOffset: number

Optional fontColor

fontColor: string

Optional heading

heading: IRuleNode

id

id: string

An automatically generated id unique among sections

Optional isClosed

isClosed: boolean

Optional isGroup

isGroup: boolean

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: number

Optional startLine

startLine: number

Optional startOffset

startOffset: number

Optional statements

statements: string[]

Optional tags

tags: string[]

Optional text

text: string

Optional title

title: string

type

type: SECTION