Charts · Flows

SankeyChart

Flow bands between layered nodes. Family: Flows · chart 21 of 60.

Visitor flow
flow	value
Search → Visit	48
Social → Visit	27
Email → Visit	15
Visit → Signup	42
Visit → Bounce	48
Signup → Paid	18

Report an issue with this chart

Visitor flow
flow	value
Search → Visit	48
Social → Visit	27
Email → Visit	15
Visit → Signup	42
Visit → Bounce	48
Signup → Paid	18

mode="precision"

Visitor flow
flow	value
Search → Visit	48
Social → Visit	27
Email → Visit	15
Visit → Signup	42
Visit → Bounce	48
Signup → Paid	18

substrate="green"

Visitor flow
flow	value
Search → Visit	48
Social → Visit	27
Email → Visit	15
Visit → Signup	42
Visit → Bounce	48
Signup → Paid	18

ground="cyanotype"

Example

The chart above, in each framework. Pick a framework once and every example on the site follows it.

shell

npm install @silverpoint/react @silverpoint/grounds @silverpoint/fonts

tsx

import '@silverpoint/fonts/fonts.css';
import '@silverpoint/grounds/styles.css';
import { SankeyChart } from '@silverpoint/react/sankey-chart';

const data = [
  { source: 'Search', target: 'Visit', value: 48 },
  { source: 'Social', target: 'Visit', value: 27 },
  { source: 'Email', target: 'Visit', value: 15 },
  { source: 'Visit', target: 'Signup', value: 42 },
  { source: 'Visit', target: 'Bounce', value: 48 },
  { source: 'Signup', target: 'Paid', value: 18 },
];

export default function App() {
  return (
    <div style={{ width: 480 }}>
      <SankeyChart
        data={data}
        sourceKey="source"
        targetKey="target"
        valueKey="value"
        title="Visitor flow"
      />
    </div>
  );
}

shell

npm install @silverpoint/vue @silverpoint/grounds @silverpoint/fonts

vue

<script setup lang="ts">
import '@silverpoint/fonts/fonts.css';
import '@silverpoint/grounds/styles.css';
import { SpSankeyChart } from '@silverpoint/vue/sankey-chart';

const data = [
  { source: 'Search', target: 'Visit', value: 48 },
  { source: 'Social', target: 'Visit', value: 27 },
  { source: 'Email', target: 'Visit', value: 15 },
  { source: 'Visit', target: 'Signup', value: 42 },
  { source: 'Visit', target: 'Bounce', value: 48 },
  { source: 'Signup', target: 'Paid', value: 18 },
];
</script>

<template>
  <div style="width: 480px">
    <SpSankeyChart
      :data="data"
      source-key="source"
      target-key="target"
      value-key="value"
      title="Visitor flow"
    />
  </div>
</template>

shell

npm install @silverpoint/angular @silverpoint/grounds @silverpoint/fonts

// src/styles.css:
//   @import '@silverpoint/fonts/fonts.css';
//   @import '@silverpoint/grounds/styles.css';

import { Component } from '@angular/core';
import { SpSankeyChart } from '@silverpoint/angular/sankey-chart';

@Component({
  selector: 'app-root',
  imports: [SpSankeyChart],
  template: `
    <div style="width: 480px">
      <sp-sankey-chart
        [data]="data"
        sourceKey="source"
        targetKey="target"
        valueKey="value"
        title="Visitor flow"
      />
    </div>
  `,
})
export class App {
  protected readonly data = [
    { source: 'Search', target: 'Visit', value: 48 },
    { source: 'Social', target: 'Visit', value: 27 },
    { source: 'Email', target: 'Visit', value: 15 },
    { source: 'Visit', target: 'Signup', value: 42 },
    { source: 'Visit', target: 'Bounce', value: 48 },
    { source: 'Signup', target: 'Paid', value: 18 },
  ];
}

shell

pip install reflex-silverpoint-react

python

import reflex as rx
from reflex_silverpoint_react import sankey_chart

DATA = [
    {"source": "Search", "target": "Visit", "value": 48},
    {"source": "Social", "target": "Visit", "value": 27},
    {"source": "Email", "target": "Visit", "value": 15},
    {"source": "Visit", "target": "Signup", "value": 42},
    {"source": "Visit", "target": "Bounce", "value": 48},
    {"source": "Signup", "target": "Paid", "value": 18},
]


def index() -> rx.Component:
    return rx.box(
        sankey_chart(
            data=DATA,
            source_key="source",
            target_key="target",
            value_key="value",
            title="Visitor flow",
        ),
        width="480px",
    )


app = rx.App()
app.add_page(index)

Import

Each chart has its own subpath, so a bundle only carries the charts it uses. Every adapter also exports every chart from its barrel.

Framework	Import
React	`import { SankeyChart } from '@silverpoint/react/sankey-chart';`
Vue	`import { SpSankeyChart } from '@silverpoint/vue/sankey-chart';`
Angular	`import { SpSankeyChart } from '@silverpoint/angular/sankey-chart'; // <sp-sankey-chart>`
Reflex	`from reflex_silverpoint_react import sankey_chart`

Props

The props SankeyChart adds to the ones every chart takes. Accessor props (…Key, keys, names) name fields of your rows and are ignored without data.

React / Angular	Vue	Reflex	Type	Description
`sourceKey`	`source-key`	`source_key`	`Accessor<string>`	—
`targetKey`	`target-key`	`target_key`	`Accessor<string>`	—
`valueKey`	`value-key`	`value_key`	`Accessor<number \| null \| undefined>`	—

Common props

Every chart also takes these. Framework conventions: camelCase in React and Angular, kebab-case in Vue templates, snake_case in Reflex. Read more about them.

Show the 22 common props

React / Angular	Vue	Reflex	Type	Description
`data`	`data`	`data`	`readonly Datum[]`	Rows to draw. If omitted, the demo dataset is rendered (REQ-093) and the accessor props (`…_key`, `keys`, `names`) are ignored.
`ground`	`ground`	`ground`	`GroundRef`	Style ground: `silverpoint` or `cyanotype`, or a ground object. Defaults to the app provider's, or `silverpoint`.
`substrate`	`substrate`	`substrate`	`SubstrateName`	Prepared substrate within the ground (REQ-046).
`mode`	`mode`	`mode`	`InkMode`	`ink` by default; `precision` disables inking (REQ-021).
`seed`	`seed`	`seed`	`Seed`	Seed. If omitted, it is derived from `id` stably (REQ-003).
`id`	`id`	`id`	`string`	Stable identifier. If omitted, it is generated deterministically.
`height`	`height`	`height`	`number`	Height of the drawing area in px. Width is the container's unless pinned.
`width`	`width`	`width`	`number`	—
`chrome`	`chrome`	`chrome`	`'card' \| 'bare'`	`card` draws the full frame; `bare` only the drawing area (REQ-095).
`hatchFill`	`hatch-fill`	`hatch_fill`	`'tile' \| 'per-shape'`	How areas are filled (REQ-029).
`title`	`title`	`title`	`string`	—
`badge`	`badge`	`badge`	`string`	—
`value`	`value`	`value`	`string \| number`	—
`unit`	`unit`	`unit`	`string`	—
`footerLeft`	`footer-left`	`footer_left`	`string`	—
`footerRight`	`footer-right`	`footer_right`	`string`	—
`label`	`label`	`label`	`string`	Accessible name. If omitted, it is derived from `title` (REQ-120).
`description`	`description`	`description`	`string`	Long description for screen readers (REQ-120).
`dataTable`	`data-table`	`data_table`	`'visible' \| 'hidden' \| 'none'`	Tabular alternative; `hidden` leaves it for assistive technology only (REQ-121).
`locale`	`locale`	`locale`	`string`	—
`numberFormat`	`number-format`	`number_format`	`Intl.NumberFormatOptions`	—
`className`	`class-name`	`class_name`	`string`	—

Pointer and keyboard exploration are built in. The item under the pointer or focus is reported, and a click, Enter or Space selects it. The item is { seriesKey, index, datum, value, point: { x, y } }.

Framework	Active item	Selection	Custom readout
React	`onActiveChange`	`onSelect`	`tooltip={(item, readout) => …}`
Vue	`@active-change`	`@select`	`<template #tooltip>`
Angular	`(activeChange)`	`(select)`	`<ng-template spTooltip>`
Reflex	`on_active_change`	`on_select`	`tooltip=tooltip_template(…)`

Interaction and readouts →

Report it

Found something wrong with SankeyChart? Open an issue on GitHub — the form comes pre-filled with the chart and the version.

SankeyChart

Example

Import

Props

Common props

Events