Vue-ECharts
ECharts 的 Vue.js 組件。
基于 ECharts v4.1.0+ 開發(fā),依賴 Vue.js v2.2.6+。
安裝
npm(推薦方式)
$ npm install echarts vue-echarts
CDN
在 HTML 文件按如下方式依次引入 echarts 和 vue-echarts:
<script src="https://cdn.jsdelivr.net/npm/echarts@4.1.0/dist/echarts.js"></script>
<script src="https://cdn.jsdelivr.net/npm/vue-echarts@4.0.2"></script>
使用方法
用 npm 與 Vue Loader 基于 ES Module 引入(推薦用法)
import Vue from 'vue'
import ECharts from 'vue-echarts' // 在 webpack 環(huán)境下指向 components/ECharts.vue
// 手動引入 ECharts 各模塊來減小打包體積
import 'echarts/lib/chart/bar'
import 'echarts/lib/component/tooltip'
// 如果需要配合 ECharts 擴展使用,只需要直接引入擴展包即可
// 以 ECharts-GL 為例:
// 需要安裝依賴:npm install --save echarts-gl,并添加如下引用
import 'echarts-gl'
// 注冊組件后即可使用
Vue.component('v-chart', ECharts)
?? 注意事項
引入源碼版本
Vue-ECharts 默認在 webpack 環(huán)境下會引入未編譯的源碼版本,如果你正在使用官方的 Vue CLI 來創(chuàng)建項目,可能會遇到默認配置把 node_modules 中的文件排除在 Babel 轉譯范圍以外的問題。請按如下方法修改配置:
當使用 Vue CLI 3+ 時,需要在 vue.config.js 中的 transpileDependencies 增加 vue-echarts 及 resize-detector,如下:
// vue.config.js
module.exports = {
transpileDependencies: [
'vue-echarts',
'resize-detector'
]
}
當使用 Vue CLI 2 的 webpack 模板時,需要按下述的方式修改 build/webpack.base.conf.js:
{
test: /\.js$/,
loader: 'babel-loader',
- include: [resolve('src'), resolve('test')]
+ include: [
+ resolve('src'),
+ resolve('test'),
+ resolve('node_modules/vue-echarts'),
+ resolve('node_modules/resize-detector')
+ ]
}
如果你正直接配置使用 webpack,那么也請做類似的修改使其能夠正常工作。
在 Nuxt.js 中使用
在 Nuxt.js 的服務端中使用 Vue-ECharts 時,可能沒有正常轉譯。這是因為 Nuxt.js 默認會將 node_modules 目錄下的絕大多數(shù)文件被排除在服務端打包代碼以外。需要手動將 vue-echarts 加入白名單。
對于 Nuxt.js v2 項目,按如下方式修改 nuxt.config.js:
module.exports = {
build: {
transpile: ['vue-echarts', 'resize-detector']
}
}
對于 Nuxt.js v1 項目,按如下方式修改 nuxt.config.js:
// 別忘了運行
// npm i --save-dev webpack-node-externals
const nodeExternals = require('webpack-node-externals')
module.exports = {
// ...
build: {
extend (config, { isServer }) {
// ...
if (isServer) {
config.externals = [
nodeExternals({
// `whitelist` 選項的默認值是
// [/es6-promise|\.(?!(?:js|json)$).{1,5}$/i]
whitelist: [/es6-promise|\.(?!(?:js|json)$).{1,5}$/i, /^vue-echarts/]
})
]
}
}
}
}
AMD
require.config({
paths: {
'vue': 'path/to/vue',
'echarts': 'path/to/echarts',
'vue-echarts': 'path/to/vue-ehcarts'
}
})
require(['vue', 'vue-echarts'], function (Vue, ECharts) {
// 注冊組件后即可使用
Vue.component('v-chart', ECharts)
})
全局變量
在沒有使用任何模塊系統(tǒng)的情況下,組件將通過 window.VueECharts 變量暴露接口:
// 注冊組件后即可使用
Vue.component('v-chart', VueECharts)
調(diào)用組件
<template>
<v-chart :options="polar"/>
</template>
<style>
/**
* 默認尺寸為 600px×400px,如果想讓圖表響應尺寸變化,可以像下面這樣
* 把尺寸設為百分比值(同時請記得為容器設置尺寸)。
*/
.echarts {
width: 100%;
height: 100%;
}
</style>
<script>
import ECharts from 'vue-echarts'
import 'echarts/lib/chart/line'
import 'echarts/lib/component/polar'
export default {
components: {
'v-chart': ECharts
},
data () {
let data = []
for (let i = 0; i <= 360; i++) {
let t = i / 180 * Math.PI
let r = Math.sin(2 * t) * Math.cos(2 * t)
data.push([r, i])
}
return {
polar: {
title: {
text: '極坐標雙數(shù)值軸'
},
legend: {
data: ['line']
},
polar: {
center: ['50%', '54%']
},
tooltip: {
trigger: 'axis',
axisPointer: {
type: 'cross'
}
},
angleAxis: {
type: 'value',
startAngle: 0
},
radiusAxis: {
min: 0
},
series: [
{
coordinateSystem: 'polar',
name: 'line',
type: 'line',
showSymbol: false,
data: data
}
],
animationDuration: 2000
}
}
}
}
</script>
查看這里了解更多例子。
Props (均為響應式)
-
initOptions用來初始化 ECharts 實例。
-
theme當前 ECharts 實例使用的主題。
-
optionsECharts 實例的數(shù)據(jù)。修改這個 prop 會觸發(fā) ECharts 實例的
setOption方法。如果直接修改
options綁定的數(shù)據(jù)而對象引用保持不變,setOption方法調(diào)用時將帶有參數(shù)notMerge: false。否則,如果為options綁定一個新的對象,setOption方法調(diào)用時則將帶有參數(shù)notMerge: true。例如,如果有如下模板:
<v-chart :options="data"/>那么:
this.data = newObject // setOption(this.options, true) this.data.title.text = 'Trends' // setOption(this.options, false) -
group實例的分組,會自動綁定到 ECharts 組件的同名屬性上。
-
autoresize(默認值:false)這個 prop 用來指定 ECharts 實例在組件根元素尺寸變化時是否需要自動進行重繪。
-
manual-update(默認值:false)在性能敏感(數(shù)據(jù)量很大)的場景下,我們最好對于
optionsprop 繞過 Vue 的響應式系統(tǒng)。當將manual-updateprop 指定為true且不傳入optionsprop 時,數(shù)據(jù)將不會被監(jiān)聽。然后,你需要用ref獲取組件實例以后手動調(diào)用mergeOptions方法來更新圖表。
計算屬性
-
width[只讀]用來獲取 ECharts 實例的當前寬度。
-
height[只讀]用來獲取 ECharts 實例的當前高度。
-
computedOptions[只讀]用來讀取 ECharts 更新內(nèi)部
options后的實際數(shù)據(jù)。
方法
-
mergeOptions(底層調(diào)用了 ECharts 實例的setOption方法)提供了一個更貼切的名稱來描述
setOption方法的實際行為。 appendDataresizedispatchActionshowLoadinghideLoadingconvertToPixelconvertFromPixelcontainPixelgetDataURLgetConnectedDataURLcleardispose
靜態(tài)方法
connectdisconnectregisterMapregisterThemegraphic.clipPointsByRectgraphic.clipRectByRect
事件
Vue-ECharts 支持如下事件:
legendselectchangedlegendselectedlegendunselectedlegendscrolldatazoomdatarangeselectedtimelinechangedtimelineplaychangedrestoredataviewchangedmagictypechangedgeoselectchangedgeoselectedgeounselectedpieselectchangedpieselectedpieunselectedmapselectchangedmapselectedmapunselectedaxisareaselectedfocusnodeadjacencyunfocusnodeadjacencybrushbrushselectedrenderedfinished- 鼠標事件
clickdblclickmouseovermouseoutmousemovemousedownmouseupglobaloutcontextmenu
- ZRender 事件 (v4.1.0 新增)
clickmousedownmouseupmousewheeldblclickcontextmenu
更多詳細信息請參考 ECharts 的 API 文檔。
本地開發(fā)
$ npm i
$ npm run dev
打開 http://localhost:8080/demo 來查看 demo。