@argdown/core
    Preparing search index...

    Interface IArgdownRequest

    interface IArgdownRequest {
        abstract?: string;
        author?: string | string[];
        color?: IColorSettings;
        data?: IDataSettings;
        date?: string;
        dot?: IDotSettings;
        graphml?: IGraphMLSettings;
        group?: IGroupSettings;
        html?: IHtmlExportSettings;
        images?: IImagesSettings;
        input?: string;
        json?: IJSONSettings;
        logExceptions?: boolean;
        logger?: IArgdownLogger;
        logLevel?: string;
        map?: IMapSettings;
        model?: IModelPluginSettings;
        parser?: IParserPluginSettings;
        process?: string | string[];
        processes?: { [name: string]: IProcess };
        selection?: ISelectionSettings;
        sourceHighlighter?: IHighlightSourceSettings;
        subTitle?: string;
        throwExceptions?: boolean;
        title?: string;
        vizJs?: IVizSettings;
        webComponent?: IWebComponentExportSettings;
    }

    Hierarchy (View Summary)

    Index

    Properties

    abstract? author? color? data? date? dot? graphml? group? html? images? input? json? logExceptions? logger? logLevel? map? model? parser? process? processes? selection? sourceHighlighter? subTitle? throwExceptions? title? vizJs? webComponent?

    Properties

    abstract?: string
    author?: string | string[]
    color?: IColorSettings

    Settings for colorization

    data?: IDataSettings

    Settings for the [[DataPlugin]]

    date?: string
    dot?: IDotSettings

    Settings for the [[DotExportPlugin]]

    graphml?: IGraphMLSettings

    Settings for the [[GraphMLExportPlugin]]

    group?: IGroupSettings
    html?: IHtmlExportSettings

    Settings for the [[HtmlExportPlugin]]

    images?: IImagesSettings

    Settings for the [[MapPlugin]]

    input?: string

    The Argdown input that should be parsed.

    json?: IJSONSettings

    Settings for the [[JSONExportPlugin]]

    logExceptions?: boolean

    Should exceptions thrown by plugins be logged?

    logger?: IArgdownLogger
    logLevel?: string

    Set to "verbose" to get a lot of infos.

    map?: IMapSettings

    Settings for the [[MapPlugin]]

    model?: IModelPluginSettings

    Settings for the [[ModelPlugin]]

    parser?: IParserPluginSettings

    Settings of the parser plugin. The parser plugin executes parser and lexer.

    process?: string | string[]

    If an array is used: the processors that should be executed in order by the [[ArgdownApplication]] during the current run.

    If a string is used: the name of the process to be found in [[IArgdownRequest.processes]]. ArgdownApplication will then try to run the processors defined in that process.

    processes?: { [name: string]: IProcess }

    A dictionary of processes that can be run by using run({process: "processName", input: ..., processes: ...}).

    Keys are the process names, values are [[IProcess]] objects.

    selection?: ISelectionSettings

    Settings for the [[PreselectionPlugin]]

    sourceHighlighter?: IHighlightSourceSettings

    Settings for the [[WebComponentExportPlugin]]

    subTitle?: string
    throwExceptions?: boolean

    Should the application throw exceptions from plugins?

    title?: string
    vizJs?: IVizSettings

    Settings for any plugin using Viz.js, for example the [[DotToSvgExportPlugin]]

    webComponent?: IWebComponentExportSettings

    Settings for the [[WebComponentExportPlugin]]

    Settings

    Member Visibility

    On This Page

    Properties