Skip to content

Function: addSankey()

ts
function addSankey(plot, opts): PatchesLayer;

Defined in: charts/sankey.ts:226

Build a Sankey diagram on plot: one node rectangle Patch per node plus one semi-transparent ribbon patch per link (colored from its source node), added as a single PatchesLayer. Node name labels are added as plot annotations unless labels is false.

Parameters

ParameterType
plotPlot
optsSankeyOptions

Returns

PatchesLayer

MIT licensed. WebGL2 required.