README.md 4.0 KB
Newer Older
1
# Apache ECharts
L
lang 已提交
2

Y
Yi Shen 已提交
3
<a href="https://echarts.apache.org/">
L
README  
lang 已提交
4 5
    <img style="vertical-align: top;" src="./asset/logo.png?raw=true" alt="logo" height="50px">
</a>
L
lang 已提交
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

Y
Yi Shen 已提交
9
**[中文官网](https://echarts.apache.org/zh/index.html)** | **[ENGLISH HOMEPAGE](https://echarts.apache.org/en/index.html)**
1
100pah 已提交
10

1
100pah 已提交
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
L
lang 已提交
14

羡辙 已提交
15
You may choose one of the following methods:
P
pissang 已提交
16

O
Ovilia 已提交
17 18
+ Download from Official Website in [中文下载页](https://echarts.apache.org/zh/download.html)
+ Download from Official Website in [English](https://echarts.apache.org/en/download.html)
L
lang 已提交
19
+ `npm install echarts --save`
羡辙 已提交
20
+ CDN: [jsDelivr CDN](https://www.jsdelivr.com/package/npm/echarts?path=dist)
L
Lukas Drgon 已提交
21

L
lang 已提交
22 23
## Docs

B
Benson Muite 已提交
24 25 26
+ Tutorial
    + [中文](https://echarts.apache.org/zh/tutorial.html)
    + [English](https://echarts.apache.org/en/tutorial.html)
L
lang 已提交
27

B
Benson Muite 已提交
28 29 30
+ API
    + [中文](https://echarts.apache.org/zh/api.html)
    + [English](https://echarts.apache.org/en/api.html)
L
lang 已提交
31

B
Benson Muite 已提交
32 33 34
+ Option Manual
    + [中文](https://echarts.apache.org/zh/option.html)
    + [English](https://echarts.apache.org/en/option.html)
L
lang 已提交
35

36
## Get Help
O
Ovilia 已提交
37

1
100pah 已提交
38
+ [GitHub Issues](https://github.com/apache/echarts/issues) for bug report and feature requests
Z
Zhongxiang.Wang 已提交
39
+ Email [dev@echarts.apache.org](mailto:dev@echarts.apache.org) for general questions
O
Ovilia 已提交
40 41
+ Subscribe [mailing list](https://echarts.apache.org/en/maillist.html) to get updated with the project

O
Ovilia 已提交
42 43
## Build

44 45 46 47 48 49 50 51 52
Build echarts source code:

Execute the instructions in the root directory of the echarts:
([Node.js](https://nodejs.org) is required)

```shell
# Install the dependencies from NPM:
npm install

53 54
# Rebuild source code immediately in watch mode when changing the source code.
npm run dev
55

56 57
# Check correctness of TypeScript code.
npm run checktype
58

59 60
# If intending to build and get all types of the "production" files:
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.
O
Ovilia 已提交
66 67

## Contribution
L
lang 已提交
68

1
100pah 已提交
69
If you wish to debug locally or make pull requests, please refer to [contributing](https://github.com/apache/echarts/blob/master/CONTRIBUTING.md) document.
O
Ovilia 已提交
70 71

## Resources
P
pissang 已提交
72

1
100pah 已提交
73
### Awesome ECharts
Y
Yi Shen 已提交
74 75 76

[https://github.com/ecomfe/awesome-echarts](https://github.com/ecomfe/awesome-echarts)

O
Ovilia 已提交
77
### Extensions
Y
Yi Shen 已提交
78

Y
Yi Shen 已提交
79 80
+ [ECharts GL](https://github.com/ecomfe/echarts-gl) An extension pack of ECharts, which provides 3D plots, globe visualization, and WebGL acceleration.

O
Ovilia 已提交
81
+ [Liquidfill 水球图](https://github.com/ecomfe/echarts-liquidfill)
L
lang 已提交
82

O
Ovilia 已提交
83
+ [Wordcloud 字符云](https://github.com/ecomfe/echarts-wordcloud)
L
lang 已提交
84

1
100pah 已提交
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.
P
pissang 已提交
86

P
pissang 已提交
87 88 89 90
+ [vue-echarts](https://github.com/ecomfe/vue-echarts) ECharts component for Vue.js

+ [echarts-stat](https://github.com/ecomfe/echarts-stat) Statistics tool for ECharts

L
lang 已提交
91
## License
L
lang 已提交
92

93
ECharts is available under the Apache License V2.
D
deqingli 已提交
94

O
Ovilia 已提交
95 96 97 98
## Code of Conduct

Please refer to [Apache Code of Conduct](https://www.apache.org/foundation/policies/conduct.html).

99
## Paper
D
deqingli 已提交
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).
D
deqingli 已提交
103
Visual Informatics, 2018.