Skip to content

Function: sankeyLayout() ​

ts
function sankeyLayout(nodeCount, input, options): SankeyGraph;

Experimental

Lay out a sankey (see the module comment). links refer to node indices 0 … nodeCount − 1; links whose value is not positive, or whose ends are not nodes, must be filtered by the caller.

Parameters ​

ParameterType
nodeCountnumber
inputreadonly SankeyLinkInput[]
optionsSankeyLayoutOptions

Returns ​

SankeyGraph

Released under the MIT License.