Usage

SankeyDiagram allows the creation of Sankey diagrams.

Add datasets to the diagram and render. Each dataset is a three element array of the form array{string, string, float}. The elements are: source, target, value.

Example

PHP

echo Mermaid::create(Sankey::class)
  ->withDataset(
      ['Agricultural waste', 'Bio-conversion', 124.729],
      ['Bio-conversion', 'Liquid', 0.597],
      ['Bio-conversion', 'Losses', 26.862],
      ['Bio-conversion', 'Solid', 280.322],
      ['Bio-conversion', 'Gas', 81.144],
      ['Electricity grid', 'Heating and cooling - homes', 113.726],
      ['Electricity grid', 'H2 conversion', 27.14],
      ['Electricity grid', 'Industry', 342.165],
      ['Electricity grid', 'Road transport', 37.797],
      ['Electricity grid', 'Agriculture', 4.412],
      ['Electricity grid', 'Heating and cooling - commercial', 40.858],
      ['Electricity grid', 'Losses', 56.691],
      ['Electricity grid', 'Rail transport', 7.863],
      ['Electricity grid', 'Lighting & appliances - commercial', 90.008],
      ['Electricity grid', 'Lighting & appliances - homes', 93.494],
      ['Geothermal', 'Electricity grid', 7.013],
      ['H2 conversion', 'H2', 20.897],
      ['H2 conversion', 'Losses', 6.242],
      ['H2', 'Road transport', 20.897],
      ['Hydro', 'Electricity grid', 6.995],
      ['Marine algae', 'Bio-conversion', 4.375],
      ['Other waste', 'Bio-conversion', 77.81],
      ['Thermal generation', 'Electricity grid', 525.531],
      ['Thermal generation', 'Losses', 787.129],
      ['Thermal generation', 'District heating', 79.329],
      ['Tidal', 'Electricity grid', 9.452],
      ['UK land based bioenergy', 'Bio-conversion', 182.01],
      ['Wave', 'Electricity grid', 19.013],
      ['Wind', 'Electricity grid', 289.366],
  )
  ->render()
;

Generated Mermaid

<pre class="mermaid">
sankey
  Agricultural waste,Bio-conversion,124.729
  Bio-conversion,Liquid,0.597
  Bio-conversion,Losses,26.862
  Bio-conversion,Solid,280.322
  Bio-conversion,Gas,81.144
  Electricity grid,Heating and cooling - homes,113.726
  Electricity grid,H2 conversion,27.14
  Electricity grid,Industry,342.165
  Electricity grid,Road transport,37.797
  Electricity grid,Agriculture,4.412
  Electricity grid,Heating and cooling - commercial,40.858
  Electricity grid,Losses,56.691
  Electricity grid,Rail transport,7.863
  Electricity grid,Lighting & appliances - commercial,90.008
  Electricity grid,Lighting & appliances - homes,93.494
  Geothermal,Electricity grid,7.013
  H2 conversion,H2,20.897
  H2 conversion,Losses,6.242
  H2,Road transport,20.897
  Hydro,Electricity grid,6.995
  Marine algae,Bio-conversion,4.375
  Other waste,Bio-conversion,77.81
  Thermal generation,Electricity grid,525.531
  Thermal generation,Losses,787.129
  Thermal generation,District heating,79.329
  Tidal,Electricity grid,9.452
  UK land based bioenergy,Bio-conversion,182.01
  Wave,Electricity grid,19.013
  Wind,Electricity grid,289.366
</pre>

Mermaid Diagram

Note

Best viewed in light mode

        sankey
  Agricultural waste,Bio-conversion,124.729
  Bio-conversion,Liquid,0.597
  Bio-conversion,Losses,26.862
  Bio-conversion,Solid,280.322
  Bio-conversion,Gas,81.144
  Electricity grid,Heating and cooling - homes,113.726
  Electricity grid,H2 conversion,27.14
  Electricity grid,Industry,342.165
  Electricity grid,Road transport,37.797
  Electricity grid,Agriculture,4.412
  Electricity grid,Heating and cooling - commercial,40.858
  Electricity grid,Losses,56.691
  Electricity grid,Rail transport,7.863
  Electricity grid,Lighting & appliances - commercial,90.008
  Electricity grid,Lighting & appliances - homes,93.494
  Geothermal,Electricity grid,7.013
  H2 conversion,H2,20.897
  H2 conversion,Losses,6.242
  H2,Road transport,20.897
  Hydro,Electricity grid,6.995
  Marine algae,Bio-conversion,4.375
  Other waste,Bio-conversion,77.81
  Thermal generation,Electricity grid,525.531
  Thermal generation,Losses,787.129
  Thermal generation,District heating,79.329
  Tidal,Electricity grid,9.452
  UK land based bioenergy,Bio-conversion,182.01
  Wave,Electricity grid,19.013
  Wind,Electricity grid,289.366