mirror of
https://github.com/apache/superset.git
synced 2024-09-12 08:39:45 -04:00
35 lines
1.2 KiB
Markdown
35 lines
1.2 KiB
Markdown
|
## @superset-ui/legacy-plugin-chart-sankey-loop
|
||
|
|
||
|
[![Version](https://img.shields.io/npm/v/@superset-ui/legacy-plugin-chart-sankey.svg?style=flat-square)](https://img.shields.io/npm/v/@superset-ui/legacy-plugin-chart-sankey.svg?style=flat-square)
|
||
|
[![David (path)](https://img.shields.io/david/apache-superset/superset-ui-plugins.svg?path=packages%2Fsuperset-ui-legacy-plugin-chart-sankey&style=flat-square)](https://david-dm.org/apache-superset/superset-ui-plugins?path=packages/superset-ui-legacy-plugin-chart-sankey)
|
||
|
|
||
|
This plugin provides Sankey Diagram with loops for Superset.
|
||
|
|
||
|
### Usage
|
||
|
|
||
|
Configure `key`, which can be any `string`, and register the plugin. This `key` will be used to lookup this chart throughout the app.
|
||
|
|
||
|
```js
|
||
|
import SankeyLoopChartPlugin from '@superset-ui/legacy-plugin-chart-sankey-loop';
|
||
|
|
||
|
new SankeyLoopChartPlugin()
|
||
|
.configure({ key: 'sankey' })
|
||
|
.register();
|
||
|
```
|
||
|
|
||
|
Then use it via `SuperChart`. See [storybook](https://apache-superset.github.io/superset-ui-plugins/?selectedKind=plugin-chart-sankey-loop) for more details.
|
||
|
|
||
|
```js
|
||
|
<SuperChart
|
||
|
chartType="sankey-loop"
|
||
|
chartProps={{
|
||
|
width: 600,
|
||
|
height: 600,
|
||
|
formData: {...},
|
||
|
payload: {
|
||
|
data: {...},
|
||
|
},
|
||
|
}}
|
||
|
/>
|
||
|
```
|