Skip to content

Untitled object in Mermaid Config Schema ​

txt
https://mermaid.js.org/schemas/config.schema.json#/properties/elk
AbstractExtensibleStatusIdentifiableCustom PropertiesAdditional PropertiesAccess RestrictionsDefined In
Can be instantiatedNoUnknown statusNoForbiddenAllowednoneconfig.schema.json*

elk Type ​

object (Details)

elk Properties ​

PropertyTypeRequiredNullableDefined by
mergeEdgesbooleanOptionalcannot be nullMermaid Config
nodePlacementStrategystringOptionalcannot be nullMermaid Config
cycleBreakingStrategystringOptionalcannot be nullMermaid Config

mergeEdges ​

Elk specific option that allows edges to share path where it convenient. It can make for pretty diagrams but can also make it harder to read the diagram.

mergeEdges

mergeEdges Type ​

boolean

nodePlacementStrategy ​

Elk specific option affecting how nodes are placed.

nodePlacementStrategy

nodePlacementStrategy Type ​

string

nodePlacementStrategy Constraints ​

enum: the value of this property must be equal to one of the following values:

ValueExplanation
"SIMPLE"
"NETWORK_SIMPLEX"
"LINEAR_SEGMENTS"
"BRANDES_KOEPF"

nodePlacementStrategy Default Value ​

The default value is:

json
"BRANDES_KOEPF"

cycleBreakingStrategy ​

This strategy decides how to find cycles in the graph and deciding which edges need adjustment to break loops.

cycleBreakingStrategy

cycleBreakingStrategy Type ​

string

cycleBreakingStrategy Constraints ​

enum: the value of this property must be equal to one of the following values:

ValueExplanation
"GREEDY"
"DEPTH_FIRST"
"INTERACTIVE"
"MODEL_ORDER"
"GREEDY_MODEL_ORDER"

cycleBreakingStrategy Default Value ​

The default value is:

json
"GREEDY_MODEL_ORDER"
Opens in MermaidChart.com