superset/superset-frontend/temporary_superset_ui/superset-ui/plugins/plugin-chart-echarts/README.md

41 lines
1.3 KiB
Markdown
Raw Normal View History

## @superset-ui/plugin-chart-echarts
[![Version](https://img.shields.io/npm/v/@superset-ui/plugin-chart-echarts.svg?style=flat-square)](https://www.npmjs.com/package/@superset-ui/plugin-chart-echarts)
[![David (path)](https://img.shields.io/david/apache-superset/superset-ui.svg?path=packages%2Fsuperset-ui-plugin-chart-echarts&style=flat-square)](https://david-dm.org/apache-superset/superset-ui?path=packages/superset-ui-plugin-chart-echarts)
This plugin provides Echarts viz plugins for Superset:
2020-12-10 16:58:10 -05:00
- Timeseries Chart (combined line, area bar with support for predictive analytics)
- Pie Chart
### Usage
2020-12-10 16:58:10 -05:00
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 {
EchartsTimeseriesChartPlugin,
EchartsPieChartPlugin,
} from '@superset-ui/plugin-chart-echarts';
2020-12-10 16:58:10 -05:00
new EchartsTimeseriesChartPlugin().configure({ key: 'echarts-ts' }).register();
new EchartsPieChartPlugin().configure({ key: 'echarts-pie' }).register();
```
2020-12-10 16:58:10 -05:00
Then use it via `SuperChart`. See
[storybook](https://apache-superset.github.io/superset-ui/?selectedKind=chart-plugins-plugin-chart-echarts)
for more details.
```js
<SuperChart
chartType="echarts-ts"
width={600}
height={600}
formData={...}
queriesData={[{
data: {...},
}]}
/>
```