• Public
  • Public/Protected
  • All

Interface IArgdownRequest




Optional abstract

abstract: undefined | string

Optional author

author: undefined | string | string[]

Optional color

color: undefined | IColorSettings

Settings for colorization

Optional data

data: undefined | IDataSettings

Settings for the DataPlugin

Optional date

date: undefined | string

Optional dot

dot: undefined | IDotSettings

Settings for the DotExportPlugin

Optional graphml

graphml: undefined | IGraphMLSettings

Settings for the GraphMLExportPlugin

Optional group

group: undefined | IGroupSettings

Optional html

html: undefined | IHtmlExportSettings

Settings for the HtmlExportPlugin

Optional images

images: undefined | IImagesSettings

Settings for the MapPlugin

Optional input

input: undefined | string

The Argdown input that should be parsed.

Optional json

json: undefined | IJSONSettings

Settings for the JSONExportPlugin

Optional logExceptions

logExceptions: undefined | boolean

Should exceptions thrown by plugins be logged?

Optional logLevel

logLevel: undefined | string

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

Optional logger

logger: undefined | IArgdownLogger

Optional map

map: undefined | IMapSettings

Settings for the MapPlugin

Optional model

model: undefined | IModelPluginSettings

Settings for the ModelPlugin

Optional parser

parser: undefined | IParserPluginSettings

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

Optional process

process: undefined | 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.

Optional processes

processes: undefined | {}

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

Keys are the process names, values are IProcess objects.

Optional selection

selection: undefined | ISelectionSettings

Settings for the PreselectionPlugin

Optional sourceHighlighter

sourceHighlighter: undefined | IHighlightSourceSettings

Settings for the WebComponentExportPlugin

Optional subTitle

subTitle: undefined | string

Optional throwExceptions

throwExceptions: undefined | boolean

Should the application throw exceptions from plugins?

Optional title

title: undefined | string

Optional vizJs

vizJs: undefined | IVizJsSettings

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

Optional webComponent

webComponent: undefined | IWebComponentExportSettings

Settings for the WebComponentExportPlugin

Generated using TypeDoc