Skip to content

Commit

Permalink
docs: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
xiaoluoboding committed Jan 7, 2020
1 parent aab9513 commit ac546e3
Show file tree
Hide file tree
Showing 6 changed files with 48 additions and 36 deletions.
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ npm i ve-charts echarts -S
```js
import Vue from 'vue'
import VeCharts from 've-charts'
import 've-charts/lib/ve-charts.min.css'

Vue.use(VeCharts)
```
Expand Down
5 changes: 1 addition & 4 deletions docs/base-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ npm i ve-charts echarts -S
```js
import Vue from 'vue'
import VeCharts from 've-charts'
import 've-charts/lib/ve-charts.min.css'

Vue.use(VeCharts)
```
Expand All @@ -26,9 +25,7 @@ Vue.use(VeCharts)

```js
import Vue from 'vue'
import 've-charts/lib/common' // 公共chuck,引入单个图表前需引入公共包
import VeBarChart from 've-charts/lib/VeBarChart' // 单个图表chuck
import 've-charts/lib/ve-charts.min.css' // **按需引入** 同样需要引入样式
import { VeBarChart } from 've-charts' // 引入单个图表

Vue.component('VeBarChart', VeBarChart)
```
Expand Down
8 changes: 8 additions & 0 deletions docs/change-log.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# 更新日志

## v0.8.4

* **升级** - 升级 `echarts` 至 v0.4.6
* **新增** - 极区图(极地图)
* **新增** - 饼图 / 环形图支持默认选中多少个 legend
* **新增** - 折线图支持堆叠面积图,百分比堆叠面积图
* **新增** - 折线图支持自定义系列颜色

## v0.8.3

* **修复** - 获取不到维度名称导致的渲染bug
Expand Down
58 changes: 29 additions & 29 deletions docs/chart-line.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,35 @@
}
</script>

## 折线图设置 - 平滑曲线

<vuep template="#smoothLine" :options="{ theme: 'vue', lineNumbers: false }"></vuep>

<script v-pre type="text/x-template" id="smoothLine">
<template>
<ve-line-chart :data="chartData" :settings="chartSettings" />
</template>

<script>
module.exports = {
created () {
this.chartData = {
dimensions: {
name: 'Week',
data: ['Mon.', 'Tue.', 'Wed.', 'Thu.', 'Fir.', 'Sat.', 'Sun.']
},
measures: [{
name: 'Vue',
data: [30, 40, 35, 50, 49, 70, 90]
}]
}
this.chartSettings = {
smooth: true
}
}
}
</script>

## 区域折线图

<vuep template="#areaLine" :options="{ theme: 'vue', lineNumbers: false }"></vuep>
Expand Down Expand Up @@ -203,35 +232,6 @@
}
</script>

## 折线图设置 - 平滑曲线

<vuep template="#smoothLine" :options="{ theme: 'vue', lineNumbers: false }"></vuep>

<script v-pre type="text/x-template" id="smoothLine">
<template>
<ve-line-chart :data="chartData" :settings="chartSettings" />
</template>

<script>
module.exports = {
created () {
this.chartData = {
dimensions: {
name: 'Week',
data: ['Mon.', 'Tue.', 'Wed.', 'Thu.', 'Fir.', 'Sat.', 'Sun.']
},
measures: [{
name: 'Vue',
data: [30, 40, 35, 50, 49, 70, 90]
}]
}
this.chartSettings = {
smooth: true
}
}
}
</script>

## 折线图设置 - 数据标签

<vuep template="#labelLine" :options="{ theme: 'vue', lineNumbers: false }"></vuep>
Expand Down
11 changes: 10 additions & 1 deletion docs/chart-polar.md
Original file line number Diff line number Diff line change
Expand Up @@ -233,4 +233,13 @@
}
}
}
</script>
</script>

## settings 配置项

| 配置项 | 说明 | 类型 | 可选值 | 用法 |
| --- | --- | --- | --- | --- |
| polarType | 渲染 polar 的系列类型 | String | `bar``line` | - |
| stack | 设置数据堆叠 | Object | - | |
| areaStyle | 设置面积图,当 polarType 为 `line` 时生效 | Object | - | |
| radial | 设置数据展示方式 | Boolean | `true`:径向、`false`:环形 | 默认:`false`,代表环形 |
1 change: 0 additions & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@
<link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css"/>
<!-- inject css file -->
<link rel="stylesheet" href="//unpkg.com/vuep/dist/vuep.css"/>
<link rel="stylesheet" type="text/css" href="//unpkg.com/ve-charts@latest/lib/ve-charts.min.css"/>
<link rel="stylesheet" href="vue.css">
<link rel="stylesheet" href="styles.css"/>
</head>
Expand Down

0 comments on commit ac546e3

Please sign in to comment.