Graflume · Alpha

Flow · Basic implementation · Common features

Compare flows between sources and targets through link width. Start with only the required data and family encoding. Expand the code to run the same example. Use the tabs to compare header, tooltip, theme, legend, highlight, callout, selection, view controls, and accessibility one feature at a time.

Chart family · Default families

Flow

Compare flows between sources and targets through link width.

Quick API
sankey()
Browser snapshot
graflume
mark
sankey
Presets
1

Basic implementation

The smallest runnable chart

Start with only the required data and family encoding. Expand the code to run the same example.

Basic example

Compare flows between sources and targets through link width.

StatusLoading

  • minimal-implementation
Graflume.sankey() Canvas 2D
Control help

Zoom and pan inspect the rendered surface without changing data axes or values. When playback controls are available, they move through real steps in the order each unique value first appears in the source data.

Use Tab to reach a control and Enter or Space to activate it. With the chart focused, use plus and minus to zoom and arrow keys to pan.

Auto placement compares perimeter candidates and avoids the plot, legend, and other callouts when possible. Explicit placement is preserved with only necessary safety correction. Callout text wraps safely inside the bubble. Long unbroken tokens are visually shortened within the line budget, while the complete source text remains available to assistive technology.

Loading

Browser API · Portable schema

Browser API

Graflume.sankey()

const data = [
  {
    "source": "Collected",
    "target": "Validated",
    "value": 86
  },
  {
    "source": "Collected",
    "target": "Review queue",
    "value": 14
  },
  {
    "source": "Validated",
    "target": "Aggregated",
    "value": 58
  },
  {
    "source": "Validated",
    "target": "Exploration",
    "value": 28
  },
  {
    "source": "Aggregated",
    "target": "Reports",
    "value": 36
  },
  {
    "source": "Aggregated",
    "target": "Alerts",
    "value": 22
  },
  {
    "source": "Exploration",
    "target": "Models",
    "value": 18
  },
  {
    "source": "Exploration",
    "target": "Exports",
    "value": 10
  }
];

const options = {
  "axes": {
    "x": false,
    "y": false
  },
  "height": 620,
  "locale": "en",
  "mark": {
    "fields": {
      "target": "target"
    }
  },
  "width": "container",
  "x": {
    "field": "source",
    "title": "Pipeline stage",
    "type": "ordinal"
  },
  "y": {
    "field": "value",
    "title": "Records",
    "type": "quantitative"
  }
};

Graflume.sankey('#chart', data, options);

Portable schema

ChartSpec 0.1 · options

{
  "axes": {
    "x": false,
    "y": false
  },
  "height": 620,
  "locale": "en",
  "mark": {
    "fields": {
      "target": "target"
    }
  },
  "width": "container",
  "x": {
    "field": "source",
    "title": "Pipeline stage",
    "type": "ordinal"
  },
  "y": {
    "field": "value",
    "title": "Records",
    "type": "quantitative"
  }
}

Common features

Features shared by every chart

Use the tabs to compare header, tooltip, theme, legend, highlight, callout, selection, view controls, and accessibility one feature at a time. Hover over a data mark. On supported charts, move the pointer along the axis to see the nearest value. All exact values are available in the table below.

Header

Add a chart title and supporting description inside the visualization.

StatusLoading

  • header
Graflume.sankey() Canvas 2D
Control help

Zoom and pan inspect the rendered surface without changing data axes or values. When playback controls are available, they move through real steps in the order each unique value first appears in the source data.

Use Tab to reach a control and Enter or Space to activate it. With the chart focused, use plus and minus to zoom and arrow keys to pan.

Auto placement compares perimeter candidates and avoids the plot, legend, and other callouts when possible. Explicit placement is preserved with only necessary safety correction. Callout text wraps safely inside the bubble. Long unbroken tokens are visually shortened within the line budget, while the complete source text remains available to assistive technology.

Loading

Browser API · Portable schema

Browser API

Graflume.sankey()

const data = [
  {
    "source": "Collected",
    "target": "Validated",
    "value": 86
  },
  {
    "source": "Collected",
    "target": "Review queue",
    "value": 14
  },
  {
    "source": "Validated",
    "target": "Aggregated",
    "value": 58
  },
  {
    "source": "Validated",
    "target": "Exploration",
    "value": 28
  },
  {
    "source": "Aggregated",
    "target": "Reports",
    "value": 36
  },
  {
    "source": "Aggregated",
    "target": "Alerts",
    "value": 22
  },
  {
    "source": "Exploration",
    "target": "Models",
    "value": 18
  },
  {
    "source": "Exploration",
    "target": "Exports",
    "value": 10
  }
];

const options = {
  "axes": {
    "x": false,
    "y": false
  },
  "height": 620,
  "locale": "en",
  "mark": {
    "fields": {
      "target": "target"
    }
  },
  "title": {
    "subtitle": "Sankey diagram uses runnable data and options to demonstrate two-column weighted Sankey; interactive links.",
    "text": "Flow"
  },
  "width": "container",
  "x": {
    "field": "source",
    "title": "Pipeline stage",
    "type": "ordinal"
  },
  "y": {
    "field": "value",
    "title": "Records",
    "type": "quantitative"
  }
};

Graflume.sankey('#chart', data, options);

Portable schema

ChartSpec 0.1 · options

{
  "axes": {
    "x": false,
    "y": false
  },
  "height": 620,
  "locale": "en",
  "mark": {
    "fields": {
      "target": "target"
    }
  },
  "title": {
    "subtitle": "Sankey diagram uses runnable data and options to demonstrate two-column weighted Sankey; interactive links.",
    "text": "Flow"
  },
  "width": "container",
  "x": {
    "field": "source",
    "title": "Pipeline stage",
    "type": "ordinal"
  },
  "y": {
    "field": "value",
    "title": "Records",
    "type": "quantitative"
  }
}
Chart catalog