Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ecomfe/echarts-wordcloud
Word Cloud extension based on Apache ECharts and wordcloud2.js
https://github.com/ecomfe/echarts-wordcloud
echarts
Last synced: 3 days ago
JSON representation
Word Cloud extension based on Apache ECharts and wordcloud2.js
- Host: GitHub
- URL: https://github.com/ecomfe/echarts-wordcloud
- Owner: ecomfe
- Created: 2016-07-13T14:46:32.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-03-12T02:35:10.000Z (10 months ago)
- Last Synced: 2024-12-04T09:11:36.663Z (about 1 month ago)
- Topics: echarts
- Language: JavaScript
- Homepage:
- Size: 1.84 MB
- Stars: 1,686
- Watchers: 48
- Forks: 708
- Open Issues: 114
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-echarts - wordcloud 词云 - Apache ECharts wordcloud extension based on wordcloud2.js. (Extensions / Videos)
README
# echarts-wordcloud
Third-party Wordcloud extension based on [wordcloud2.js](https://github.com/timdream/wordcloud2.js) for [Apache ECharts](https://github.com/apache/echarts).
## Examples
[Google Trends](https://ecomfe.github.io/echarts-wordcloud/example/wordCloud.html)
[ECharts Option Keywords](https://ecomfe.github.io/echarts-wordcloud/example/optionKeywords.html)
## Install
```html
```
Or
```shell
npm install echarts
npm install echarts-wordcloud
```
```js
import * as echarts from 'echarts';
import 'echarts-wordcloud';
```
⚠️ NOTE:
echarts-wordcloud@2 is for echarts@5
echarts-wordcloud@1 is for echarts@4
## Usage
```js
var chart = echarts.init(document.getElementById('main'));
chart.setOption({
...
series: [{
type: 'wordCloud',
// The shape of the "cloud" to draw. Can be any polar equation represented as a
// callback function, or a keyword present. Available presents are circle (default),
// cardioid (apple or heart shape curve, the most known polar equation), diamond (
// alias of square), triangle-forward, triangle, (alias of triangle-upright, pentagon, and star.
shape: 'circle',
// Keep aspect ratio of maskImage or 1:1 for shapes
// This option is supported since [email protected]
keepAspect: false,
// A silhouette image which the white area will be excluded from drawing texts.
// The shape option will continue to apply as the shape of the cloud to grow.
maskImage: maskImage,
// Folllowing left/top/width/height/right/bottom are used for positioning the word cloud
// Default to be put in the center and has 75% x 80% size.
left: 'center',
top: 'center',
width: '70%',
height: '80%',
right: null,
bottom: null,
// Text size range which the value in data will be mapped to.
// Default to have minimum 12px and maximum 60px size.
sizeRange: [12, 60],
// Text rotation range and step in degree. Text will be rotated randomly in range [-90, 90] by rotationStep 45
rotationRange: [-90, 90],
rotationStep: 45,
// size of the grid in pixels for marking the availability of the canvas
// the larger the grid size, the bigger the gap between words.
gridSize: 8,
// set to true to allow word to be drawn partly outside of the canvas.
// Allow word bigger than the size of the canvas to be drawn
// This option is supported since [email protected]
drawOutOfBound: false,
// if the font size is too large for the text to be displayed,
// whether to shrink the text. If it is set to false, the text will
// not be rendered. If it is set to true, the text will be shrinked.
// This option is supported since [email protected]
shrinkToFit: false,
// If perform layout animation.
// NOTE disable it will lead to UI blocking when there is lots of words.
layoutAnimation: true,
// Global text style
textStyle: {
fontFamily: 'sans-serif',
fontWeight: 'bold',
// Color can be a callback function or a color string
color: function () {
// Random color
return 'rgb(' + [
Math.round(Math.random() * 160),
Math.round(Math.random() * 160),
Math.round(Math.random() * 160)
].join(',') + ')';
}
},
emphasis: {
focus: 'self',
textStyle: {
textShadowBlur: 10,
textShadowColor: '#333'
}
},
// Data is an array. Each array item must have name and value property.
data: [{
name: 'Farrah Abraham',
value: 366,
// Style of single text
textStyle: {
}
}]
}]
});
```
## Changelog
### 2.1.0
- [chore] Update Apache ECharts version
- [chore] Sync with the latest wordcloud2.js and use prettier to format the code
- [feature] Add `keepAspect` option to keep aspect ratio of maskImage or 1:1 for shapes
- [feature] Add `drawOutOfBound` option to allow words to be drawn partly outside of the canvas
- [feature] Add `shrinkToFit` option to shrink the text if the font size is too large for the text to be displayed
## Notice
The Apache Software Foundation [Apache ECharts, ECharts](https://echarts.apache.org/), Apache, the Apache feather, and the Apache ECharts project logo are either registered trademarks or trademarks of the [Apache Software Foundation](https://www.apache.org/).