代码拉取完成,页面将自动刷新
简体中文 | English
📊📈 ECharts wrapper component for Vue 3, 2 and TypeScript
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 }); // use as a plugin
<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 }), // use as a component
},
data: () => ({
option: { /*...*/ },
}),
methods: {
doSomething() {
this.$refs.chart.inst.getWidth(); // call the method of ECharts instance
},
},
}
</script>
import Vue from 'vue';
import { plugin } from 'echarts-for-vue';
import * as echarts from 'echarts';
Vue.use(plugin, { echarts }); // use as a plugin
<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 }), // use as a component
},
data: () => ({
option: { /*...*/ },
}),
methods: {
doSomething() {
this.$refs.chart.inst.getWidth(); // call the method of ECharts instance
},
},
}
</script>
Definition | Return | Description |
---|---|---|
createComponent (options: Options): object |
Component definition object | Create a component |
plugin (app: Vue, options: Options): void |
The installation method of plugin |
Property | Type | Default | Optional | Description |
---|---|---|---|---|
echarts | typeof echarts | The global object of ECharts library | ||
h | Function | ✔ | The method createElement of Vue (Required for Vue 3) |
|
ResizeObserver | typeof ResizeObserver | window.ResizeObserver | ✔ | When the global ResizeObserver doesn't exist, the polyfill provides support |
name | string | "ECharts" | ✔ | The registered name of the component |
deepWatchOption | boolean | true | ✔ | deep watch prop "option" |
Name | Type | ReadOnly | Description |
---|---|---|---|
inst | ECharts | ✔ | ECharts instance |
Name | Type | Default | Reactive | Description |
---|---|---|---|---|
initTheme | object | string | ✔ | The parameter theme of echarts.init method, see
|
|
initOpts | object | ✔ | The parameter opts of echarts.init method, see
|
|
loading | boolean | false | ✔ | Shows loading animation |
loadingType | string | "default" | The parameter type of ECharts instance method showLoading , see
|
|
loadingOpts | EChartsLoadingOption | The parameter opts of ECharts instance method showLoading , see
|
||
option | EChartOption | ✔ | The parameter option of ECharts instance method setOption , see
|
|
optionOpts | EChartsOptionConfig | The parameter opts of ECharts instance method setOption , see
|
||
events | Arguments[] | An array element is the arguments of ECharts instance method on , see
|
||
autoResize | boolean | true | ✔ | Auto resize |
Beyond the props
above, the remaining properties are passed to the root element of the component, such as style
, class
or onclick
Name | Description |
---|---|
resize | Trigger when chart is resized |
Definition | Description |
---|---|
setOption (option: EChartOption, opts?: EChartsOptionConfig): void |
Call the method setOption of ECharts instance, see
|
resize (): void |
Resize chart (Based on the size of root element) |
addResizeListener (): void |
Add "resize" listener |
removeResizeListener (): void |
Remove "resize" listener |
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。