:atlas-mermaid/atlas.mermaid/MermaidSpec

MermaidSpec

interface MermaidSpec : AtlasSpec(source)

Properties

abstract val animateLinks: Property<Boolean>

When set to true, all links between modules will have a pretty animation applied to them.

Set a custom layout engine for the diagram. Unset by default, but mermaid will fall back to "dagre". Use MermaidLayoutSpec.properties to set any custom key/value properties. See the Mermaid docs

look

abstract val look: Property<Look>

Also controlled by the atlas.mermaid.chart.look Gradle property. Defaults to unset. See the Mermaid docs

theme

abstract val theme: Property<Theme>

Also controlled by the atlas.mermaid.chart.theme Gradle property. Defaults to unset. See the Mermaid docs

themeVariables

abstract val themeVariables: MermaidThemeVariablesSpec

Configure some global variables to apply to the module diagram itself.

Functions

elk

abstract fun elk(action: Action<ElkLayoutSpec>? = null)

Configure ELK as a layout engine.

layout

abstract fun layout(action: Action<MermaidLayoutSpec>)

themeVariables

abstract fun themeVariables(action: Action<MermaidThemeVariablesSpec>)