README.md

Apache ECharts (incubating)

Apache ECharts (incubating) is a free, powerful charting and visualization library offering an easy way of adding intuitive, interactive, and highly customizable charts to your commercial products. It is written in pure JavaScript and based on zrender, which is a whole new lightweight canvas library.

Now ECharts is an incubator project of Apache Software Foundation. Please check its incubator status here

中文官网 | ENGLISH HOMEPAGE

Get Apache ECharts (incubating)

You may choose one of the following methods:

• Download from Official Website in 中文下载页
• Download from Official Website in English
• npm install echarts --save
• CDN: jsDelivr CDN

Docs

• Tutorial

  • 中文
  • English

• API

  • 中文
  • English

• Option Manual

  • 中文
  • English

Get Help

• GitHub Issues for bug report and feature requests
• Email [email protected] for general questions
• Subscribe mailing list to get updated with the project

Build

Build echarts source code:

Execute the instructions in the root directory of the echarts: (Node.js is required)

# Install the dependencies from NPM:
npm install

# If intending to build and get all types of the "production" files:
npm run release
# The same as `node build/build.js --release`

# If only intending to get `dist/echarts.js`, which is usually
# enough in dev or running the tests:
npm run build
# The same as `node build/build.js`

# Get the same "production" files as `node build/build.js`, while
# watching the editing of the source code. Usually used in dev.
npm run watch
# The same as `node build/build.js -w`

# Check the manual:
npm run help
# The same as `node build/build.js --help`

Then the "production" files are generated in the dist directory.

More custom build approaches can be checked in this tutorial: Create Custom Build of ECharts please.

Contribution

If you wish to debug locally or make pull requests, please refer to contributing document.

Resources

Awesome ECharts

https://github.com/ecomfe/awesome-echarts

Extensions

• ECharts GL An extension pack of ECharts, which provides 3D plots, globe visualization, and WebGL acceleration.

• Liquidfill 水球图

• Wordcloud 字符云

• Extension for Baidu Map 百度地图扩展 An extension provides a wrapper of Baidu Map Service SDK.

• vue-echarts ECharts component for Vue.js

• echarts-stat Statistics tool for ECharts

License

ECharts is available under the Apache License V2.

Code of Conduct

Please refer to Apache Code of Conduct.

Paper

Deqing Li, Honghui Mei, Yi Shen, Shuang Su, Wenli Zhang, Junting Wang, Ming Zu, Wei Chen. ECharts: A Declarative Framework for Rapid Construction of Web-based Visualization. Visual Informatics, 2018.