| 1 | # Apache ECharts
|
| 2 |
|
| 3 | <a href="https://echarts.apache.org/">
|
| 4 | <img style="vertical-align: top;" src="./asset/logo.png?raw=true" alt="logo" height="50px">
|
| 5 | </a>
|
| 6 |
|
| 7 | Apache ECharts is a free, powerful charting and visualization library offering easy ways to add intuitive, interactive, and highly customizable charts to your commercial products. It is written in pure JavaScript and based on <a href="https://github.com/ecomfe/zrender">zrender</a>, which is a whole new lightweight canvas library.
|
| 8 |
|
| 9 | **[中文官网](https://echarts.apache.org/zh/index.html)** | **[ENGLISH HOMEPAGE](https://echarts.apache.org/en/index.html)**
|
| 10 |
|
| 11 | [](https://github.com/apache/echarts/blob/master/LICENSE) [](https://www.npmjs.com/package/echarts) [](https://www.npmjs.com/package/echarts) [](https://github.com/apache/echarts/graphs/contributors)
|
| 12 |
|
| 13 | [](https://github.com/apache/echarts/actions/workflows/ci.yml)
|
| 14 |
|
| 15 | ## Get Apache ECharts
|
| 16 |
|
| 17 | You may choose one of the following methods:
|
| 18 |
|
| 19 | + Download from the [official website](https://echarts.apache.org/download.html)
|
| 20 | + `npm install echarts --save`
|
| 21 | + CDN: [jsDelivr CDN](https://www.jsdelivr.com/package/npm/echarts?path=dist)
|
| 22 |
|
| 23 | ## Docs
|
| 24 |
|
| 25 | + [Get Started](https://echarts.apache.org/handbook)
|
| 26 | + [API](https://echarts.apache.org/api.html)
|
| 27 | + [Option Manual](https://echarts.apache.org/option.html)
|
| 28 | + [Examples](https://echarts.apache.org/examples)
|
| 29 |
|
| 30 | ## Get Help
|
| 31 |
|
| 32 | + [GitHub Issues](https://github.com/apache/echarts/issues) for bug report and feature requests
|
| 33 | + Email [dev@echarts.apache.org](mailto:dev@echarts.apache.org) for general questions
|
| 34 | + Subscribe to the [mailing list](https://echarts.apache.org/maillist.html) to get updated with the project
|
| 35 |
|
| 36 | ## Build
|
| 37 |
|
| 38 | Build echarts source code:
|
| 39 |
|
| 40 | Execute the instructions in the root directory of the echarts:
|
| 41 | ([Node.js](https://nodejs.org) is required)
|
| 42 |
|
| 43 | ```shell
|
| 44 | # Install the dependencies from NPM:
|
| 45 | npm install
|
| 46 |
|
| 47 | # Rebuild source code immediately in watch mode when changing the source code.
|
| 48 | # It opens the `./test` directory, and you may open `-cases.html` to get the list
|
| 49 | # of all test cases.
|
| 50 | # If you wish to create a test case, run `npm run mktest:help` to learn more.
|
| 51 | npm run dev
|
| 52 |
|
| 53 | # Check the correctness of TypeScript code.
|
| 54 | npm run checktype
|
| 55 |
|
| 56 | # If intending to build and get all types of the "production" files:
|
| 57 | npm run release
|
| 58 | ```
|
| 59 |
|
| 60 | Then the "production" files are generated in the `dist` directory.
|
| 61 |
|
| 62 | ## Contribution
|
| 63 |
|
| 64 | Please refer to the [contributing](https://github.com/apache/echarts/blob/master/CONTRIBUTING.md) document if you wish to debug locally or make pull requests.
|
| 65 |
|
| 66 | ## Resources
|
| 67 |
|
| 68 | ### Awesome ECharts
|
| 69 |
|
| 70 | [https://github.com/ecomfe/awesome-echarts](https://github.com/ecomfe/awesome-echarts)
|
| 71 |
|
| 72 | ### Extensions
|
| 73 |
|
| 74 | + [ECharts GL](https://github.com/ecomfe/echarts-gl) An extension pack of ECharts, which provides 3D plots, globe visualization, and WebGL acceleration.
|
| 75 |
|
| 76 | + [Liquidfill 水球图](https://github.com/ecomfe/echarts-liquidfill)
|
| 77 |
|
| 78 | + [Wordcloud 字符云](https://github.com/ecomfe/echarts-wordcloud)
|
| 79 |
|
| 80 | + [Extension for Baidu Map 百度地图扩展](https://github.com/apache/echarts/tree/master/extension-src/bmap) An extension provides a wrapper of Baidu Map Service SDK.
|
| 81 |
|
| 82 | + [vue-echarts](https://github.com/ecomfe/vue-echarts) ECharts component for Vue.js
|
| 83 |
|
| 84 | + [echarts-stat](https://github.com/ecomfe/echarts-stat) Statistics tool for ECharts
|
| 85 |
|
| 86 | ## License
|
| 87 |
|
| 88 | ECharts is available under the Apache License V2.
|
| 89 |
|
| 90 | ## Code of Conduct
|
| 91 |
|
| 92 | Please refer to [Apache Code of Conduct](https://www.apache.org/foundation/policies/conduct.html).
|
| 93 |
|
| 94 | ## Paper
|
| 95 |
|
| 96 | Deqing Li, Honghui Mei, Yi Shen, Shuang Su, Wenli Zhang, Junting Wang, Ming Zu, Wei Chen.
|
| 97 | [ECharts: A Declarative Framework for Rapid Construction of Web-based Visualization](https://www.sciencedirect.com/science/article/pii/S2468502X18300068).
|
| 98 | Visual Informatics, 2018.
|