2020-04-11 01:29:42 -04:00
|
|
|
## @superset-ui/legacy-plugin-chart-calendar
|
|
|
|
|
2020-11-05 07:59:06 -05:00
|
|
|
[![Version](https://img.shields.io/npm/v/@superset-ui/legacy-plugin-chart-calendar.svg?style=flat-square)](https://www.npmjs.com/package/@superset-ui/legacy-plugin-chart-calendar)
|
2020-04-11 01:29:42 -04:00
|
|
|
[![David (path)](https://img.shields.io/david/apache-superset/superset-ui-plugins.svg?path=packages%2Fsuperset-ui-legacy-plugin-chart-calendar&style=flat-square)](https://david-dm.org/apache-superset/superset-ui-plugins?path=packages/superset-ui-legacy-plugin-chart-calendar)
|
|
|
|
|
|
|
|
This plugin provides Calendar Heatmap for Superset.
|
|
|
|
|
|
|
|
### Usage
|
|
|
|
|
2020-12-10 16:58:10 -05:00
|
|
|
Configure `key`, which can be any `string`, and register the plugin. This `key` will be used to
|
|
|
|
lookup this chart throughout the app.
|
2020-04-11 01:29:42 -04:00
|
|
|
|
|
|
|
```js
|
|
|
|
import CalendarChartPlugin from '@superset-ui/legacy-plugin-chart-calendar';
|
|
|
|
|
2020-12-10 16:58:10 -05:00
|
|
|
new CalendarChartPlugin().configure({ key: 'calendar' }).register();
|
2020-04-11 01:29:42 -04: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-calendar)
|
|
|
|
for more details.
|
2020-04-11 01:29:42 -04:00
|
|
|
|
|
|
|
```js
|
|
|
|
<SuperChart
|
|
|
|
chartType="calendar"
|
|
|
|
width={600}
|
|
|
|
height={600}
|
|
|
|
formData={...}
|
2020-12-29 05:10:39 -05:00
|
|
|
queriesData={[{
|
2020-04-11 01:29:42 -04:00
|
|
|
data: {...},
|
2020-12-29 05:10:39 -05:00
|
|
|
}]}
|
2020-04-11 01:29:42 -04:00
|
|
|
/>
|
2020-12-10 16:58:10 -05:00
|
|
|
```
|