Class ColorPlugin

Colorizes arguments and equivalence classes.

if IColorSettings.ignoreColorData is false, it first looks for the color defined in the elements YAML data.
takes the color from [[IColorSettings.statmentColors]] or IColorSettings.argumentColors if one was defined for this element.
if IColorSettings.colorizeByTag is true, it finally gives the element the color that corresponds to the [[IArgdownResponse.tagColors]] index of the elements first tag.

Hierarchy

ColorPlugin

Implements

IArgdownPlugin

Index

Constructors

constructor

Properties

Methods

getSettings

Constructors

constructor

new ColorPlugin(config?: IColorSettings): ColorPlugin

- Defined in src/plugins/ColorPlugin.ts:126
Parameters
- Optional config: IColorSettings
Returns ColorPlugin

Properties

defaults

defaults: IColorSettings

name

name: string = "ColorPlugin"

The name of the plugin

run

run: IRequestHandler = ...

Use this method to do the main work outside of the Argdown AST. This is the last method to be called by the ArgdownApplication.

Methods

getSettings

getSettings(request: IArgdownRequest): IColorSettings

- Defined in src/plugins/ColorPlugin.ts:129
Parameters
- request: IArgdownRequest
Returns IColorSettings

Generated using TypeDoc