superset/superset-frontend/plugins/legacy-preset-chart-big-number
Yongjie Zhao 3c41ff68a4
refactor(monorepo): move superset-ui to superset(stage 2) (#17552)
2021-11-30 08:29:57 +08:00
..
src refactor(monorepo): move superset-ui to superset(stage 2) (#17552) 2021-11-30 08:29:57 +08:00
test refactor(monorepo): move superset-ui to superset(stage 2) (#17552) 2021-11-30 08:29:57 +08:00
CHANGELOG.md refactor(monorepo): move superset-ui to superset(stage 2) (#17552) 2021-11-30 08:29:57 +08:00
README.md refactor(monorepo): move superset-ui to superset(stage 2) (#17552) 2021-11-30 08:29:57 +08:00
package.json refactor(monorepo): move superset-ui to superset(stage 2) (#17552) 2021-11-30 08:29:57 +08:00
tsconfig.json refactor(monorepo): move superset-ui to superset(stage 2) (#17552) 2021-11-30 08:29:57 +08:00

README.md

@superset-ui/legacy-preset-chart-big-number

Version David (path)

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.

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.

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 for more details.

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