Documentation / @ripl/charts / createSankeyChart

Function: createSankeyChart()

createSankeyChart<TData>(target, options): SankeyChart<TData>

Defined in: charts/src/charts/sankey.ts:774

Factory function that creates a new SankeyChart instance.

Type Parameters

Type Parameter	Default type
TData	unknown

Parameters

Parameter	Type
target	string | HTMLElement | Context<Element, Record<string, unknown>>
options	SankeyChartOptions<TData>

Returns

SankeyChart<TData>

Example

createSankeyChart(target, {
    nodes: [
        { id: 'a', label: 'Source' },
        { id: 'b', label: 'Process' },
        { id: 'c', label: 'Output' },
    ],
    links: [
        { source: 'a', target: 'b', value: 10 },
        { source: 'b', target: 'c', value: 6 },
    ],
});