Untitled object in Mermaid Config Schema β
https://mermaid.js.org/schemas/config.schema.json#/properties/elk
Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
---|---|---|---|---|---|---|---|
Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | config.schema.json* |
elk Type β
object
(Details)
elk Properties β
Property | Type | Required | Nullable | Defined by |
---|---|---|---|---|
mergeEdges | boolean | Optional | cannot be null | Mermaid Config |
nodePlacementStrategy | string | Optional | cannot be null | Mermaid Config |
cycleBreakingStrategy | string | Optional | cannot be null | Mermaid 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
is optional
Type:
boolean
cannot be null
defined in: Mermaid Config
mergeEdges Type β
boolean
nodePlacementStrategy β
Elk specific option affecting how nodes are placed.
nodePlacementStrategy
is optional
Type:
string
cannot be null
defined in: Mermaid Config
nodePlacementStrategy Type β
string
nodePlacementStrategy Constraints β
enum: the value of this property must be equal to one of the following values:
Value | Explanation |
---|---|
"SIMPLE" | |
"NETWORK_SIMPLEX" | |
"LINEAR_SEGMENTS" | |
"BRANDES_KOEPF" |
nodePlacementStrategy Default Value β
The default value is:
"BRANDES_KOEPF"
cycleBreakingStrategy β
This strategy decides how to find cycles in the graph and deciding which edges need adjustment to break loops.
cycleBreakingStrategy
is optional
Type:
string
cannot be null
defined in: Mermaid Config
cycleBreakingStrategy Type β
string
cycleBreakingStrategy Constraints β
enum: the value of this property must be equal to one of the following values:
Value | Explanation |
---|---|
"GREEDY" | |
"DEPTH_FIRST" | |
"INTERACTIVE" | |
"MODEL_ORDER" | |
"GREEDY_MODEL_ORDER" |
cycleBreakingStrategy Default Value β
The default value is:
"GREEDY_MODEL_ORDER"