Features · type

Sankey

native

Flows between nodes with width as value

Matrix status native. Verification types · strong. ChartKit option: ChartKitChartSpecV1.type=sankey.

Source: chartkit:packages/core/src/generated/schema.ts:24

ChartKit spec

Passed validate() during npm run matrix:refresh. The SVG is the server render.

Flow leaves B.Flow leaves B.A → B: 10B → C: 6A: 10AB: 10BC: 6C
{
  "version": "1",
  "type": "sankey",
  "data": [
    {
      "s": "A",
      "t": "B",
      "y": 10
    },
    {
      "s": "B",
      "t": "C",
      "y": 6
    }
  ],
  "encoding": {
    "source": "s",
    "target": "t",
    "y": "y"
  },
  "a11y": {
    "alt": "Flow leaves B."
  },
  "size": {
    "width": 640,
    "height": 260
  }
}

Other libraries

Option names are the paths recorded in the matrix. A grep-only cell names the identifier that matched, not a render test. Markdown copy: type.sankey.md.

LibraryStatusOptionVerificationSource
Chart.jsplugin—npm · weak—
RechartsnativeSankeytypes · strongrecharts/types/chart/Sankey.d.ts:225
Apache EChartsnativeseries.type=sankeytypes · strongecharts/types/dist/shared.d.ts:11176
Highchartsnativeseries.type=sankeytypes · stronghighcharts/options/abands.d.ts:1386
Plotly.jsnativetrace.type=sankeytypes · strongplot-schema.json#traces.sankey
NivonativeSankeytypes · strong@nivo/sankey/dist/types/Sankey.d.ts:3
Victorynone—absence · absence—
visxnativeSankeytypes · strong@visx/sankey/lib/Sankey.d.ts:52
ApexChartsplugin—separate ApexSankey productnpm · weak—
Tremor (npm)none—absence · absence—
Observable Plotmanualgrep: rendermechanism · weak@observablehq/plot/src/scales.d.ts:166
Vega-LitemanualTopLevelSpec.layermechanism · weakvega-lite/build/spec/layer.d.ts:27
AG Chartsnative entseries.type=sankeytypes · strongag-charts-types/dist/types/src/series/cartesian/areaOptions.d.ts:86
amCharts 5nativegrep: Sankeygrep · weak@amcharts/amcharts5/package.json:29
Google ChartsnativeSankeytypes · strong@types/google.visualization/index.d.ts:1783
uPlotnone—absence · absence—
TradingView Lightweight Chartsnone—absence · absence—
MUI X Chartsnative proSankeyCharttypes · strong@mui/x-charts-pro/SankeyChart/SankeyChart.d.mts:31
Mermaid (chart-ish diagrams only)nativeMermaidConfig.sankeytypes · strongmermaid/dist/config.type.d.ts:233
AntV G2nativeMarkTypes=sankeytypes · strong@antv/g2/lib/spec/mark.d.ts:13