• Public
  • Public/Protected
  • All

Interface IStatement

Each statement represents a paragraph of text in the original Argdown source code. Statements are thus not "propositions" in the philosophical sense or "strings" in the computational sense. Instead they represent string occurrences in a document.

Each statement that is not an argument description, belongs to exactly one IEquivalenceClass, identified by the statement's title. If no title was defined, a title is automatically generated.

If the statement has the role StatementRole.ARGUMENT_DESCRIPTION and the statement's title will refer to an argument instead of an equivalence class. See [[IARgumentDescription]].

Statement and argument references are also stored as IStatement objects. The only differences are that they have no text and that isReference is true.

For further details on the relationship between equivalence classes and statements, see IEquivalenceClass.




Optional data

data: any

Optional endColumn

endColumn: undefined | number

Optional endLine

endLine: undefined | number

Optional endOffset

endOffset: undefined | number

Optional isReference

isReference: undefined | boolean

Optional isTopLevel

isTopLevel: undefined | boolean

Optional ranges

ranges: undefined | IRange[]

Optional role

Optional section

section: undefined | null | ISection

Optional startColumn

startColumn: undefined | number

Optional startLine

startLine: undefined | number

Optional startOffset

startOffset: undefined | number

Optional tags

tags: undefined | string[]

Optional text

text: undefined | string

Optional title

title: undefined | string



Generated using TypeDoc