superset/superset-frontend/temporary_superset_ui/superset-ui/plugins/legacy-preset-chart-big-number/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.6 KiB

@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: {...},
  }]}
/>