superset/superset-frontend/temporary_superset_ui/superset-ui/plugins/superset-ui-plugins/packages/superset-ui-plugin-chart-word-cloud/README.md

34 lines
1.2 KiB
Markdown
Raw Normal View History

2019-02-22 21:00:36 -05:00
## @superset-ui/plugin-chart-word-cloud
[![Version](https://img.shields.io/npm/v/@superset-ui/plugin-chart-word-cloud.svg?style=flat-square)](https://img.shields.io/npm/v/@superset-ui/plugin-chart-word-cloud.svg?style=flat-square)
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-plugin-chart-word-cloud&style=flat-square)](https://david-dm.org/apache-superset/superset-ui-plugins?path=packages/superset-ui-plugin-chart-word-cloud)
2019-02-22 21:00:36 -05:00
This plugin provides Word Cloud for Superset.
### Usage
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 WordCloudChartPlugin from '@superset-ui/legacy-plugin-chart-word-cloud';
new WordCloudChartPlugin()
.configure({ key: 'word-cloud' })
.register();
```
Then use it via `SuperChart`. See [storybook](https://apache-superset.github.io/superset-ui-plugins/?selectedKind=plugin-chart-word-cloud) for more details.
2019-02-22 21:00:36 -05:00
```js
<SuperChart
chartType="word-cloud"
chartProps={{
width: 600,
height: 600,
formData: {...},
payload: {
data: {...},
},
}}
/>
```