Basic Sankey

Where a household budget goes: income sources into spending categories.

Chart type: Sankey sankey
Tier: Premium
Collection: Sankey
Render: Live, site theme

LIVE/sankey/basic-sankey1 of 23 in Sankey

Open the chart without page chrome ↗Drawing width at least 900 px. Scroll within the chart on smaller screens.

Configuration

const options = {
  chart: {
    height: 420,
    toolbar: {
      show: false
    },
    type: "sankey"
  },
  series: [
    {
      name: "Budget",
      data: [
        ["Salary", "Household", 3900],
        ["Freelance", "Household", 850],
        ["Interest", "Household", 120],
        ["Household", "Housing", 1650],
        ["Household", "Food", 720],
        ["Household", "Transport", 380],
        ["Household", "Savings", 1300],
        ["Household", "Leisure", 520],
        ["Household", "Other", 300]
      ]
    }
  ],
  plotOptions: {
    sankey: {
      labels: {
        valueFormatter: (v) => '€' + v.toLocaleString('en')
      }
    }
  },
  theme: {
    mode: "light",
    preset: "coastal"
  }
}

const chart = new WestCoastCharts(document.querySelector('#chart'), options)
chart.render()

01 · Speccomplete, runnable

import WestCoastCharts from 'west-coast-charts'
import types from 'west-coast-charts/types'
import premium from 'west-coast-charts/premium'

WestCoastCharts.use(types).use(premium)
const WestCoastChartsPremium = premium
WestCoastCharts.setLicenseKey(LICENCE_KEY) // paid production licence; localhost evaluation needs no key

const options = {
  chart: {
    height: 420,
    toolbar: {
      show: false
    },
    type: "sankey"
  },
  series: [
    {
      name: "Budget",
      data: [
        ["Salary", "Household", 3900],
        ["Freelance", "Household", 850],
        ["Interest", "Household", 120],
        ["Household", "Housing", 1650],
        ["Household", "Food", 720],
        ["Household", "Transport", 380],
        ["Household", "Savings", 1300],
        ["Household", "Leisure", 520],
        ["Household", "Other", 300]
      ]
    }
  ],
  plotOptions: {
    sankey: {
      labels: {
        valueFormatter: (v) => '€' + v.toLocaleString('en')
      }
    }
  },
  theme: {
    mode: "light",
    preset: "coastal"
  }
}

const chart = new WestCoastCharts(document.querySelector('#chart'), options)
await chart.render()

02 · Rendered state

Waiting for the chart.

Open Data & agent view to read this chart through chart.describe().

Read from the running library through its optional agent/describe module. Text, table and JSON share the same snapshot. Demo data only.

03 · CLIPublic tools

$ wcc chart export sankey-basic-sankey.json --out sankey-basic-sankey.svg --with-table

Public agent tools 0.2.3, tested with Library 1.1.5; available from the versioned GitHub release and npm. Save a JSON spec first and check the loaded runtime and supported modules before rendering. Command reference

04 · Markdown/gallery/sankey/basic-sankey/index.md

Loading /gallery/sankey/basic-sankey/index.md …

This example uses Premium modules. Compare licences · Embedding in a distributed product?