GitHub - ecomfe/vue-echarts at 6.x (original) (raw)

Vue-ECharts

Vue.js (v2/v3) component for Apache EChartsβ„’ (v5).

View Demo β†’

Open in Codeflow Edit in CodeSandbox

πŸ’‘ Heads up πŸ’‘ ε‰εΎ€δΈ­ζ–‡η‰ˆ

If you are migrating from vue-echarts ≀ 5, you should read the Migration to v6 section before you update to v6.

Not ready yet? Read documentation for older versions here β†’

Installation & Usage

npm & ESM

npm i echarts vue-echarts

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):

npm i @vue/composition-api npm i @vue/runtime-core # for TypeScript support

If you are using NuxtJS on top of Vue 2, you'll need @nuxtjs/composition-api:

npm i @nuxtjs/composition-api

And then add '@nuxtjs/composition-api/module' in the buildModules option in your nuxt.config.js.

Example

Vue 3 Demo β†’

Vue 2 Demo β†’

Important

We encourage manually importing components and charts from ECharts for smaller bundle size. We've built an import code generator to help you with that. You can just paste in your option code and we'll generate the precise import code for you.

Try it β†’

But if you really want to import the whole ECharts bundle without having to import modules manually, just add this in your code:

CDN & Global variable

Drop <script> inside your HTML file and access the component via window.VueECharts.

Vue 3 Demo β†’

const app = Vue.createApp(...)

// register globally (or you can do it locally) app.component('v-chart', VueECharts)

Vue 2 Demo β†’

// register globally (or you can do it locally) Vue.component("v-chart", VueECharts);

See more examples here.

Props

Events

You can bind events with Vue's v-on directive.

Note

Only the .once event modifier is supported as other modifiers are tightly coupled with the DOM event system.

Vue-ECharts support the following events:

See supported events here β†’

Native DOM Events

As Vue-ECharts binds events to the ECharts instance by default, there is some caveat when using native DOM events. You need to prefix the event name with native: to bind native DOM events (or you can use the .native modifier in Vue 2, which is dropped in Vue 3).

Provide / Inject

Vue-ECharts provides provide/inject API for theme, init-options, update-options and loading-options to help configuring contextual options. eg. for init-options you can use the provide API like this:

Vue 3

import { THEME_KEY } from 'vue-echarts' import { provide } from 'vue'

// composition API provide(THEME_KEY, 'dark')

// options API { provide: { [THEME_KEY]: 'dark' } }

Vue 2

import { THEME_KEY } from 'vue-echarts'

// in component options { provide: { [THEME_KEY]: 'dark' } }

Note

You need to provide an object for Vue 2 if you want to change it dynamically.

// in component options { data () { return { theme: { value: 'dark' } } }, provide () { return { [THEME_KEY]: this.theme } } }

Methods

Static Methods

Static methods can be accessed from echarts itself.

CSP: style-src or style-src-elem

If you are applying a CSP to prevent inline <style> injection, you need to use files from dist/csp directory and include dist/csp/style.css into your app manually.

Migration to v6

πŸ’‘ Please make sure to read the migration guide for ECharts 5 as well.

The following breaking changes are introduced in vue-echarts@6:

Vue 2 support

Props

Methods

Computed getters

Styles

Local development

Open http://localhost:8080 to see the demo.

Notice

The Apache Software Foundation Apache ECharts, ECharts, Apache, the Apache feather, and the Apache ECharts project logo are either registered trademarks or trademarks of the Apache Software Foundation.