Skip to content

Commit 48791ba

Browse files
authored
Merge pull request #11 from ambit-tsai/dev
chore: update demo
2 parents 4e11450 + b4fc474 commit 48791ba

File tree

4 files changed

+23
-12
lines changed

4 files changed

+23
-12
lines changed

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@
1414

1515

1616
## Install
17-
`npm i -S echarts-for-vue`
17+
```
18+
npm i -S echarts-for-vue
19+
```
1820

1921

2022
## Usage
@@ -94,14 +96,14 @@ Vue.use(plugin, { echarts }); // use as a plugin
9496

9597

9698
## Global API
97-
|Definition|Return|Explanation|
99+
|Definition|Return|Description|
98100
|-|-|-|
99101
|`createComponent`(*initialOptions*: object): object|Component definition object|Create a component|
100102
|`plugin`(*app*: Vue, *initialOptions*: object): void||The installation method of plugin|
101103

102104

103105
## initialOptions
104-
|Property|Type|Default|Optional|Explanation|
106+
|Property|Type|Default|Optional|Description|
105107
|-|-|-|-|-|
106108
|echarts|object|||The global object of ECharts library|
107109
|h|function|||The method `createElement` of Vue (**Required** for Vue 3)|
@@ -110,13 +112,13 @@ Vue.use(plugin, { echarts }); // use as a plugin
110112

111113

112114
## Instance Properties
113-
|Name|Type|ReadOnly|Explanation|
115+
|Name|Type|ReadOnly|Description|
114116
|-|-|-|-|
115117
|inst|object||ECharts instance|
116118

117119

118120
## props
119-
|Name|Type|Default|Reactive|Explanation|
121+
|Name|Type|Default|Reactive|Description|
120122
|-|-|-|-|-|
121123
|initTheme|object \| string|||The parameter `theme` of `echarts.init` method, <a href="https://echarts.apache.org/en/api.html#echarts.init" target="_blank">see</a>|
122124
|initOpts|string|||The parameter `opts` of `echarts.init` method, <a href="https://echarts.apache.org/en/api.html#echarts.init" target="_blank">see</a>|
@@ -132,15 +134,15 @@ Vue.use(plugin, { echarts }); // use as a plugin
132134

133135

134136
## methods
135-
|Definition|Explanation|
137+
|Definition|Description|
136138
|-|-|
137139
|`setOption`(*option*: object, *opts*: object): void|Call the method `setOption` of ECharts instance, <a href="https://echarts.apache.org/en/api.html#echartsInstance.setOption" target="_blank">see</a>|
138140
|`resize`(): void|Resize chart (Based on the size of root element)|
139141
|`addResizeListener`(): void|Add "resize" listener|
140142
|`removeResizeListener`(): void|Remove "resize" listener|
141143

142144

143-
## Contact Us
145+
## Contact
144146
1. *WeChat*: ambit_tsai
145147
1. *QQ Group*: 663286147
146148
1. *E-mail*: [email protected]

README.zh-CN.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@
1414

1515

1616
## 安装
17-
`npm i -S echarts-for-vue`
17+
```
18+
npm i -S echarts-for-vue
19+
```
1820

1921

2022
## 用法

0 commit comments

Comments
 (0)