Package-level declarations

Types

enum ConsiderModelOrder : StringEnum, Enum<ConsiderModelOrder>

Preserves the order of nodes and edges in the model file if this does not lead to additional edge crossings. Depending on the strategy this is not always possible since the node and edge order might be conflicting. Default value is NodesAndEdges. See the Mermaid docs

CycleBreakingStrategy

enum CycleBreakingStrategy : StringEnum, Enum<CycleBreakingStrategy>

This strategy decides how to find cycles in the graph and deciding which edges need adjustment to break loops. Default value is GreedyModelOrder. See the Mermaid docs

ElkLayoutSpec

interface ElkLayoutSpec : MermaidLayoutSpec

Configures the ELK layout engine in Mermaid.

LinkStyle

enum LinkStyle : LinkStyle, Enum<LinkStyle>

Default is Basic. See the Mermaid docs

Look

enum Look : StringEnum, Enum<Look>

Defaults to Classic. See the Mermaid docs

MermaidAtlasExtension

interface MermaidAtlasExtension : AtlasExtension

MermaidAtlasPlugin

class MermaidAtlasPlugin : AtlasPlugin

MermaidConfig

@Serializable

class MermaidConfig(val displayLinkLabels: Boolean? = null, val layout: String? = null, val layoutProperties: Map<String, String>? = null, val themeVariables: Map<String, String>? = null, val look: Look? = null, val theme: Theme? = null, val animateLinks: Boolean? = null) : Serializable

Used to configure the atlas.mermaid.tasks.WriteMermaidChart tasks.

MermaidLayoutSpec

interface MermaidLayoutSpec : PropertiesSpec

Supports future layout engine configurations. Currently only supports ElkLayoutSpec.

MermaidLinkTypeSpec

interface MermaidLinkTypeSpec : LinkTypeSpec, PropertiesSpec

https://mermaid.js.org/syntax/flowchart.html#links-between-nodes

MermaidModuleTypeSpec

interface MermaidModuleTypeSpec : ModuleTypeSpec

From the Mermaid docs. Atlas won't validate any of these values, so you need to make sure they're in the right format. E.g. strokeDashArray as an array of integers like "5 5", strokeWidth as a pixel size ("5px") or an integer ("5"). See the above link for the expected formats.

MermaidNamedLinkTypeContainer

interface MermaidNamedLinkTypeContainer : NamedLinkTypeContainer<MermaidLinkTypeSpec>

MermaidNamedModuleTypeContainer

interface MermaidNamedModuleTypeContainer : NamedModuleTypeContainer<MermaidModuleTypeSpec>

MermaidSpec

interface MermaidSpec : AtlasSpec

MermaidThemeVariablesSpec

interface MermaidThemeVariablesSpec : PropertiesSpec

Global diagram configuration properties.

NodePlacementStrategy

enum NodePlacementStrategy : StringEnum, Enum<NodePlacementStrategy>

ElkLayoutSpec-specific option affecting how nodes are placed. Default value is BrandesKoepf. See the Mermaid docs

Theme

enum Theme : StringEnum, Enum<Theme>

See the Mermaid docs