superset/superset-frontend/temporary_superset_ui/superset-ui/plugins/legacy-preset-chart-nvd3/README.md

43 lines
1.4 KiB
Markdown
Raw Normal View History

2019-02-07 18:59:49 -05:00
## @superset-ui/legacy-preset-chart-nvd3
[![Version](https://img.shields.io/npm/v/@superset-ui/legacy-preset-chart-nvd3.svg?style=flat-square)](https://www.npmjs.com/package/@superset-ui/legacy-preset-chart-nvd3)
2019-02-25 16:39:53 -05:00
[![David (path)](https://img.shields.io/david/apache-superset/superset-ui-plugins.svg?path=packages%2Fsuperset-ui-legacy-preset-chart-nvd3&style=flat-square)](https://david-dm.org/apache-superset/superset-ui-plugins?path=packages/superset-ui-legacy-preset-chart-nvd3)
2019-02-07 18:59:49 -05:00
This plugin provides Big Number for Superset.
### Usage
Import the preset and register. This will register all the chart plugins under nvd3.
```js
import { NVD3ChartPreset } from '@superset-ui/legacy-preset-chart-nvd3';
new NVD3ChartPreset().register();
```
2020-12-10 16:58:10 -05:00
or register charts one by one. Configure `key`, which can be any `string`, and register the plugin.
This `key` will be used to lookup this chart throughout the app.
2019-02-07 18:59:49 -05:00
```js
import { AreaChartPlugin, LineChartPlugin } from '@superset-ui/legacy-preset-chart-nvd3';
2020-12-10 16:58:10 -05:00
new AreaChartPlugin().configure({ key: 'area' }).register();
new LineChartPlugin().configure({ key: 'line' }).register();
2019-02-07 18:59:49 -05:00
```
2020-12-10 16:58:10 -05:00
Then use it via `SuperChart`. See
[storybook](https://apache-superset.github.io/superset-ui-plugins/?selectedKind=plugin-chart-nvd3)
for more details.
2019-02-07 18:59:49 -05:00
```js
<SuperChart
chartType="line"
width={600}
height={600}
formData={...}
queryData={{
data: {...},
2019-02-07 18:59:49 -05:00
}}
/>
2020-12-10 16:58:10 -05:00
```