代码拉取完成,页面将自动刷新
简体中文 | English
📊📈 适用于 Vue 3、2 和 TypeScript 的 ECharts 包装组件
npm i -S echarts-for-vue
import { createApp, h } from 'vue';
import { plugin } from 'echarts-for-vue';
import * as echarts from 'echarts';
const app = createApp({ /*...*/ });
app.use(plugin, { echarts, h }); // 作为插件使用
<template>
<ECharts ref="chart" :option="option" />
</template>
<script>
import { createComponent } from 'echarts-for-vue';
import * as echarts from 'echarts';
import { h } from 'vue';
export default {
components: {
ECharts: createComponent({ echarts, h }), // 作为组件使用
},
data: () => ({
option: { /*...*/ },
}),
methods: {
doSomething() {
this.$refs.chart.inst.getWidth(); // 调用 ECharts 实例的方法
},
},
}
</script>
import Vue from 'vue';
import { plugin } from 'echarts-for-vue';
import * as echarts from 'echarts';
Vue.use(plugin, { echarts }); // 作为插件使用
<template>
<ECharts ref="chart" :option="option" />
</template>
<script>
import { createComponent } from 'echarts-for-vue';
import * as echarts from 'echarts';
export default {
components: {
ECharts: createComponent({ echarts }), // 作为组件使用
},
data: () => ({
option: { /*...*/ },
}),
methods: {
doSomething() {
this.$refs.chart.inst.getWidth(); // 调用 ECharts 实例的方法
},
},
}
</script>
定义 | 返回值 | 说明 |
---|---|---|
createComponent (options: Options): object |
组件定义对象 | 创建组件 |
plugin (app: Vue, options: Options): void |
插件的安装方法 |
属性 | 类型 | 默认值 | 可选 | 说明 |
---|---|---|---|---|
echarts | typeof echarts | ECharts 库的全局对象 | ||
h | Function | ✔ | Vue 的 createElement 方法(使用 Vue 3 时,是必选的) |
|
ResizeObserver | typeof ResizeObserver | window.ResizeObserver | ✔ | 全局 ResizeObserver 不存在时,可通过 polyfill 提供支持 |
name | string | "ECharts" | ✔ | 组件的注册名称 |
deepWatchOption | boolean | true | ✔ | 深度监听属性 “option” |
名称 | 类型 | 只读 | 说明 |
---|---|---|---|
inst | ECharts | ✔ | ECharts 实例 |
名称 | 类型 | 默认值 | 响应性 | 说明 |
---|---|---|---|---|
initTheme | object | string | ✔ |
echarts.init 方法的入参 theme ,详见
|
|
initOpts | object | ✔ |
echarts.init 方法的入参 opts ,详见
|
|
loading | boolean | false | ✔ | 显示加载动画效果 |
loadingType | string | "default" | ECharts 实例 showLoading 方法的入参 type ,详见
|
|
loadingOpts | EChartsLoadingOption | ECharts 实例 showLoading 方法的入参 opts ,详见
|
||
option | EChartOption | ✔ | ECharts 实例 setOption 方法的入参 option ,详见
|
|
optionOpts | EChartsOptionConfig | ECharts 实例 setOption 方法的入参 opts ,详见
|
||
events | Arguments[] | 数组元素为 ECharts 实例 on 方法的入参,详见
|
||
autoResize | boolean | true | ✔ | 自动调整大小 |
除了上述 props
,其余属性将被传递给组件的根元素,如:style
、class
、onclick
等
名称 | 说明 |
---|---|
resize | 图表大小调整时触发 |
定义 | 说明 |
---|---|
setOption (option: EChartOption, opts?: EChartsOptionConfig): void |
调用 ECharts 实例的 setOption 方法,详见
|
resize (): void |
调整图表大小(以组件根元素大小为基准) |
addResizeListener (): void |
添加 resize 监听器 |
removeResizeListener (): void |
移除 resize 监听器 |
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。