Graflume · Alpha

Flow

Compare flows between sources and targets through link width.

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.

Basic example · Row data
`source`ordinal	`value`quantitative	`target`ordinal
Collected	86	Validated
Collected	14	Review queue
Validated	58	Aggregated
Validated	28	Exploration
Aggregated	36	Reports
Aggregated	22	Alerts
Exploration	18	Models
Exploration	10	Exports

Compare flows between sources and targets through link width.

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

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.

Header · Row data
`source`ordinal	`value`quantitative	`target`ordinal
Collected	86	Validated
Collected	14	Review queue
Validated	58	Aggregated
Validated	28	Exploration
Aggregated	36	Reports
Aggregated	22	Alerts
Exploration	18	Models
Exploration	10	Exports

Add a chart title and supporting description inside the visualization.

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"
  }
}

Reveal exact values from a mark or axis position. Authors can choose locale-aware date/time styles and a time zone with declarative options.

StatusLoading

tooltip

Graflume.sankey() Canvas 2D

Control help

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.

Tooltip · Row data
`source`ordinal	`value`quantitative	`target`ordinal
Collected	86	Validated
Collected	14	Review queue
Validated	58	Aggregated
Validated	28	Exploration
Aggregated	36	Reports
Aggregated	22	Alerts
Exploration	18	Models
Exploration	10	Exports

Reveal exact values from a mark or axis position. Authors can choose locale-aware date/time styles and a time zone with declarative options.

Browser API · Portable schema

Browser API

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,
  "interaction": {
    "hover": true,
    "tooltip": {
      "fields": [
        {
          "field": "source",
          "format": "auto",
          "label": "Source"
        },
        {
          "field": "value",
          "format": "number",
          "label": "Value"
        },
        {
          "field": "target",
          "format": "auto",
          "label": "Target"
        }
      ],
      "title": "Flow · Tooltip",
      "trigger": "mark"
    }
  },
  "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

{
  "axes": {
    "x": false,
    "y": false
  },
  "height": 620,
  "interaction": {
    "hover": true,
    "tooltip": {
      "fields": [
        {
          "field": "source",
          "format": "auto",
          "label": "Source"
        },
        {
          "field": "value",
          "format": "number",
          "label": "Value"
        },
        {
          "field": "target",
          "format": "auto",
          "label": "Target"
        }
      ],
      "title": "Flow · Tooltip",
      "trigger": "mark"
    }
  },
  "locale": "en",
  "mark": {
    "fields": {
      "target": "target"
    }
  },
  "width": "container",
  "x": {
    "field": "source",
    "title": "Pipeline stage",
    "type": "ordinal"
  },
  "y": {
    "field": "value",
    "title": "Records",
    "type": "quantitative"
  }
}

Theme

Apply the current built-in theme from the selector and update every active example together.

StatusLoading

theme

Graflume.sankey() Canvas 2D

Control help

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.

Theme · Row data
`source`ordinal	`value`quantitative	`target`ordinal
Collected	86	Validated
Collected	14	Review queue
Validated	58	Aggregated
Validated	28	Exploration
Aggregated	36	Reports
Aggregated	22	Alerts
Exploration	18	Models
Exploration	10	Exports

Apply the current built-in theme from the selector and update every active example together.

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"
    }
  },
  "theme": "graflume-light",
  "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"
    }
  },
  "theme": "graflume-light",
  "width": "container",
  "x": {
    "field": "source",
    "title": "Pipeline stage",
    "type": "ordinal"
  },
  "y": {
    "field": "value",
    "title": "Records",
    "type": "quantitative"
  }
}

Legend

Explain the visual meaning of layers, categories, or continuous values.

StatusLoading

legend

Legend: legend · explicit · 2 channels

Graflume.sankey() Canvas 2D

Control help

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.

Legend · Row data
`source`ordinal	`value`quantitative	`target`ordinal
Collected	86	Validated
Collected	14	Review queue
Validated	58	Aggregated
Validated	28	Exploration
Aggregated	36	Reports
Aggregated	22	Alerts
Exploration	18	Models
Exploration	10	Exports

Explain the visual meaning of layers, categories, or continuous values.

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,
  "legend": {
    "interactive": false,
    "items": [
      {
        "id": "semantic-0",
        "label": "Nodes"
      },
      {
        "id": "semantic-1",
        "label": "Flow"
      }
    ],
    "labels": {
      "hide": "Hide",
      "show": "Show"
    },
    "maxItems": 8,
    "mode": "layers",
    "orientation": "horizontal",
    "position": "bottom",
    "title": "Flow · Legend",
    "visible": true
  },
  "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,
  "legend": {
    "interactive": false,
    "items": [
      {
        "id": "semantic-0",
        "label": "Nodes"
      },
      {
        "id": "semantic-1",
        "label": "Flow"
      }
    ],
    "labels": {
      "hide": "Hide",
      "show": "Show"
    },
    "maxItems": 8,
    "mode": "layers",
    "orientation": "horizontal",
    "position": "bottom",
    "title": "Flow · Legend",
    "visible": true
  },
  "locale": "en",
  "mark": {
    "fields": {
      "target": "target"
    }
  },
  "width": "container",
  "x": {
    "field": "source",
    "title": "Pipeline stage",
    "type": "ordinal"
  },
  "y": {
    "field": "value",
    "title": "Records",
    "type": "quantitative"
  }
}

Highlight

Emphasize a representative datum or spatial position to guide inspection.

StatusLoading

highlight

Point and range highlights: highlights[] · datum · target

Graflume.sankey() Canvas 2D

Control help

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.

Highlight · Row data
`source`ordinal	`value`quantitative	`target`ordinal
Collected	86	Validated
Collected	14	Review queue
Validated	58	Aggregated
Validated	28	Exploration
Aggregated	36	Reports
Aggregated	22	Alerts
Exploration	18	Models
Exploration	10	Exports

Emphasize a representative datum or spatial position to guide inspection.

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,
  "highlights": [
    {
      "id": "manual-focus",
      "padding": 7,
      "target": {
        "field": "target",
        "type": "datum",
        "value": "Reports"
      }
    }
  ],
  "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,
  "highlights": [
    {
      "id": "manual-focus",
      "padding": 7,
      "target": {
        "field": "target",
        "type": "datum",
        "value": "Reports"
      }
    }
  ],
  "locale": "en",
  "mark": {
    "fields": {
      "target": "target"
    }
  },
  "width": "container",
  "x": {
    "field": "source",
    "title": "Pipeline stage",
    "type": "ordinal"
  },
  "y": {
    "field": "value",
    "title": "Records",
    "type": "quantitative"
  }
}

Callout

Show an explanatory callout with automatic collision avoidance and multilingual wrapping.

StatusLoading

callout

Custom callouts: annotations[] · datum · target · callout · placement:auto

Graflume.sankey() Canvas 2D

Control help

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.

Callout · Row data
`source`ordinal	`value`quantitative	`target`ordinal
Collected	86	Validated
Collected	14	Review queue
Validated	58	Aggregated
Validated	28	Exploration
Aggregated	36	Reports
Aggregated	22	Alerts
Exploration	18	Models
Exploration	10	Exports

Show an explanatory callout with automatic collision avoidance and multilingual wrapping.

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 = {
  "annotations": [
    {
      "connector": {
        "visible": true
      },
      "detail": "Attach user-authored safe text to a datum, axis range, or normalized plot position.",
      "id": "manual-callout",
      "placement": "auto",
      "style": {
        "maxWidth": 220,
        "padding": 8
      },
      "target": {
        "field": "target",
        "type": "datum",
        "value": "Reports"
      },
      "text": "Point and range highlights · Aggregated"
    }
  ],
  "axes": {
    "x": false,
    "y": false
  },
  "height": 620,
  "interaction": {
    "controls": {
      "annotations": 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"
      }
    }
  },
  "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

{
  "annotations": [
    {
      "connector": {
        "visible": true
      },
      "detail": "Attach user-authored safe text to a datum, axis range, or normalized plot position.",
      "id": "manual-callout",
      "placement": "auto",
      "style": {
        "maxWidth": 220,
        "padding": 8
      },
      "target": {
        "field": "target",
        "type": "datum",
        "value": "Reports"
      },
      "text": "Point and range highlights · Aggregated"
    }
  ],
  "axes": {
    "x": false,
    "y": false
  },
  "height": 620,
  "interaction": {
    "controls": {
      "annotations": 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"
      }
    }
  },
  "locale": "en",
  "mark": {
    "fields": {
      "target": "target"
    }
  },
  "width": "container",
  "x": {
    "field": "source",
    "title": "Pipeline stage",
    "type": "ordinal"
  },
  "y": {
    "field": "value",
    "title": "Records",
    "type": "quantitative"
  }
}

Selection

Select and toggle data, then clear it from the background or Escape key.

StatusLoading

selection

Interactive selection: selection · multiple · toggle

Graflume.sankey() Canvas 2D

Control help

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.

Selection · Row data
`source`ordinal	`value`quantitative	`target`ordinal
Collected	86	Validated
Collected	14	Review queue
Validated	58	Aggregated
Validated	28	Exploration
Aggregated	36	Reports
Aggregated	22	Alerts
Exploration	18	Models
Exploration	10	Exports

Select and toggle data, then clear it from the background or Escape key.

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,
  "interaction": {
    "selection": {
      "ariaLabel": "Interactive selection",
      "clearOnBackground": true,
      "clearOnEscape": true,
      "highlight": {
        "padding": 5
      },
      "key": "target",
      "mode": "multiple",
      "toggle": true
    }
  },
  "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,
  "interaction": {
    "selection": {
      "ariaLabel": "Interactive selection",
      "clearOnBackground": true,
      "clearOnEscape": true,
      "highlight": {
        "padding": 5
      },
      "key": "target",
      "mode": "multiple",
      "toggle": true
    }
  },
  "locale": "en",
  "mark": {
    "fields": {
      "target": "target"
    }
  },
  "width": "container",
  "x": {
    "field": "source",
    "title": "Pipeline stage",
    "type": "ordinal"
  },
  "y": {
    "field": "value",
    "title": "Records",
    "type": "quantitative"
  }
}

View controls

Show or hide zoom, pan, reset, projection, fullscreen, and PNG export one menu at a time. Set controls: false to remove the entire toolbar.

StatusLoading

controls

Graflume.sankey() Canvas 2D

Control help

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.

View controls · Row data
`source`ordinal	`value`quantitative	`target`ordinal
Collected	86	Validated
Collected	14	Review queue
Validated	58	Aggregated
Validated	28	Exploration
Aggregated	36	Reports
Aggregated	22	Alerts
Exploration	18	Models
Exploration	10	Exports

Show or hide zoom, pan, reset, projection, fullscreen, and PNG export one menu at a time. Set controls: false to remove the entire toolbar.

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,
  "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
    },
    "navigation": {
      "drag": true,
      "keyboard": true,
      "maxZoom": 6,
      "minZoom": 1,
      "pinch": true,
      "wheel": "modifier"
    }
  },
  "locale": "en",
  "mark": {
    "fields": {
      "target": "target"
    }
  },
  "padding": {
    "top": 52
  },
  "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,
  "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
    },
    "navigation": {
      "drag": true,
      "keyboard": true,
      "maxZoom": 6,
      "minZoom": 1,
      "pinch": true,
      "wheel": "modifier"
    }
  },
  "locale": "en",
  "mark": {
    "fields": {
      "target": "target"
    }
  },
  "padding": {
    "top": 52
  },
  "width": "container",
  "x": {
    "field": "source",
    "title": "Pipeline stage",
    "type": "ordinal"
  },
  "y": {
    "field": "value",
    "title": "Records",
    "type": "quantitative"
  }
}

Accessibility

Pair ARIA descriptions and keyboard guidance with a semantic data table.

StatusLoading

accessibility

Graflume.sankey() Canvas 2D

Control help

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.

Accessibility · Row data
`source`ordinal	`value`quantitative	`target`ordinal
Collected	86	Validated
Collected	14	Review queue
Validated	58	Aggregated
Validated	28	Exploration
Aggregated	36	Reports
Aggregated	22	Alerts
Exploration	18	Models
Exploration	10	Exports

Pair ARIA descriptions and keyboard guidance with a semantic data table.

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 · Accessibility example"
  },
  "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

{
  "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 · Accessibility example"
  },
  "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"
  }
}

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

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.

Sankey diagram · Row data
`source`ordinal	`value`quantitative	`target`ordinal
Collected	86	Validated
Collected	14	Review queue
Validated	58	Aggregated
Validated	28	Exploration
Aggregated	36	Reports
Aggregated	22	Alerts
Exploration	18	Models
Exploration	10	Exports

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

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"
  }
}

Edge cases

Numeric range, irregular structure, and data volume

Exercise numeric range, sparse structure, and large inputs with valid data. Each tab materializes data only when needed and never silently repairs invalid values.

Wide numeric range

Mix zero, very small finite values, and very large finite values to verify automatic domains, precision, and stable geometry. NaN and Infinity remain intentionally invalid. It applies 2 data-integrity rules that preserve finite values and axis domains.

StatusLoading

extreme-range
extreme-small
extreme-large
zero
budget:marks<=6

Graflume.sankey() Canvas 2D

Control help

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.

Wide numeric range · Row data
`source`ordinal	`value`quantitative	`target`ordinal
Collected	1e-09	Validated
Collected	0	Review queue
Validated	1e+12	Aggregated
Validated	1	Exploration
Aggregated	1e+06	Reports
Aggregated	1e-06	Alerts

Browser API · Portable schema

Browser API

Graflume.sankey()

const data = [
  {
    "source": "Collected",
    "target": "Validated",
    "value": 1e-9
  },
  {
    "source": "Collected",
    "target": "Review queue",
    "value": 0
  },
  {
    "source": "Validated",
    "target": "Aggregated",
    "value": 1000000000000
  },
  {
    "source": "Validated",
    "target": "Exploration",
    "value": 1
  },
  {
    "source": "Aggregated",
    "target": "Reports",
    "value": 1000000
  },
  {
    "source": "Aggregated",
    "target": "Alerts",
    "value": 0.000001
  }
];

const options = {
  "accessibility": {
    "description": "Validated data branches into reports, alerts, models, and exports. The example uses curated, deterministic data and exposes its exact values in a semantic table.",
    "label": "Flow"
  },
  "axes": {
    "x": false,
    "y": false
  },
  "height": 620,
  "locale": "en",
  "mark": {
    "fields": {
      "target": "target"
    }
  },
  "title": {
    "subtitle": "edge case · range",
    "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": "Validated data branches into reports, alerts, models, and exports. The example uses curated, deterministic data and exposes its exact values in a semantic table.",
    "label": "Flow"
  },
  "axes": {
    "x": false,
    "y": false
  },
  "height": 620,
  "locale": "en",
  "mark": {
    "fields": {
      "target": "target"
    }
  },
  "title": {
    "subtitle": "edge case · range",
    "text": "Flow"
  },
  "width": "container",
  "x": {
    "field": "source",
    "title": "Pipeline stage",
    "type": "ordinal"
  },
  "y": {
    "field": "value",
    "title": "Records",
    "type": "quantitative"
  }
}

Sparse and irregular structure

Exercise only duplicate, missing, sparse, or out-of-order structures whose meaning is defined for this family. Broken references and malformed tuples are never disguised as successful examples. It applies 3 structural rules that preserve the meaning of missing, duplicate, and ordered values.

StatusLoading

irregular-structure
duplicate-edge
out-of-order
disconnected
budget:marks<=7

Graflume.sankey() Canvas 2D

Control help

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.

Sparse and irregular structure · Row data
`source`ordinal	`value`quantitative	`target`ordinal
Validated	58	Aggregated
Collected	86	Validated
Validated	58	Aggregated
Validated	28	Exploration
Aggregated	36	Reports
Aggregated	22	Alerts
Collected	14	Review queue

Browser API · Portable schema

Browser API

Graflume.sankey()

const data = [
  {
    "source": "Validated",
    "target": "Aggregated",
    "value": 58
  },
  {
    "source": "Collected",
    "target": "Validated",
    "value": 86
  },
  {
    "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": "Collected",
    "target": "Review queue",
    "value": 14
  }
];

const options = {
  "accessibility": {
    "description": "Validated data branches into reports, alerts, models, and exports. The example uses curated, deterministic data and exposes its exact values in a semantic table.",
    "label": "Flow · Sparse and irregular structure"
  },
  "axes": {
    "x": false,
    "y": false
  },
  "height": 620,
  "locale": "en",
  "mark": {
    "fields": {
      "target": "target"
    }
  },
  "title": {
    "subtitle": "edge case · structure",
    "text": "Flow · Sparse and irregular structure"
  },
  "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": "Validated data branches into reports, alerts, models, and exports. The example uses curated, deterministic data and exposes its exact values in a semantic table.",
    "label": "Flow · Sparse and irregular structure"
  },
  "axes": {
    "x": false,
    "y": false
  },
  "height": 620,
  "locale": "en",
  "mark": {
    "fields": {
      "target": "target"
    }
  },
  "title": {
    "subtitle": "edge case · structure",
    "text": "Flow · Sparse and irregular structure"
  },
  "width": "container",
  "x": {
    "field": "source",
    "title": "Pipeline stage",
    "type": "ordinal"
  },
  "y": {
    "field": "value",
    "title": "Records",
    "type": "quantitative"
  }
}

High data volume

Materialize a deterministic compact recipe only when this tab opens. Graflume's performance profile bounds mark count, hit testing, and animation work for the input size. It applies 6 high-volume rules for deterministic generation and bounded output. This family materializes 60,000 logical edges and bounds rendered bar marks at 5,000.

StatusLoading

high-row-cardinality
all-input-rows-generated
all-input-rows-processed
deterministic-generation
bounded-rendering
input:60000
zoom-pan-reset
budget:bar-marks<=5000

Legend: legend · explicit · 2 channels
Point and range highlights: highlights[] · datum · source
Custom callouts: annotations[] · datum · source · callout · placement:auto

Graflume.sankey() Canvas 2D

Control help

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.

Browser API · Portable schema

Browser API

Graflume.sankey()

const recipe = {
  "cardinality": {
    "axes": {},
    "sourceRows": 60000,
    "unit": "edges"
  },
  "expectedInvariants": [
    "finite-json",
    "edge-weight-nonnegative",
    "acyclic-flow"
  ],
  "id": "relationship-edges",
  "initialView": {
    "kind": "domain",
    "zoom": 1
  },
  "outputBudget": {
    "maximum": 5000,
    "resource": "bar-marks"
  },
  "parameters": {
    "explicitPerformance": true,
    "family": "flow",
    "nullableFields": [],
    "positiveFields": [],
    "scenario": "volume",
    "topology": "directed-acyclic",
    "valueFields": [
      "value"
    ],
    "valuePolicy": "nonnegative"
  },
  "preview": {
    "maximumRows": 12,
    "method": "top-groups"
  },
  "reduction": {
    "method": "community-edge-aggregation",
    "stage": "pre-aggregate"
  },
  "seed": 3870236279,
  "shape": "rows",
  "version": 2
};
const { data, previewRows, plan } = Graflume.materializeDemoRecipe(recipe);

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 · High data volume"
  },
  "annotations": [
    {
      "connector": {
        "visible": true
      },
      "detail": "Attach user-authored safe text to a datum, axis range, or normalized plot position.",
      "id": "manual-callout",
      "placement": "auto",
      "style": {
        "maxWidth": 220,
        "padding": 8
      },
      "target": {
        "field": "source",
        "type": "datum",
        "value": "Collection"
      },
      "text": "Point and range highlights · Collection"
    }
  ],
  "axes": {
    "x": false,
    "y": false
  },
  "create": {
    "adaptive": {
      "environment": {
        "rowCount": 60000
      },
      "largeDataNavigation": true,
      "profiles": "auto"
    }
  },
  "height": 620,
  "highlights": [
    {
      "id": "manual-focus",
      "padding": 7,
      "target": {
        "field": "source",
        "type": "datum",
        "value": "Collection"
      }
    }
  ],
  "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 · High data volume",
      "trigger": "mark"
    }
  },
  "legend": {
    "interactive": false,
    "items": [
      {
        "id": "semantic-0",
        "label": "Nodes"
      },
      {
        "id": "semantic-1",
        "label": "Flow"
      }
    ],
    "labels": {
      "hide": "Hide",
      "show": "Show"
    },
    "maxItems": 8,
    "mode": "layers",
    "orientation": "horizontal",
    "position": "bottom",
    "title": "Flow · High data volume",
    "visible": true
  },
  "locale": "en",
  "mark": {
    "fields": {
      "target": "target"
    }
  },
  "padding": {
    "top": 52
  },
  "performance": "ultra",
  "theme": "graflume-light",
  "title": {
    "subtitle": "Validated data branches into reports, alerts, models, and exports · 60,000 logical rows, screen-aware detail",
    "text": "Flow · High data volume"
  },
  "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 · High data volume"
  },
  "annotations": [
    {
      "connector": {
        "visible": true
      },
      "detail": "Attach user-authored safe text to a datum, axis range, or normalized plot position.",
      "id": "manual-callout",
      "placement": "auto",
      "style": {
        "maxWidth": 220,
        "padding": 8
      },
      "target": {
        "field": "source",
        "type": "datum",
        "value": "Collection"
      },
      "text": "Point and range highlights · Collection"
    }
  ],
  "axes": {
    "x": false,
    "y": false
  },
  "create": {
    "adaptive": {
      "environment": {
        "rowCount": 60000
      },
      "largeDataNavigation": true,
      "profiles": "auto"
    }
  },
  "height": 620,
  "highlights": [
    {
      "id": "manual-focus",
      "padding": 7,
      "target": {
        "field": "source",
        "type": "datum",
        "value": "Collection"
      }
    }
  ],
  "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 · High data volume",
      "trigger": "mark"
    }
  },
  "legend": {
    "interactive": false,
    "items": [
      {
        "id": "semantic-0",
        "label": "Nodes"
      },
      {
        "id": "semantic-1",
        "label": "Flow"
      }
    ],
    "labels": {
      "hide": "Hide",
      "show": "Show"
    },
    "maxItems": 8,
    "mode": "layers",
    "orientation": "horizontal",
    "position": "bottom",
    "title": "Flow · High data volume",
    "visible": true
  },
  "locale": "en",
  "mark": {
    "fields": {
      "target": "target"
    }
  },
  "padding": {
    "top": 52
  },
  "performance": "ultra",
  "theme": "graflume-light",
  "title": {
    "subtitle": "Validated data branches into reports, alerts, models, and exports · 60,000 logical rows, screen-aware detail",
    "text": "Flow · High data volume"
  },
  "width": "container",
  "x": {
    "field": "source",
    "title": "Pipeline stage",
    "type": "ordinal"
  },
  "y": {
    "field": "value",
    "title": "Records",
    "type": "quantitative"
  }
}

Extreme environments

Reconfigure for display, input, and device capability

Combine container size, input method, display capability, and user preference instead of guessing a device name. Compare mobile, watch, e-paper, monochrome, dot-matrix, and standards-based extreme environments on the same chart.

Fluid responsive

Reflow axes, legends, descriptions, and controls from the available container size.

960×540 · adaptive.profiles=responsive-fluid

zoom-reflow
shape-rectangle
display-color
input-fine
motion-full
renderer-canvas-spatial

Mobile

Prioritize 44px touch targets, tap tooltips, and collapsed secondary information on a narrow portrait screen.

390×844 · adaptive.profiles=mobile-touch

zoom-reflow
coarse-touch
virtual-keyboard
shape-rectangle
display-color
input-coarse
motion-full
renderer-canvas-spatial

Smartwatch

Keep essential marks, values, and stepped controls on a tiny or round screen, with the remaining detail reflowed below.

184×224 · adaptive.profiles=smartwatch

zoom-reflow
reduced-effects
coarse-touch
low-resource
cutout-round
shape-round
display-color
input-coarse
motion-reduced
renderer-canvas-spatial
viewport-tiny

E-book and e-paper

Prefer stable frames, strong contrast, and the data table for low-refresh e-paper displays.

758×1024 · adaptive.profiles=ebook-paper

print-paged
reduced-effects
low-resource
shape-paged
display-e-ink
input-keyboard
motion-static
renderer-canvas-spatial

Monochrome

Use strokes, markers, patterns, labels, and the table so color is never the only distinction.

640×400 · adaptive.profiles=monochrome

reduced-effects
shape-rectangle
display-monochrome
input-fine
motion-reduced
renderer-canvas-spatial

Dot-matrix display

Reduce decoration and mark density while using strong strokes, integer labels, and stepped zoom on a low-resolution display.

320×240 · adaptive.profiles=dot-matrix

zoom-reflow
reduced-effects
keyboard-switch
low-resource
shape-rectangle
display-grid
input-keyboard
motion-static
renderer-canvas-spatial
viewport-tiny

400% zoom and reflow

Reflow prose to one dimension at the 320 CSS px equivalent while retaining chart-local zoom and pan.

320×480 · adaptive.profiles=zoom-reflow

zoom-reflow
shape-rectangle
display-color
input-fine
motion-full
renderer-canvas-spatial

Foldable dual screen

Keep the chart and explanation in independent viewport segments without crossing the hinge.

720×640 · adaptive.profiles=foldable-dual

foldable-dual
shape-dual
display-color
input-fine
motion-full
renderer-canvas-spatial

TV and remote

Provide strong focus indication and D-pad, Enter, and Escape operation on a hoverless distance display.

1920×1080 · adaptive.profiles=tv-remote

tv-remote
shape-rectangle
display-color
input-remote
motion-full
renderer-canvas-spatial

Print and paged media

Pair a static chart with its description and table, hide controls, and avoid page breaks through the figure.

794×1123 · adaptive.profiles=print-paged

print-paged
shape-paged
display-color
input-fine
motion-static
renderer-canvas-spatial

Forced colors

Honor system colors and borders while retaining patterns, markers, and text as redundant cues.

640×400 · adaptive.profiles=forced-colors

forced-colors
shape-rectangle
display-high-contrast
input-fine
motion-full
renderer-canvas-spatial

Reduced effects

Complete transitions immediately and use opaque surfaces and deferred work to reduce motion and transparency load.

640×400 · adaptive.profiles=reduced-effects

reduced-effects
shape-rectangle
display-color
input-fine
motion-reduced
renderer-canvas-spatial

Coarse touch

Inspect values by tap without hover, keep targets at least 44px, and expose explicit zoom buttons.

390×844 · adaptive.profiles=coarse-touch

coarse-touch
shape-rectangle
display-color
input-coarse
motion-full
renderer-canvas-spatial

Keyboard and switch input

Reach every operation with Tab, arrows, Enter, Space, and Escape, with no drag-only action.

640×400 · adaptive.profiles=keyboard-switch

keyboard-switch
shape-rectangle
display-color
input-keyboard
motion-full
renderer-canvas-spatial

Low resource and slow network

Prefer progressive rendering, sampling, cancellable work, and a static fallback under constrained memory or connectivity.

640×400 · adaptive.profiles=low-resource

low-resource
shape-rectangle
display-color
input-fine
motion-full
renderer-canvas-spatial

RTL document

Follow RTL logical flow for prose and tabs while keeping axes, code, and data identifiers in technical LTR order.

640×400 · adaptive.profiles=rtl

rtl
shape-rectangle
display-color
input-fine
motion-full
renderer-canvas-spatial

Vertical writing

Reflow vertical prose while keeping the chart and technical surfaces in an independent horizontal panel.

640×400 · adaptive.profiles=vertical-writing

vertical-writing
shape-rectangle
display-color
input-fine
motion-full
renderer-canvas-spatial

Ultrawide and projection

Cap chart width instead of stretching indefinitely, using panelization and readable labels on ultrawide or projected surfaces.

1920×720 · adaptive.profiles=ultrawide-projection

ultrawide-projection
shape-rectangle
display-color
input-fine
motion-full
renderer-canvas-spatial

Screen reader and braille

Provide short and long descriptions, a semantic table, and status so Canvas or color is never the sole information path.

640×400 · adaptive.profiles=screenreader-braille

screenreader-braille
shape-nonvisual
display-color
input-nonvisual
motion-full
renderer-canvas-spatial

No scripting

A verified static preview, description, and collapsible row-data table preserve the essential information when scripting is unavailable.

640×400 · adaptive.profiles=no-script

no-script
shape-nonvisual
display-color
input-fine
motion-static
renderer-static-fallback

XR and see-through display

Fall back safely to the ordinary 2D or WebGL panel when XR APIs are absent, duplicating depth cues in text and the table.

640×400 · adaptive.profiles=spatial-xr

spatial-xr
shape-rectangle
display-color
input-fine
motion-full
renderer-canvas-spatial

Cutout and round display

Inset titles, marks, and controls around safe areas and round display bounds so they are not clipped.

184×224 · adaptive.profiles=cutout-round

cutout-round
shape-round
display-color
input-fine
motion-full
renderer-canvas-spatial
viewport-tiny

Virtual keyboard viewport

Reflow focus controls, the chart, and the active explanation when a virtual keyboard reduces the visual viewport.

390×560 · adaptive.profiles=virtual-keyboard

virtual-keyboard
shape-rectangle
display-color
input-fine
motion-full
renderer-canvas-spatial

Extreme environment preview

Choose a profile above to preserve the same data and ChartSpec while reconfiguring the chart for display size, input method, display capability, and user preference.

StatusLoading

adaptive
capability-driven
no-user-agent-branching

Legend: legend · explicit · 2 channels
Point and range highlights: highlights[] · datum · target
Custom callouts: annotations[] · datum · target · callout · placement:auto
Interactive selection: selection · multiple · toggle

Graflume.sankey() Canvas 2D

Control help

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.

Extreme environment preview · Row data
`source`ordinal	`value`quantitative	`target`ordinal
Collected	86	Validated
Collected	14	Review queue
Validated	58	Aggregated
Validated	28	Exploration
Aggregated	36	Reports
Aggregated	22	Alerts
Exploration	18	Models
Exploration	10	Exports

Choose a profile above to preserve the same data and ChartSpec while reconfiguring the chart for display size, input method, display capability, and user preference.

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": "Validated data branches into reports, alerts, models, and exports. The example uses curated, deterministic data and exposes its exact values in a semantic table.",
    "label": "Sankey diagram: Validated data branches into reports, alerts, models, and exports"
  },
  "annotations": [
    {
      "connector": {
        "visible": true
      },
      "detail": "Attach user-authored safe text to a datum, axis range, or normalized plot position.",
      "id": "manual-callout",
      "placement": "auto",
      "style": {
        "maxWidth": 220,
        "padding": 8
      },
      "target": {
        "field": "target",
        "type": "datum",
        "value": "Reports"
      },
      "text": "Point and range highlights · Aggregated"
    }
  ],
  "axes": {
    "x": false,
    "y": false
  },
  "create": {
    "adaptive": {
      "profiles": "auto"
    }
  },
  "height": 620,
  "highlights": [
    {
      "id": "manual-focus",
      "padding": 7,
      "target": {
        "field": "target",
        "type": "datum",
        "value": "Reports"
      }
    }
  ],
  "interaction": {
    "controls": {
      "annotations": true,
      "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"
    },
    "selection": {
      "ariaLabel": "Interactive selection",
      "clearOnBackground": true,
      "clearOnEscape": true,
      "highlight": {
        "padding": 5
      },
      "key": "target",
      "mode": "multiple",
      "toggle": true
    },
    "tooltip": {
      "fields": [
        {
          "field": "source",
          "format": "auto",
          "label": "Source"
        },
        {
          "field": "value",
          "format": "number",
          "label": "Value"
        },
        {
          "field": "target",
          "format": "auto",
          "label": "Target"
        }
      ],
      "title": "Flow",
      "trigger": "mark"
    }
  },
  "legend": {
    "interactive": false,
    "items": [
      {
        "id": "semantic-0",
        "label": "Nodes"
      },
      {
        "id": "semantic-1",
        "label": "Flow"
      }
    ],
    "labels": {
      "hide": "Hide",
      "show": "Show"
    },
    "maxItems": 8,
    "mode": "layers",
    "orientation": "horizontal",
    "position": "bottom",
    "title": "Flow",
    "visible": true
  },
  "locale": "en",
  "mark": {
    "fields": {
      "target": "target"
    }
  },
  "padding": {
    "top": 52
  },
  "theme": "graflume-light",
  "title": {
    "subtitle": "Validated data branches into reports, alerts, models, and exports",
    "text": "Sankey diagram"
  },
  "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": "Validated data branches into reports, alerts, models, and exports. The example uses curated, deterministic data and exposes its exact values in a semantic table.",
    "label": "Sankey diagram: Validated data branches into reports, alerts, models, and exports"
  },
  "annotations": [
    {
      "connector": {
        "visible": true
      },
      "detail": "Attach user-authored safe text to a datum, axis range, or normalized plot position.",
      "id": "manual-callout",
      "placement": "auto",
      "style": {
        "maxWidth": 220,
        "padding": 8
      },
      "target": {
        "field": "target",
        "type": "datum",
        "value": "Reports"
      },
      "text": "Point and range highlights · Aggregated"
    }
  ],
  "axes": {
    "x": false,
    "y": false
  },
  "create": {
    "adaptive": {
      "profiles": "auto"
    }
  },
  "height": 620,
  "highlights": [
    {
      "id": "manual-focus",
      "padding": 7,
      "target": {
        "field": "target",
        "type": "datum",
        "value": "Reports"
      }
    }
  ],
  "interaction": {
    "controls": {
      "annotations": true,
      "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"
    },
    "selection": {
      "ariaLabel": "Interactive selection",
      "clearOnBackground": true,
      "clearOnEscape": true,
      "highlight": {
        "padding": 5
      },
      "key": "target",
      "mode": "multiple",
      "toggle": true
    },
    "tooltip": {
      "fields": [
        {
          "field": "source",
          "format": "auto",
          "label": "Source"
        },
        {
          "field": "value",
          "format": "number",
          "label": "Value"
        },
        {
          "field": "target",
          "format": "auto",
          "label": "Target"
        }
      ],
      "title": "Flow",
      "trigger": "mark"
    }
  },
  "legend": {
    "interactive": false,
    "items": [
      {
        "id": "semantic-0",
        "label": "Nodes"
      },
      {
        "id": "semantic-1",
        "label": "Flow"
      }
    ],
    "labels": {
      "hide": "Hide",
      "show": "Show"
    },
    "maxItems": 8,
    "mode": "layers",
    "orientation": "horizontal",
    "position": "bottom",
    "title": "Flow",
    "visible": true
  },
  "locale": "en",
  "mark": {
    "fields": {
      "target": "target"
    }
  },
  "padding": {
    "top": 52
  },
  "theme": "graflume-light",
  "title": {
    "subtitle": "Validated data branches into reports, alerts, models, and exports",
    "text": "Sankey diagram"
  },
  "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.

Mode / compatibility ID search

1 modes · 1 compatibility identifiers

Flow · supported modes · representative `sankey`
ID	Name	Quick API	mode	mark	renderer
`sankey`	Sankey diagram	`sankey()`	`default`	`sankey`	`canvas`

Flow · compatibility identifiers
Identifier	Canonical mode ID
`sankey`	`sankey`

ChartSpec · SpatialSpec

Legend and emphasis

Identify series, emphasize a datum or range, place a custom callout, and let readers select marks.

Legend: Explain the series and scale represented by each color, line, or symbol inside the chart.
Point and range highlights: Emphasize a datum, value set, axis interval, or plot region without changing source values.
Custom callouts: Attach user-authored safe text to a datum, axis range, or normalized plot position. 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.
Interactive selection: Click a mark to select it, press Escape to clear it, and consume selection state and events in the host application.

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