@argdown/core
    Preparing search index...

    Interface IArgdownResponse

    interface IArgdownResponse {
        arguments?: { [title: string]: IArgument };
        ast?: IAstNode;
        dot?: string;
        exceptions?: Error[];
        frontMatter?: any;
        graphml?: string;
        groupCount?: number;
        highlightedSource?: string;
        html?: string;
        htmlIds?: { [id: string]: boolean } | null;
        json?: string;
        lexerErrors?: ILexingError[];
        map?: IMap;
        maxSectionLevel?: number;
        parserErrors?: IRecognitionException[];
        relations?: IRelation[];
        sections?: ISection[];
        selection?: ISelection;
        statements?: { [title: string]: IEquivalenceClass };
        svg?: string;
        tags?: { [tagName: string]: ITagData };
        tokens?: IToken[];
        webComponent?: string;
    }
    Index

    Properties

    arguments? ast? dot? exceptions? frontMatter? graphml? groupCount? highlightedSource? html? htmlIds? json? lexerErrors? map? maxSectionLevel? parserErrors? relations? sections? selection? statements? svg? tags? tokens? webComponent?

    Properties

    arguments?: { [title: string]: IArgument }

    A dictionary of all arguments defined in the Argdown input. The keys are the argument titles. The values are [[Argument]] objects.

    Provided by the [[ModelPlugin]]

    ast?: IAstNode

    The abstract syntax tree of the Argdown input. The tree consists of [[IRuleNode]] objects for every syntax rule applied. Each [[IRuleNode]] contains other [[IRuleNode]] objects or [[IArgdownToken]] objects as children.

    Plugins can traverse the tree by defining [[IArgdownPlugin.tokenListeners]] and [[IArgdownPlugin.ruleListeners]].

    Provided by the [[ParserPlugin]].

    dot?: string

    Exported dot version of argument map

    Provided by the [[DotExportPlugin]]

    exceptions?: Error[]

    Errors thrown by plugins.

    Provided by any plugin throwing an exception.

    frontMatter?: any

    Front matter meta data provided by the [[DataPlugin]]

    graphml?: string

    Exported dot version of argument map

    Provided by the [[GraphMLExportPlugin]]

    groupCount?: number

    Temporary counter for groups used by the [[DotExportPlugin]]

    highlightedSource?: string

    Highlighted Argdown source code (powered by Prism.js)

    Provided by the [[HighlightSourcePlugin]]

    html?: string

    Exported html

    Provided by the [[HtmlExportPlugin]]

    htmlIds?: { [id: string]: boolean } | null

    Temporary store of ids for the [[HtmlExportPlugin]]

    json?: string

    JSON data

    Provided by the [[JSONExportPlugin]]

    lexerErrors?: ILexingError[]

    Errors thrown by the lexer.

    Provided by the [[ParserPlugin]].

    map?: IMap

    Argument map data provided by the [[MapPlugin]]

    maxSectionLevel?: number
    parserErrors?: IRecognitionException[]

    Errors thrown by the parser.

    Provided by the [[ParserPlugin]].

    relations?: IRelation[]

    A list of all relations defined in the Argdown input.

    Provided by the [[ModelPlugin]]

    sections?: ISection[]

    A tree structure of all sections defined in the Argdown input.

    Provided by the [[ModelPlugin]]

    selection?: ISelection

    Argument map data provided by the [[PreselectionPlugin]] and other plugins providing further selection methods.

    statements?: { [title: string]: IEquivalenceClass }

    A dictionary of all statement equivalence classes defined in the Argdown input. The keys are statement titles. The values are [[EquivalenceClass]] objects.

    The actual [[Statement]] objects are stored in the [[EquivalenceClass.members]] array.

    Provided by the [[ModelPlugin]]

    svg?: string

    Exported svg

    Provided by the [[DotToSvgExportPlugin]]

    tags?: { [tagName: string]: ITagData }

    All tags used augmented by additional data

    Provided by the [[ModelPlugin]]

    Color is provided by the [[ColorPlugin]]

    tokens?: IToken[]

    The list of tokens produced by the Argdown lexer that was used to produce the abstract syntax tree.

    Provided by the [[ParserPlugin]].

    webComponent?: string

    JSON data

    Provided by the [[WebComponentExportPlugin]]

    Settings

    Member Visibility

    On This Page

    Properties