# Chord (Sankey example)

> WestCoast Charts 1.1.5, release, public Core release, on npm. HTML: https://westcoast-charts.com/gallery/sankey/chord/ · Index for agents: https://westcoast-charts.com/llms.txt

Customers switching between plans in a quarter, as a directed chord diagram (the chord type of the premium plugin).

- Chart type: `chord` (Chord)
- Collection: Sankey · Sankey
- Raw configuration: https://westcoast-charts.com/gallery-src/sankey/chord.js
- Standalone example: https://westcoast-charts.com/embed/samples/wcc/gallery/premium/sankey/chord.html

## Setup

```js
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
```

## Options

```js
const options = {
  chart: {
    height: 540,
    toolbar: {
      show: false
    },
    type: "chord"
  },
  series: [],
  plotOptions: {
    chord: {
      labels: ["Starter", "Team", "Business", "Enterprise", "Churned"],
      matrix: [
        [0, 380, 70, 10, 290],
        [55, 0, 240, 64, 130],
        [12, 40, 0, 150, 52],
        [0, 6, 28, 0, 16],
        [110, 36, 9, 0, 0]
      ],
      ribbon: {
        colorMode: "gradient"
      },
      ticks: {
        show: true
      }
    }
  },
  theme: {
    mode: "light",
    preset: "coastal"
  }
}

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

## Verify

- Text check (Library 1.1.5): load `west-coast-charts/agent/describe` and call `chart.describe({ format: "json" })` for the actual drawn state. The live reader is on this example’s HTML page.
- Command line (Public agent tools 0.2.3, tested with Library 1.1.5; available from the versioned GitHub release and npm, https://westcoast-charts.com/docs/cli/index.md): `wcc chart export sankey-chord.json --out sankey-chord.svg --with-table` (save the options above as JSON first)