superset/superset-frontend/temporary_superset_ui/superset-ui/plugins/preset-chart-xy/README.md
Krist Wongsuphasawat afed1a0818 feat(preset-chart-xy): migrate from plugins repo (#377)
* chore: move chart-xy and word-cloud

* fix: babel settings

* fix: remove file

* docs: update storybook code

* docs: word cloud storybook working

* chore: move files back

* fix: ts issues

* fix: import path

* fix: all storybook thingy

* fix: add query storybook back

* fix: address comments

* fix: sorting
2021-11-26 11:46:07 +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={...}
  queryData={{
    data: {...},
  }}
/>