vue-echarts 6.6.4 → 6.6.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/README.md +10 -9
  2. package/README.zh-Hans.md +10 -9
  3. package/dist/index.d.ts +35 -34
  4. package/dist/index.vue2.d.ts +6 -3
  5. package/package.json +5 -1
  6. package/scripts/postinstall.js +3 -0
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  <h1 align="center">Vue-ECharts</h1>
2
2
 
3
- <p align="center">Vue.js <sup>(v2/v3)</sup> component for Apache ECharts <sup>(v5)</sup>.</p>
3
+ <p align="center">Vue.js <sup>(v2/v3)</sup> component for Apache ECharts™ <sup>(v5)</sup>.</p>
4
4
  <p align="center"><a href="https://vue-echarts.dev/">View Demo →</a></p>
5
5
  <p align="center"><a href="https:///pr.new/ecomfe/vue-echarts"><img alt="Open in Codeflow" src="https://developer.stackblitz.com/img/open_in_codeflow.svg" height="28"/></a> <a href="https://codesandbox.io/p/github/ecomfe/vue-echarts"><img alt="Edit in CodeSandbox" src="https://assets.codesandbox.io/github/button-edit-lime.svg" height="28"/></a></p>
6
6
 
@@ -23,17 +23,18 @@ Not ready yet? Read documentation for older versions [here →](https://github.c
23
23
 
24
24
  ### npm & ESM
25
25
 
26
- ```bash
27
- npm install echarts vue-echarts
26
+ ```sh
27
+ npm i echarts vue-echarts
28
28
  ```
29
29
 
30
- To make `vue-echarts` work for _Vue 2_ (<2.7.0), you need to have `@vue/composition-api` installed:
30
+ To make `vue-echarts` work for _Vue 2_ (<2.7.0), you need to have `@vue/composition-api` installed (`@vue/runtime-core` for TypeScript support):
31
31
 
32
32
  ```sh
33
33
  npm i @vue/composition-api
34
+ npm i @vue/runtime-core # for TypeScript support
34
35
  ```
35
36
 
36
- If you are using _NuxtJS_ on top of _Vue 2_, you'll also need `@nuxtjs/composition-api`:
37
+ If you are using _NuxtJS_ on top of _Vue 2_, you'll need `@nuxtjs/composition-api`:
37
38
 
38
39
  ```sh
39
40
  npm i @nuxtjs/composition-api
@@ -237,7 +238,7 @@ Drop `<script>` inside your HTML file and access the component via `window.VueEC
237
238
  ```html
238
239
  <script src="https://cdn.jsdelivr.net/npm/vue@3.3.7"></script>
239
240
  <script src="https://cdn.jsdelivr.net/npm/echarts@5.4.3"></script>
240
- <script src="https://cdn.jsdelivr.net/npm/vue-echarts@6.6.4"></script>
241
+ <script src="https://cdn.jsdelivr.net/npm/vue-echarts@6.6.6"></script>
241
242
  ```
242
243
  <!-- vue3Scripts:end -->
243
244
 
@@ -257,7 +258,7 @@ app.component('v-chart', VueECharts)
257
258
  ```html
258
259
  <script src="https://cdn.jsdelivr.net/npm/vue@2.7.15"></script>
259
260
  <script src="https://cdn.jsdelivr.net/npm/echarts@5.4.3"></script>
260
- <script src="https://cdn.jsdelivr.net/npm/vue-echarts@6.6.4"></script>
261
+ <script src="https://cdn.jsdelivr.net/npm/vue-echarts@6.6.6"></script>
261
262
  ```
262
263
  <!-- vue2Scripts:end -->
263
264
 
@@ -475,7 +476,7 @@ The following breaking changes are introduced in `vue-echarts@6`:
475
476
 
476
477
  ### Vue 2 support
477
478
 
478
- - If you are using version prior to `vue@2.7.0`, `@vue/composition-api` is required to be installed to use Vue-ECharts with Vue 2.
479
+ - If you are using version prior to `vue@2.7.0`, `@vue/composition-api` is required to be installed to use Vue-ECharts with Vue 2 (and also `@vue/runtime-core` for TypeScript support).
479
480
 
480
481
  ### Props
481
482
 
@@ -500,7 +501,7 @@ The following breaking changes are introduced in `vue-echarts@6`:
500
501
 
501
502
  ## Local development
502
503
 
503
- ```bash
504
+ ```sh
504
505
  pnpm i
505
506
  pnpm serve
506
507
  ```
package/README.zh-Hans.md CHANGED
@@ -1,6 +1,6 @@
1
1
  <h1 align="center">Vue-ECharts</h1>
2
2
 
3
- <p align="center">Apache ECharts <sup>(v5)</sup> 的 Vue.js <sup>(v2/v3)</sup> 组件。</p>
3
+ <p align="center">Apache ECharts™ <sup>(v5)</sup> 的 Vue.js <sup>(v2/v3)</sup> 组件。</p>
4
4
  <p align="center"><a href="https://vue-echarts.dev/">查看 Demo →</a></p>
5
5
  <p align="center"><a href="https:///pr.new/ecomfe/vue-echarts"><img alt="Open in Codeflow" src="https://developer.stackblitz.com/img/open_in_codeflow.svg" height="28"/></a> <a href="https://codesandbox.io/p/github/ecomfe/vue-echarts"><img alt="Edit in CodeSandbox" src="https://assets.codesandbox.io/github/button-edit-lime.svg" height="28"/></a></p>
6
6
 
@@ -23,17 +23,18 @@
23
23
 
24
24
  ### npm & ESM
25
25
 
26
- ```bash
27
- npm install echarts vue-echarts
26
+ ```sh
27
+ npm i echarts vue-echarts
28
28
  ```
29
29
 
30
- 要在 _Vue 2_（<2.7.0）下使用 `vue-echarts`，需要确保 `@vue/composition-api` 已经安装：
30
+ 要在 _Vue 2_（<2.7.0）下使用 `vue-echarts`，需要确保 `@vue/composition-api` 已经安装（TypeScript 支持还需要 `@vue/runtime-core`）：
31
31
 
32
32
  ```sh
33
33
  npm i @vue/composition-api
34
+ npm i @vue/runtime-core # TypeScript 支持
34
35
  ```
35
36
 
36
- 如果你在使用基于 _Vue 2_ 的 _NuxtJS_，那么还需要安装 `@nuxtjs/composition-api`：
37
+ 如果你在使用基于 _Vue 2_ 的 _NuxtJS_，则需要安装 `@nuxtjs/composition-api`：
37
38
 
38
39
  ```sh
39
40
  npm i @nuxtjs/composition-api
@@ -237,7 +238,7 @@ import "echarts";
237
238
  ```html
238
239
  <script src="https://cdn.jsdelivr.net/npm/vue@3.3.7"></script>
239
240
  <script src="https://cdn.jsdelivr.net/npm/echarts@5.4.3"></script>
240
- <script src="https://cdn.jsdelivr.net/npm/vue-echarts@6.6.4"></script>
241
+ <script src="https://cdn.jsdelivr.net/npm/vue-echarts@6.6.6"></script>
241
242
  ```
242
243
  <!-- vue3Scripts:end -->
243
244
 
@@ -257,7 +258,7 @@ app.component('v-chart', VueECharts)
257
258
  ```html
258
259
  <script src="https://cdn.jsdelivr.net/npm/vue@2.7.15"></script>
259
260
  <script src="https://cdn.jsdelivr.net/npm/echarts@5.4.3"></script>
260
- <script src="https://cdn.jsdelivr.net/npm/vue-echarts@6.6.4"></script>
261
+ <script src="https://cdn.jsdelivr.net/npm/vue-echarts@6.6.6"></script>
261
262
  ```
262
263
  <!-- vue2Scripts:end -->
263
264
 
@@ -475,7 +476,7 @@ import { THEME_KEY } from 'vue-echarts'
475
476
 
476
477
  ### Vue 2 支持
477
478
 
478
- - 要在 `vue@2.7.0` 之前的版本中使用 Vue-ECharts，必须安装 `@vue/composition-api`。
479
+ - 要在 `vue@2.7.0` 之前的版本中使用 Vue-ECharts，必须安装 `@vue/composition-api`（还需要安装 `@vue/runtime-core` 来支持 TypeScript）。
479
480
 
480
481
  ### Prop
481
482
 
@@ -500,7 +501,7 @@ import { THEME_KEY } from 'vue-echarts'
500
501
 
501
502
  ## 本地开发
502
503
 
503
- ```bash
504
+ ```sh
504
505
  pnpm i
505
506
  pnpm serve
506
507
  ```
package/dist/index.d.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  import { PropType, InjectionKey } from "vue-demi";
2
2
  import { Ref as Ref$0 } from "vue-demi";
3
3
  import { init } from "echarts/core";
4
- import { SetOptionOpts, ECElementEvent, ElementEvent, EChartsOption } from "echarts";
4
+ import { SetOptionOpts, ECElementEvent, ElementEvent } from "echarts";
5
5
  import { Ref } from "vue";
6
6
  type Injection<T> = T | null | Ref<T | null> | {
7
7
  value: T | null;
@@ -15,7 +15,8 @@ type InitOptionsInjection = Injection<InitOptions>;
15
15
  type UpdateOptions = SetOptionOpts;
16
16
  type UpdateOptionsInjection = Injection<UpdateOptions>;
17
17
  type EChartsType = ReturnType<InitType>;
18
- type Option = EChartsOption;
18
+ type SetOptionType = EChartsType["setOption"];
19
+ type Option = Parameters<SetOptionType>[0];
19
20
  type LoadingOptions = {
20
21
  text?: string;
21
22
  textColor?: string;
@@ -44,7 +45,7 @@ declare const _default: import("vue-demi").DefineComponent<{
44
45
  throttle?: number | undefined;
45
46
  onResize?: (() => void) | undefined;
46
47
  }>;
47
- option: PropType<import("echarts/types/dist/echarts").EChartsOption>;
48
+ option: PropType<import("echarts/types/dist/shared").ECBasicOption>;
48
49
  theme: {
49
50
  type: PropType<Theme>;
50
51
  };
@@ -182,44 +183,44 @@ declare const _default: import("vue-demi").DefineComponent<{
182
183
  } | undefined) => void;
183
184
  convertToPixel: {
184
185
  (finder: string | {
185
- seriesIndex?: (number | false | number[] | "none" | "all") | undefined;
186
+ seriesIndex?: (number | false | number[] | "all" | "none") | undefined;
186
187
  seriesId?: ((string | number) | (string | number)[]) | undefined;
187
188
  seriesName?: ((string | number) | (string | number)[]) | undefined;
188
- geoIndex?: (number | false | number[] | "none" | "all") | undefined;
189
+ geoIndex?: (number | false | number[] | "all" | "none") | undefined;
189
190
  geoId?: ((string | number) | (string | number)[]) | undefined;
190
191
  geoName?: ((string | number) | (string | number)[]) | undefined;
191
- bmapIndex?: (number | false | number[] | "none" | "all") | undefined;
192
+ bmapIndex?: (number | false | number[] | "all" | "none") | undefined;
192
193
  bmapId?: ((string | number) | (string | number)[]) | undefined;
193
194
  bmapName?: ((string | number) | (string | number)[]) | undefined;
194
- xAxisIndex?: (number | false | number[] | "none" | "all") | undefined;
195
+ xAxisIndex?: (number | false | number[] | "all" | "none") | undefined;
195
196
  xAxisId?: ((string | number) | (string | number)[]) | undefined;
196
197
  xAxisName?: ((string | number) | (string | number)[]) | undefined;
197
- yAxisIndex?: (number | false | number[] | "none" | "all") | undefined;
198
+ yAxisIndex?: (number | false | number[] | "all" | "none") | undefined;
198
199
  yAxisId?: ((string | number) | (string | number)[]) | undefined;
199
200
  yAxisName?: ((string | number) | (string | number)[]) | undefined;
200
- gridIndex?: (number | false | number[] | "none" | "all") | undefined;
201
+ gridIndex?: (number | false | number[] | "all" | "none") | undefined;
201
202
  gridId?: ((string | number) | (string | number)[]) | undefined;
202
203
  gridName?: ((string | number) | (string | number)[]) | undefined;
203
204
  dataIndex?: number | undefined;
204
205
  dataIndexInside?: number | undefined;
205
206
  }, value: (string | number) | Date): number;
206
207
  (finder: string | {
207
- seriesIndex?: (number | false | number[] | "none" | "all") | undefined;
208
+ seriesIndex?: (number | false | number[] | "all" | "none") | undefined;
208
209
  seriesId?: ((string | number) | (string | number)[]) | undefined;
209
210
  seriesName?: ((string | number) | (string | number)[]) | undefined;
210
- geoIndex?: (number | false | number[] | "none" | "all") | undefined;
211
+ geoIndex?: (number | false | number[] | "all" | "none") | undefined;
211
212
  geoId?: ((string | number) | (string | number)[]) | undefined;
212
213
  geoName?: ((string | number) | (string | number)[]) | undefined;
213
- bmapIndex?: (number | false | number[] | "none" | "all") | undefined;
214
+ bmapIndex?: (number | false | number[] | "all" | "none") | undefined;
214
215
  bmapId?: ((string | number) | (string | number)[]) | undefined;
215
216
  bmapName?: ((string | number) | (string | number)[]) | undefined;
216
- xAxisIndex?: (number | false | number[] | "none" | "all") | undefined;
217
+ xAxisIndex?: (number | false | number[] | "all" | "none") | undefined;
217
218
  xAxisId?: ((string | number) | (string | number)[]) | undefined;
218
219
  xAxisName?: ((string | number) | (string | number)[]) | undefined;
219
- yAxisIndex?: (number | false | number[] | "none" | "all") | undefined;
220
+ yAxisIndex?: (number | false | number[] | "all" | "none") | undefined;
220
221
  yAxisId?: ((string | number) | (string | number)[]) | undefined;
221
222
  yAxisName?: ((string | number) | (string | number)[]) | undefined;
222
- gridIndex?: (number | false | number[] | "none" | "all") | undefined;
223
+ gridIndex?: (number | false | number[] | "all" | "none") | undefined;
223
224
  gridId?: ((string | number) | (string | number)[]) | undefined;
224
225
  gridName?: ((string | number) | (string | number)[]) | undefined;
225
226
  dataIndex?: number | undefined;
@@ -228,44 +229,44 @@ declare const _default: import("vue-demi").DefineComponent<{
228
229
  };
229
230
  convertFromPixel: {
230
231
  (finder: string | {
231
- seriesIndex?: (number | false | number[] | "none" | "all") | undefined;
232
+ seriesIndex?: (number | false | number[] | "all" | "none") | undefined;
232
233
  seriesId?: ((string | number) | (string | number)[]) | undefined;
233
234
  seriesName?: ((string | number) | (string | number)[]) | undefined;
234
- geoIndex?: (number | false | number[] | "none" | "all") | undefined;
235
+ geoIndex?: (number | false | number[] | "all" | "none") | undefined;
235
236
  geoId?: ((string | number) | (string | number)[]) | undefined;
236
237
  geoName?: ((string | number) | (string | number)[]) | undefined;
237
- bmapIndex?: (number | false | number[] | "none" | "all") | undefined;
238
+ bmapIndex?: (number | false | number[] | "all" | "none") | undefined;
238
239
  bmapId?: ((string | number) | (string | number)[]) | undefined;
239
240
  bmapName?: ((string | number) | (string | number)[]) | undefined;
240
- xAxisIndex?: (number | false | number[] | "none" | "all") | undefined;
241
+ xAxisIndex?: (number | false | number[] | "all" | "none") | undefined;
241
242
  xAxisId?: ((string | number) | (string | number)[]) | undefined;
242
243
  xAxisName?: ((string | number) | (string | number)[]) | undefined;
243
- yAxisIndex?: (number | false | number[] | "none" | "all") | undefined;
244
+ yAxisIndex?: (number | false | number[] | "all" | "none") | undefined;
244
245
  yAxisId?: ((string | number) | (string | number)[]) | undefined;
245
246
  yAxisName?: ((string | number) | (string | number)[]) | undefined;
246
- gridIndex?: (number | false | number[] | "none" | "all") | undefined;
247
+ gridIndex?: (number | false | number[] | "all" | "none") | undefined;
247
248
  gridId?: ((string | number) | (string | number)[]) | undefined;
248
249
  gridName?: ((string | number) | (string | number)[]) | undefined;
249
250
  dataIndex?: number | undefined;
250
251
  dataIndexInside?: number | undefined;
251
252
  }, value: number): number;
252
253
  (finder: string | {
253
- seriesIndex?: (number | false | number[] | "none" | "all") | undefined;
254
+ seriesIndex?: (number | false | number[] | "all" | "none") | undefined;
254
255
  seriesId?: ((string | number) | (string | number)[]) | undefined;
255
256
  seriesName?: ((string | number) | (string | number)[]) | undefined;
256
- geoIndex?: (number | false | number[] | "none" | "all") | undefined;
257
+ geoIndex?: (number | false | number[] | "all" | "none") | undefined;
257
258
  geoId?: ((string | number) | (string | number)[]) | undefined;
258
259
  geoName?: ((string | number) | (string | number)[]) | undefined;
259
- bmapIndex?: (number | false | number[] | "none" | "all") | undefined;
260
+ bmapIndex?: (number | false | number[] | "all" | "none") | undefined;
260
261
  bmapId?: ((string | number) | (string | number)[]) | undefined;
261
262
  bmapName?: ((string | number) | (string | number)[]) | undefined;
262
- xAxisIndex?: (number | false | number[] | "none" | "all") | undefined;
263
+ xAxisIndex?: (number | false | number[] | "all" | "none") | undefined;
263
264
  xAxisId?: ((string | number) | (string | number)[]) | undefined;
264
265
  xAxisName?: ((string | number) | (string | number)[]) | undefined;
265
- yAxisIndex?: (number | false | number[] | "none" | "all") | undefined;
266
+ yAxisIndex?: (number | false | number[] | "all" | "none") | undefined;
266
267
  yAxisId?: ((string | number) | (string | number)[]) | undefined;
267
268
  yAxisName?: ((string | number) | (string | number)[]) | undefined;
268
- gridIndex?: (number | false | number[] | "none" | "all") | undefined;
269
+ gridIndex?: (number | false | number[] | "all" | "none") | undefined;
269
270
  gridId?: ((string | number) | (string | number)[]) | undefined;
270
271
  gridName?: ((string | number) | (string | number)[]) | undefined;
271
272
  dataIndex?: number | undefined;
@@ -273,22 +274,22 @@ declare const _default: import("vue-demi").DefineComponent<{
273
274
  }, value: number[]): number[];
274
275
  };
275
276
  containPixel: (finder: string | {
276
- seriesIndex?: (number | false | number[] | "none" | "all") | undefined;
277
+ seriesIndex?: (number | false | number[] | "all" | "none") | undefined;
277
278
  seriesId?: ((string | number) | (string | number)[]) | undefined;
278
279
  seriesName?: ((string | number) | (string | number)[]) | undefined;
279
- geoIndex?: (number | false | number[] | "none" | "all") | undefined;
280
+ geoIndex?: (number | false | number[] | "all" | "none") | undefined;
280
281
  geoId?: ((string | number) | (string | number)[]) | undefined;
281
282
  geoName?: ((string | number) | (string | number)[]) | undefined;
282
- bmapIndex?: (number | false | number[] | "none" | "all") | undefined;
283
+ bmapIndex?: (number | false | number[] | "all" | "none") | undefined;
283
284
  bmapId?: ((string | number) | (string | number)[]) | undefined;
284
285
  bmapName?: ((string | number) | (string | number)[]) | undefined;
285
- xAxisIndex?: (number | false | number[] | "none" | "all") | undefined;
286
+ xAxisIndex?: (number | false | number[] | "all" | "none") | undefined;
286
287
  xAxisId?: ((string | number) | (string | number)[]) | undefined;
287
288
  xAxisName?: ((string | number) | (string | number)[]) | undefined;
288
- yAxisIndex?: (number | false | number[] | "none" | "all") | undefined;
289
+ yAxisIndex?: (number | false | number[] | "all" | "none") | undefined;
289
290
  yAxisId?: ((string | number) | (string | number)[]) | undefined;
290
291
  yAxisName?: ((string | number) | (string | number)[]) | undefined;
291
- gridIndex?: (number | false | number[] | "none" | "all") | undefined;
292
+ gridIndex?: (number | false | number[] | "all" | "none") | undefined;
292
293
  gridId?: ((string | number) | (string | number)[]) | undefined;
293
294
  gridName?: ((string | number) | (string | number)[]) | undefined;
294
295
  dataIndex?: number | undefined;
@@ -389,7 +390,7 @@ declare const _default: import("vue-demi").DefineComponent<{
389
390
  throttle?: number | undefined;
390
391
  onResize?: (() => void) | undefined;
391
392
  }>;
392
- option: PropType<import("echarts/types/dist/echarts").EChartsOption>;
393
+ option: PropType<import("echarts/types/dist/shared").ECBasicOption>;
393
394
  theme: {
394
395
  type: PropType<Theme>;
395
396
  };
package/dist/index.vue2.d.ts CHANGED
@@ -1,6 +1,7 @@
1
- import { DefineComponent, Ref } from 'vue-demi';
1
+ import { DefineComponent } from '@vue/runtime-core';
2
+ import { Ref } from 'vue-demi';
2
3
  import { init } from 'echarts/core';
3
- import { SetOptionOpts, EChartsOption, ECElementEvent, ElementEvent } from 'echarts';
4
+ import { SetOptionOpts, ECElementEvent, ElementEvent } from 'echarts';
4
5
 
5
6
  type InitType = typeof init;
6
7
  type InitParameters = Parameters<InitType>;
@@ -9,7 +10,9 @@ type InitOptions = NonNullable<InitParameters[2]>;
9
10
  type UpdateOptions = SetOptionOpts;
10
11
 
11
12
  type EChartsType = ReturnType<InitType>;
12
- type Option = EChartsOption;
13
+
14
+ type SetOptionType = EChartsType["setOption"];
15
+ type Option = Parameters<SetOptionType>[0];
13
16
 
14
17
  type MouseEventName =
15
18
  | "click"
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "vue-echarts",
3
- "version": "6.6.4",
3
+ "version": "6.6.6",
4
4
  "description": "Vue.js component for Apache ECharts.",
5
5
  "author": "GU Yiling <justice360@gmail.com>",
6
6
  "main": "dist/index.cjs.min.js",
@@ -62,6 +62,7 @@
62
62
  },
63
63
  "peerDependencies": {
64
64
  "@vue/composition-api": "^1.0.5",
65
+ "@vue/runtime-core": "^3.0.0",
65
66
  "echarts": "^5.4.1",
66
67
  "vue": "^2.6.12 || ^3.1.1"
67
68
  },
@@ -70,6 +71,9 @@
70
71
  "peerDependenciesMeta": {
71
72
  "@vue/composition-api": {
72
73
  "optional": true
74
+ },
75
+ "@vue/runtime-core": {
76
+ "optional": true
73
77
  }
74
78
  },
75
79
  "repository": "https://github.com/ecomfe/vue-echarts.git",
package/scripts/postinstall.js CHANGED
@@ -6,6 +6,7 @@ const packageFile = path.resolve(__dirname, "../package.json");
6
6
 
7
7
  const typesPaths = {
8
8
  3: "dist/index.d.ts",
9
+ 2.7: "dist/index.vue2-7.d.ts",
9
10
  2: "dist/index.vue2.d.ts"
10
11
  };
11
12
 
@@ -36,6 +37,8 @@ if (!Vue || typeof Vue.version !== "string") {
36
37
  );
37
38
  } else if (Vue.version.startsWith("3.")) {
38
39
  switchVersion(3);
40
+ } else if (Vue.version.startsWith("2.7.")) {
41
+ switchVersion(2.7);
39
42
  } else if (Vue.version.startsWith("2.")) {
40
43
  switchVersion(2);
41
44
  } else {