superset/superset-frontend/temporary_superset_ui/superset-ui/plugins/plugin-chart-echarts/README.md
simchaNielsen 16225132c2 chore(core): remove queryData and replace with queriesData (#874)
* feat: remove single queryData from api

* feat: migrate old plugins to queriesData api property

* test: fix tests

* test: fix tests

* fix: fix storybook

* lint: fix lint

* refactor: fix CR notes

* refactor: remove queryData from Chart Provider
2021-11-26 11:46:47 +08:00

1.3 KiB

@superset-ui/plugin-chart-echarts

Version David (path)

This plugin provides Echarts viz plugins for Superset:

  • Timeseries Chart (combined line, area bar with support for predictive analytics)
  • Pie Chart

Usage

Configure key, which can be any string, and register the plugin. This key will be used to lookup this chart throughout the app.

import {
  EchartsTimeseriesChartPlugin,
  EchartsPieChartPlugin,
} from '@superset-ui/plugin-chart-echarts';

new EchartsTimeseriesChartPlugin().configure({ key: 'echarts-ts' }).register();
new EchartsPieChartPlugin().configure({ key: 'echarts-pie' }).register();

Then use it via SuperChart. See storybook for more details.

<SuperChart
  chartType="echarts-ts"
  width={600}
  height={600}
  formData={...}
  queriesData={[{
    data: {...},
  }]}
/>