@argdown/core
    Preparing search index...

    Interface IProcess

    IProcess objects are IArgdownRequest objects with a mandatory process field. They can not contain processes themselves.

    In all other respects they are identical to IArgdownRequests.

    interface IProcess {
        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: undefined;
        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[]

    A list of processors to be run or a name of a built-in process (like "export-svg").

    processes: undefined

    Processes can currently not contain definitions of other processes

    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