superset/superset-frontend/temporary_superset_ui/superset-ui/plugins/preset-chart-xy/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.2 KiB

@superset-ui/preset-chart-xy

Version David (path)

This plugin provides basic charts on cartesian coordinates (Line, Box Plot) for Superset.

DISCLAIMER: It is still under heavy development and the APIs are subject to changes.

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 { BoxPlotChartPlugin } from '@superset-ui/preset-chart-xy';

new BoxPlotChartPlugin().configure({ key: 'box-plot' }).register();

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

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