a1e355f50e96f3d076203d22ee84d45f3004336dddd5be20a7d5fb1782a1e1932b40c9d5fd74dc28766040232550bcec1a9bebab9679b46cb0299c2854bbcc 3.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495
  1. # Apache ECharts
  2. <a href="https://echarts.apache.org/">
  3. <img style="vertical-align: top;" src="./asset/logo.png?raw=true" alt="logo" height="50px">
  4. </a>
  5. Apache ECharts 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 <a href="https://github.com/ecomfe/zrender">zrender</a>, which is a whole new lightweight canvas library.
  6. **[中文官网](https://echarts.apache.org/zh/index.html)** | **[ENGLISH HOMEPAGE](https://echarts.apache.org/en/index.html)**
  7. [![License](https://img.shields.io/npm/l/echarts?color=5470c6)](https://github.com/apache/echarts/blob/master/LICENSE) [![Latest npm release](https://img.shields.io/npm/v/echarts?color=91cc75)](https://www.npmjs.com/package/echarts) [![NPM downloads](https://img.shields.io/npm/dm/echarts.svg?label=npm%20downloads&style=flat&color=fac858)](https://www.npmjs.com/package/echarts) [![Contributors](https://img.shields.io/github/contributors/apache/echarts?color=3ba272)](https://github.com/apache/echarts/graphs/contributors)
  8. [![Build Status](https://github.com/apache/echarts/actions/workflows/ci.yml/badge.svg)](https://github.com/apache/echarts/actions/workflows/ci.yml)
  9. ## Get Apache ECharts
  10. You may choose one of the following methods:
  11. + Download from the [official website](https://echarts.apache.org/download.html)
  12. + `npm install echarts --save`
  13. + CDN: [jsDelivr CDN](https://www.jsdelivr.com/package/npm/echarts?path=dist)
  14. ## Docs
  15. + [Get Started](https://echarts.apache.org/handbook)
  16. + [API](https://echarts.apache.org/api.html)
  17. + [Option Manual](https://echarts.apache.org/option.html)
  18. + [Examples](https://echarts.apache.org/examples)
  19. ## Get Help
  20. + [GitHub Issues](https://github.com/apache/echarts/issues) for bug report and feature requests
  21. + Email [dev@echarts.apache.org](mailto:dev@echarts.apache.org) for general questions
  22. + Subscribe to the [mailing list](https://echarts.apache.org/maillist.html) to get updated with the project
  23. ## Build
  24. Build echarts source code:
  25. Execute the instructions in the root directory of the echarts:
  26. ([Node.js](https://nodejs.org) is required)
  27. ```shell
  28. # Install the dependencies from NPM:
  29. npm install
  30. # Rebuild source code immediately in watch mode when changing the source code.
  31. npm run dev
  32. # Check correctness of TypeScript code.
  33. npm run checktype
  34. # If intending to build and get all types of the "production" files:
  35. npm run release
  36. ```
  37. Then the "production" files are generated in the `dist` directory.
  38. ## Contribution
  39. If you wish to debug locally or make pull requests, please refer to the [contributing](https://github.com/apache/echarts/blob/master/CONTRIBUTING.md) document.
  40. ## Resources
  41. ### Awesome ECharts
  42. [https://github.com/ecomfe/awesome-echarts](https://github.com/ecomfe/awesome-echarts)
  43. ### Extensions
  44. + [ECharts GL](https://github.com/ecomfe/echarts-gl) An extension pack of ECharts, which provides 3D plots, globe visualization, and WebGL acceleration.
  45. + [Liquidfill 水球图](https://github.com/ecomfe/echarts-liquidfill)
  46. + [Wordcloud 字符云](https://github.com/ecomfe/echarts-wordcloud)
  47. + [Extension for Baidu Map 百度地图扩展](https://github.com/apache/echarts/tree/master/extension-src/bmap) An extension provides a wrapper of Baidu Map Service SDK.
  48. + [vue-echarts](https://github.com/ecomfe/vue-echarts) ECharts component for Vue.js
  49. + [echarts-stat](https://github.com/ecomfe/echarts-stat) Statistics tool for ECharts
  50. ## License
  51. ECharts is available under the Apache License V2.
  52. ## Code of Conduct
  53. Please refer to [Apache Code of Conduct](https://www.apache.org/foundation/policies/conduct.html).
  54. ## Paper
  55. Deqing Li, Honghui Mei, Yi Shen, Shuang Su, Wenli Zhang, Junting Wang, Ming Zu, Wei Chen.
  56. [ECharts: A Declarative Framework for Rapid Construction of Web-based Visualization](https://www.sciencedirect.com/science/article/pii/S2468502X18300068).
  57. Visual Informatics, 2018.