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 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.
|
8 |
|
9 | **[中文官网](https://echarts.apache.org/zh/index.html)** | **[ENGLISH HOMEPAGE](https://echarts.apache.org/en/index.html)**
|
10 |
|
11 | [![Build Status](https://travis-ci.org/apache/echarts.svg?branch=master)](https://travis-ci.org/apache/echarts) [![](https://img.shields.io/npm/dw/echarts.svg?label=npm%20downloads&style=flat)](https://www.npmjs.com/package/echarts) [![Last npm release](https://img.shields.io/npm/v/echarts)](https://www.npmjs.com/package/echarts)
|
12 |
|
13 | ## Get Apache ECharts
|
14 |
|
15 | You may choose one of the following methods:
|
16 |
|
17 | + Download from the official website in [中文下载页](https://echarts.apache.org/zh/download.html)
|
18 | + Download from the official website in [English](https://echarts.apache.org/en/download.html)
|
19 | + `npm install echarts --save`
|
20 | + CDN: [jsDelivr CDN](https://www.jsdelivr.com/package/npm/echarts?path=dist)
|
21 |
|
22 | ## Docs
|
23 |
|
24 | + Tutorial
|
25 | + [中文](https://echarts.apache.org/zh/tutorial.html)
|
26 | + [English](https://echarts.apache.org/en/tutorial.html)
|
27 |
|
28 | + API
|
29 | + [中文](https://echarts.apache.org/zh/api.html)
|
30 | + [English](https://echarts.apache.org/en/api.html)
|
31 |
|
32 | + Option Manual
|
33 | + [中文](https://echarts.apache.org/zh/option.html)
|
34 | + [English](https://echarts.apache.org/en/option.html)
|
35 |
|
36 | ## Get Help
|
37 |
|
38 | + [GitHub Issues](https://github.com/apache/echarts/issues) for bug report and feature requests
|
39 | + Email [dev@echarts.apache.org](mailto:dev@echarts.apache.org) for general questions
|
40 | + Subscribe to the [mailing list](https://echarts.apache.org/en/maillist.html) to get updated with the project
|
41 |
|
42 | ## Build
|
43 |
|
44 | Build echarts source code:
|
45 |
|
46 | Execute the instructions in the root directory of the echarts:
|
47 | ([Node.js](https://nodejs.org) is required)
|
48 |
|
49 | ```shell
|
50 | # Install the dependencies from NPM:
|
51 | npm install
|
52 |
|
53 | # Rebuild source code immediately in watch mode when changing the source code.
|
54 | npm run dev
|
55 |
|
56 | # Check correctness of TypeScript code.
|
57 | npm run checktype
|
58 |
|
59 | # If intending to build and get all types of the "production" files:
|
60 | npm run release
|
61 | ```
|
62 |
|
63 | Then the "production" files are generated in the `dist` directory.
|
64 |
|
65 | More custom build approaches can be checked in this tutorial: [Create Custom Build of ECharts](https://echarts.apache.org/en/tutorial.html#Create%20Custom%20Build%20of%20ECharts) please.
|
66 |
|
67 | ## Contribution
|
68 |
|
69 | 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.
|
70 |
|
71 | ## Resources
|
72 |
|
73 | ### Awesome ECharts
|
74 |
|
75 | [https://github.com/ecomfe/awesome-echarts](https://github.com/ecomfe/awesome-echarts)
|
76 |
|
77 | ### Extensions
|
78 |
|
79 | + [ECharts GL](https://github.com/ecomfe/echarts-gl) An extension pack of ECharts, which provides 3D plots, globe visualization, and WebGL acceleration.
|
80 |
|
81 | + [Liquidfill 水球图](https://github.com/ecomfe/echarts-liquidfill)
|
82 |
|
83 | + [Wordcloud 字符云](https://github.com/ecomfe/echarts-wordcloud)
|
84 |
|
85 | + [Extension for Baidu Map 百度地图扩展](https://github.com/apache/echarts/tree/master/extension-src/bmap) An extension provides a wrapper of Baidu Map Service SDK.
|
86 |
|
87 | + [vue-echarts](https://github.com/ecomfe/vue-echarts) ECharts component for Vue.js
|
88 |
|
89 | + [echarts-stat](https://github.com/ecomfe/echarts-stat) Statistics tool for ECharts
|
90 |
|
91 | ## License
|
92 |
|
93 | ECharts is available under the Apache License V2.
|
94 |
|
95 | ## Code of Conduct
|
96 |
|
97 | Please refer to [Apache Code of Conduct](https://www.apache.org/foundation/policies/conduct.html).
|
98 |
|
99 | ## Paper
|
100 |
|
101 | Deqing Li, Honghui Mei, Yi Shen, Shuang Su, Wenli Zhang, Junting Wang, Ming Zu, Wei Chen.
|
102 | [ECharts: A Declarative Framework for Rapid Construction of Web-based Visualization](https://www.sciencedirect.com/science/article/pii/S2468502X18300068).
|
103 | Visual Informatics, 2018.
|