-
Notifications
You must be signed in to change notification settings - Fork 2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
19683fb
commit fd80075
Showing
10 changed files
with
1,966 additions
and
210 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
<a name="1.17.3"></a> | ||
## [1.17.3](https://github.com/ElemeFE/v-charts/compare/v1.17.2...v1.17.3) (2018-06-19) | ||
|
||
|
||
### Features | ||
|
||
* **funnel:** add `filterZero` and `useDefaultOrder` attribute in settings ([#373](https://github.com/ElemeFE/v-charts/issues/373)) ([687491d](https://github.com/ElemeFE/v-charts/commit/687491d)) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
<a name="1.17.3"></a> | ||
## [1.17.3](https://github.com/ElemeFE/v-charts/compare/v1.17.2...v1.17.3) (2018-06-19) | ||
|
||
|
||
### Features | ||
|
||
* **funnel:** 增加 `filterZero` 和 `useDefaultOrder` 配置 ([#373](https://github.com/ElemeFE/v-charts/issues/373)) ([687491d](https://github.com/ElemeFE/v-charts/commit/687491d)) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
# v-charts Contributing Guide | ||
|
||
v-charts is a Vue2.x package-based Echarts chart component that provides developers with services to quickly generate charts. | ||
The growth of v-charts is inseparable from everyone's support. If you would like to contribute code for v-charts, please read the following: | ||
|
||
## Development principles | ||
|
||
The core principle of v-charts is that developers can **simplify configuration items**. Based on this principle, v-charts has the following conventions: | ||
|
||
1. The data needs to use the form of metrics dimension. For details, | ||
please refer to [document](https://v-charts.js.org/#/en/data). | ||
2. The setting of metrics dimensions, data types, simplified configuration items, | ||
data aliases, etc. are achieved through the addition of attributes in settings. | ||
3. In addition to introducing the dependency (eg: line) of the corresponding | ||
module, the component tries not to introduce plug-in dependencies (eg: visualMap). | ||
|
||
## Setting up the env | ||
|
||
- Installation dependencies `npm install` | ||
- Run development `npm run dev` | ||
- Generate components `npm run build` | ||
- Run the document `npm run docs` | ||
- Run the test `npm run test` | ||
|
||
## Component development | ||
|
||
To develop a new chart component, first add the corresponding chart under | ||
`src/packages`, then add the corresponding data under `examples/data` and | ||
import it in `index.js`, and finally add corresponding components in | ||
`src/index.es.js`, `src/component-list` and `src/index/index.js`. After development, | ||
you need to add docs in `docs` folder and add it to sidebar. | ||
|
||
## Code Style | ||
|
||
Follow [standard](https://standardjs.com/). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# v-charts 贡献指南 | ||
|
||
v-charts 是一套基于 Vue2.x 封装的 Echarts 图表组件,用于为开发者提供快速生成图表的服务。 | ||
v-charts 的成长离不开大家的支持,如果你愿意为 v-charts 贡献代码,请阅读以下内容: | ||
|
||
## 开发原则 | ||
|
||
v-charts 的核心原则是**为开发者简化配置项**,基于此原则,v-charts 有如下约定: | ||
|
||
1. 数据需要*尽量*使用指标维度的形式,具体可以参考[文档](https://v-charts.js.org/#/data)。 | ||
2. 指标维度的设置、数据类型、简化的配置项、数据别名 等通过在 settings 中增加的属性实现。 | ||
3. 组件除引入相应模块的依赖(eg: line)外,*尽量*不引入插件的依赖(eg: visualMap)。 | ||
|
||
## 环境搭建 | ||
|
||
- 安装依赖 `npm install` | ||
- 运行开发 `npm run dev` | ||
- 生成组件 `npm run build` | ||
- 运行文档 `npm run docs` | ||
- 运行测试 `npm run test` | ||
|
||
## 组件开发 | ||
|
||
开发新的图表组件,需要首先在 `src/packages` 下增加对应图表,然后在 `examples/data` | ||
下增加对应数据并在 `index.js` 中引入,最后在 `src/component-list`、`src/index.es.js`、 | ||
`src/index/index.js` 中增加对应的组件即可。开发完成后,需要在 `docs` 文件夹下, | ||
增加相应文档,并将文档加到侧边栏中。 | ||
|
||
## 代码规范 | ||
|
||
遵循 [standard](https://standardjs.com/) 即可。 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,107 @@ | ||
<p align="center"> | ||
<img src="./examples/favicon.ico" alt="mark text" width="100" height="100"> | ||
</p> | ||
|
||
<h3 align="center">v-charts</h3> | ||
|
||
<p align="center"> | ||
<a href="https://travis-ci.org/ElemeFE/v-charts"> | ||
<img src="https://travis-ci.org/ElemeFE/v-charts.svg?branch=master" alt="Build Status"> | ||
</a> | ||
<a href="https://npmjs.org/package/v-charts"> | ||
<img src="http://img.shields.io/npm/dm/v-charts.svg" alt="NPM downloads"> | ||
</a> | ||
<a href="https://www.npmjs.org/package/v-charts"> | ||
<img src="https://img.shields.io/npm/v/v-charts.svg" alt="Npm package"> | ||
</a> | ||
<a> | ||
<img src="https://img.shields.io/badge/language-javascript-yellow.svg" alt="Language"> | ||
</a> | ||
<a> | ||
<img src="https://img.shields.io/badge/license-MIT-000000.svg" alt="License"> | ||
</a> | ||
<a href="https://gitter.im/ElemeFE/v-charts?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge"> | ||
<img src="https://badges.gitter.im/ElemeFE/v-charts.svg" alt="Join the chat"> | ||
</a> | ||
</p> | ||
|
||
<p align="center"> | ||
<a href="https://v-charts.js.org"> | ||
文档 | ||
</a> | ||
<span> | </span> | ||
<a href="https://codesandbox.io/s/z69myovqzx"> | ||
示例项目 | ||
</a> | ||
<span> | </span> | ||
<a href="./README.md"> | ||
English | ||
</a> | ||
<span> | </span> | ||
<a> | ||
中文 | ||
</a> | ||
</p> | ||
|
||
> 基于 Vue2.x 封装的 Echarts 图表组件 | ||
## 特性 | ||
|
||
- **统一的数据格式:** 使用对前后端都友好的数据格式,方便生成和修改。 | ||
- **简化的配置项:** 通过简化的配置项,可以轻松实现复杂需求。 | ||
- **定制简单:** 提供多种自定义 Echarts 方式,可以方便的设置图表配置项。 | ||
|
||
## 支持性 | ||
|
||
支持所有现代浏览器及 IE10+ ,包括 pc 端和移动端。 | ||
|
||
## 安装 | ||
|
||
``` | ||
npm i v-charts echarts -S | ||
``` | ||
|
||
## 快速上手 | ||
--- | ||
|
||
```html | ||
<template> | ||
<div> | ||
<ve-line :data="chartData"></ve-line> | ||
</div> | ||
</template> | ||
|
||
<script> | ||
import VeLine from 'v-charts/lib/line.common' | ||
export default { | ||
created () { | ||
this.chartData = { | ||
columns: ['日期', '销售量'], | ||
rows: [ | ||
{ '日期': '1月1日', '销售量': 123 }, | ||
{ '日期': '1月2日', '销售量': 1223 }, | ||
{ '日期': '1月3日', '销售量': 2123 }, | ||
{ '日期': '1月4日', '销售量': 4123 }, | ||
{ '日期': '1月5日', '销售量': 3123 }, | ||
{ '日期': '1月6日', '销售量': 7123 } | ||
] | ||
} | ||
}, | ||
components: { VeLine } | ||
} | ||
</script> | ||
``` | ||
|
||
## 更新日志 | ||
|
||
[中文](./CHANGELOG_CN.md) | [English](./CHANGELOG.md) | ||
|
||
## 贡献 | ||
|
||
[中文](./CONTRIBUTING_CN.md) | [English](./CONTRIBUTING.md) | ||
|
||
|
||
## License | ||
|
||
MIT |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.