Graflume · Alpha

Flow · Chart-specific features

Compare flows between sources and targets through link width. These tabs come from Graflume's public catalog. Every mode owns runnable data, options, a Quick API, and source-backed feature claims.

Chart family · Default families

Flow

Compare flows between sources and targets through link width.

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

Chart-specific features

Every executable mode in this family

These tabs come from Graflume's public catalog. Every mode owns runnable data, options, a Quick API, and source-backed feature claims.

Sankey diagram

Sankey diagram uses runnable data and options to demonstrate two-column weighted Sankey; interactive links.

StatusLoading

  • sankey
  • two-column weighted Sankey
  • interactive links
  • multi-stage graph model
  • alignment/order/sort/iterations
  • cycles and balance validation
  • node drag and path traversal
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 = {
  "accessibility": {
    "description": "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.",
    "label": "Flow example"
  },
  "axes": {
    "x": false,
    "y": false
  },
  "height": 620,
  "interaction": {
    "controls": {
      "annotations": false,
      "export": true,
      "fullscreen": true,
      "labels": {
        "controls": "Chart controls",
        "enterFullscreen": "Enter fullscreen",
        "exitFullscreen": "Exit fullscreen",
        "exportPng": "Download PNG",
        "hideAnnotations": "Hide callouts",
        "loop": "Loop playback",
        "nextFrame": "Next frame",
        "pause": "Pause",
        "play": "Play",
        "previousFrame": "Previous frame",
        "reset": "Reset view",
        "seek": "Playback position",
        "showAnnotations": "Show callouts",
        "speed": "Playback speed",
        "zoomIn": "Zoom in",
        "zoomOut": "Zoom out"
      },
      "playback": false,
      "reset": true,
      "zoom": true
    },
    "hover": true,
    "navigation": {
      "drag": true,
      "keyboard": true,
      "maxZoom": 6,
      "minZoom": 1,
      "pinch": true,
      "wheel": "modifier"
    },
    "tooltip": {
      "fields": [
        {
          "field": "source",
          "format": "auto",
          "label": "Source"
        },
        {
          "field": "value",
          "format": "number",
          "label": "Value"
        },
        {
          "field": "target",
          "format": "auto",
          "label": "Target"
        }
      ],
      "title": "Flow",
      "trigger": "mark"
    }
  },
  "locale": "en",
  "mark": {
    "fields": {
      "target": "target"
    }
  },
  "padding": {
    "top": 52
  },
  "theme": "graflume-light",
  "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

{
  "accessibility": {
    "description": "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.",
    "label": "Flow example"
  },
  "axes": {
    "x": false,
    "y": false
  },
  "height": 620,
  "interaction": {
    "controls": {
      "annotations": false,
      "export": true,
      "fullscreen": true,
      "labels": {
        "controls": "Chart controls",
        "enterFullscreen": "Enter fullscreen",
        "exitFullscreen": "Exit fullscreen",
        "exportPng": "Download PNG",
        "hideAnnotations": "Hide callouts",
        "loop": "Loop playback",
        "nextFrame": "Next frame",
        "pause": "Pause",
        "play": "Play",
        "previousFrame": "Previous frame",
        "reset": "Reset view",
        "seek": "Playback position",
        "showAnnotations": "Show callouts",
        "speed": "Playback speed",
        "zoomIn": "Zoom in",
        "zoomOut": "Zoom out"
      },
      "playback": false,
      "reset": true,
      "zoom": true
    },
    "hover": true,
    "navigation": {
      "drag": true,
      "keyboard": true,
      "maxZoom": 6,
      "minZoom": 1,
      "pinch": true,
      "wheel": "modifier"
    },
    "tooltip": {
      "fields": [
        {
          "field": "source",
          "format": "auto",
          "label": "Source"
        },
        {
          "field": "value",
          "format": "number",
          "label": "Value"
        },
        {
          "field": "target",
          "format": "auto",
          "label": "Target"
        }
      ],
      "title": "Flow",
      "trigger": "mark"
    }
  },
  "locale": "en",
  "mark": {
    "fields": {
      "target": "target"
    }
  },
  "padding": {
    "top": 52
  },
  "theme": "graflume-light",
  "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"
  }
}

Catalog

Modes · compatibility identifiers

The source-controlled catalog maps callable modes in this family and compatibility identifiers to their canonical modes. This table contains executable entries only.

1 modes · 1 compatibility identifiers

Flow · supported modes · representative sankey
IDNameQuick APImodemarkrenderer
sankeySankey diagramsankey()defaultsankeycanvas
Flow · compatibility identifiers
IdentifierCanonical mode ID
sankeysankey

Manual

Integration checklist

ARIA · table fallback

Accessibility

Canvas ARIA metadata is paired with a text summary and table fallback.

standard · large · ultra

Performance

Standard, large, and ultra profiles bound rendering work.

Chart catalog