Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ISectionConfig

Hierarchy

Index

Properties

Optional arguments

arguments: undefined | string[]

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: undefined | IRuleNode

id

id: string

An automatically generated id unique among sections

Optional isClosed

isClosed: undefined | boolean

Optional isGroup

isGroup: undefined | 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: undefined | ISection

Optional ranges

ranges: undefined | IRange[]

Optional startColumn

startColumn: undefined | number

Optional startLine

startLine: undefined | number

Optional startOffset

startOffset: undefined | number

Optional statements

statements: undefined | string[]

Optional tags

tags: undefined | string[]

Optional text

text: undefined | string

Optional title

title: undefined | string

type

type: SECTION

Generated using TypeDoc