mirror of
https://github.com/apache/superset.git
synced 2024-09-19 20:19:37 -04:00
43 lines
1.6 KiB
Markdown
43 lines
1.6 KiB
Markdown
|
## @superset-ui/legacy-preset-chart-big-number
|
||
|
|
|
||
|
|
[](https://img.shields.io/npm/v/@superset-ui/legacy-preset-chart-big-number.svg?style=flat-square)
|
||
|
|
[](https://david-dm.org/apache-superset/superset-ui-plugins?path=plugins/superset-ui-legacy-preset-chart-big-number)
|
||
|
|
|
||
|
|
This plugin provides Big Number for Superset.
|
||
|
|
|
||
|
|
### Usage
|
||
|
|
|
||
|
|
Import the preset and register. This will register the `BigNumber` and `BigNumberTotal` charts with key `big-number` and `big-number-total`, respectively.
|
||
|
|
|
||
|
|
```js
|
||
|
|
import { BigNumberChartPreset } from '@superset-ui/legacy-preset-chart-big-number';
|
||
|
|
|
||
|
|
new BigNumberChartPreset().register();
|
||
|
|
```
|
||
|
|
|
||
|
|
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.
|
||
|
|
|
||
|
|
```js
|
||
|
|
import { BigNumberChartPlugin, BigNumberTotalChartPlugin } from '@superset-ui/legacy-preset-chart-big-number';
|
||
|
|
|
||
|
|
new BigNumberChartPlugin()
|
||
|
|
.configure({ key: 'big-number' })
|
||
|
|
.register();
|
||
|
|
new BigNumberTotalChartPlugin()
|
||
|
|
.configure({ key: 'big-number-total' })
|
||
|
|
.register();
|
||
|
|
```
|
||
|
|
|
||
|
|
Then use it via `SuperChart`. See [storybook](https://apache-superset.github.io/superset-ui-plugins/?selectedKind=plugin-chart-big-number) for more details.
|
||
|
|
|
||
|
|
```js
|
||
|
|
<SuperChart
|
||
|
|
chartType="big-number"
|
||
|
|
width={600}
|
||
|
|
height={600}
|
||
|
|
formData={...}
|
||
|
|
queryData={{
|
||
|
|
data: {...},
|
||
|
|
}}
|
||
|
|
/>
|
||
|
|
```
|