Sankey Diagram Config Schema β
https://mermaid.js.org/schemas/config.schema.json#/$defs/SankeyDiagramConfig
The object containing configurations specific for sankey diagrams.
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* |
SankeyDiagramConfig Type β
object
(Sankey Diagram Config)
all of
SankeyDiagramConfig Properties β
Property | Type | Required | Nullable | Defined by |
---|---|---|---|---|
width | number | Optional | cannot be null | Mermaid Config |
height | number | Optional | cannot be null | Mermaid Config |
linkColor | Merged | Optional | cannot be null | Mermaid Config |
nodeAlignment | string | Optional | cannot be null | Mermaid Config |
useMaxWidth | boolean | Optional | cannot be null | Mermaid Config |
showValues | boolean | Optional | cannot be null | Mermaid Config |
prefix | string | Optional | cannot be null | Mermaid Config |
suffix | string | Optional | cannot be null | Mermaid Config |
width β
width
is optional
Type:
number
cannot be null
defined in: Mermaid Config
width Type β
number
width Default Value β
The default value is:
600
height β
height
is optional
Type:
number
cannot be null
defined in: Mermaid Config
height Type β
number
height Default Value β
The default value is:
400
linkColor β
The color of the links in the sankey diagram.
linkColor
is optional
Type: merged type (Details)
cannot be null
defined in: Mermaid Config
linkColor Type β
merged type (Details)
any of
linkColor Default Value β
The default value is:
"gradient"
nodeAlignment β
Controls the alignment of the Sankey diagrams.
See https://github.com/d3/d3-sankey#alignments.
nodeAlignment
is optional
Type:
string
cannot be null
defined in: Mermaid Config
nodeAlignment Type β
string
nodeAlignment Constraints β
enum: the value of this property must be equal to one of the following values:
Value | Explanation |
---|---|
"left" | Align all inputs to the left. |
"right" | Align all outputs to the right. |
"center" | Like `left`, except that nodes without any incoming links are moved as right as possible. |
"justify" | Like `left`, except that nodes without any outgoing links are moved to the far right. |
nodeAlignment Default Value β
The default value is:
"justify"
useMaxWidth β
useMaxWidth
is optional
Type:
boolean
cannot be null
defined in: Mermaid Config
useMaxWidth Type β
boolean
showValues β
Toggle to display or hide values along with title.
showValues
is optional
Type:
boolean
cannot be null
defined in: Mermaid Config
showValues Type β
boolean
showValues Default Value β
The default value is:
true
prefix β
The prefix to use for values
prefix
is optional
Type:
string
cannot be null
defined in: Mermaid Config
prefix Type β
string
suffix β
The suffix to use for values
suffix
is optional
Type:
string
cannot be null
defined in: Mermaid Config
suffix Type β
string