百科.dev
全部条目在线工具AI 编程趋势榜开源项目技术资讯提交条目
登录
< 返回工具列表
V

vue3-apexcharts

> 编程语言
开源

用于 ApexCharts 的 Vue 3 组件

367 stars0 点赞1 次浏览
访问官网GitHub

工具介绍

用于 ApexCharts 的 Vue 3 组件

Vue 3 component for ApexCharts to build interactive visualizations in vue.

Features

  • Reactive chart updates — change props and the chart re-renders automatically
  • Tree-shaking — import only the chart types and features you use via vue3-apexcharts/core
  • Server-Side Rendering (SSR) — render charts to HTML on the server with and hydrate on the client with
  • Full TypeScript support

Download and Installation

bash
npm install apexcharts vue3-apexcharts

If you're looking for Vue 2.x.x compatible component, check-out vue-apexcharts

Usage

javascript
import VueApexCharts from "vue3-apexcharts";

const app = createApp(App);
app.use(VueApexCharts);
// The app.use(VueApexCharts) will make  component available everywhere.

OR

javascript
// you can import in a particular component and register the component like below
import VueApexCharts from "vue3-apexcharts";
export default {
  components: {
    apexchart: VueApexCharts,
  },
};

To provide a $apexcharts reference inside Vue instance

typescript
import ApexCharts from "apexcharts";

app.config.globalProperties.$apexcharts = ApexCharts;

// Add this when into a TypeScript codebase
declare module "@vue/runtime-core" {
  interface ComponentCustomProperties {
    $apexcharts: typeof ApexCharts;
  }
}

To create a basic bar chart with minimal configuration, write as follows:

xml

  
javascript
export default {
  data: function () {
    return {
      chartOptions: {
        chart: {
          id: "vuechart-example",
        },
        xaxis: {
          categories: [1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998],
        },
      },
      series: [
        {
          name: "series-1",
          data: [30, 40, 35, 50, 49, 60, 70, 91],
        },
      ],
    };
  },
};

This will render the following chart

How do I update the chart?

Simple! Just change the series or any option and it will automatically re-render the chart. Click on the below example to see this in action

xml

  

  
…

Important: While updating the options, make sure to update the outermost property even when you need to update the nested property.

✅ Do this

javascript
this.chartOptions = {
  ...this.chartOptions,
  ...{
    xaxis: {
      labels: {
        style: {
          colors: ["red"],
        },
      },
    },
  },
};

❌ Not this

javascript
this.chartOptions.xaxis = {
    labels: {
        style: {
          colors: ['red']
        }
    }
}}

Props

Prop Type Description
series* Array The series is an array which accepts an object in the following format. To know more about the format of dataSeries, checkout Series docs on the website.
type* String line, area, bar, pie, donut, scatter, bubble, heatmap, radialBar, candlestick
width Number/String Possible values for width can be 100% or 400px or 400
height Number/String Possible values for height can be 100% or 300px or 300
options Object The configuration object, see options on API (Reference)

Methods

You don't actually need to call updateSeries() or updateOptions() manually. Changing the props will automatically update the chart. You only need to call these methods to update the chart forcefully.

Method Description
updateSeries Allows you to update the series array overriding the existing one
updateOptions Allows you to update the configuration object
toggleSeries Allows you to toggle the visibility of series programatically. Useful when you have custom legend.
appendData Allows you to append new data to the series array.
addXaxisAnnotation Draw x-axis annotations after chart is rendered.
addYaxisAnnotation Draw y-axis annotations after chart is rendered.
addPointAnnotation Draw point (xy) annotations after chart is rendered.

How to call methods of ApexCharts without referencing the chart element?

Sometimes, you may want to call methods of the core ApexCharts library from some other place, and you can do so on window.ApexCharts global variable directly. You need to target the chart by chart.id while calling this method

Example

javascript
window.ApexCharts.exec("vuechart-example", "updateSeries", [
  {
    data: [40, 55, 65, 11, 23, 44, 54, 33],
  },
]);

In the above method, vuechart-example is the ID of chart, updateSeries is the name of the method you want to call and the third parameter is the new Series you want to update.

More info on the .exec() method can be found here

All other methods of ApexCharts can be called the same way.

Tree-Shaking (Core Entry)

The default entry (vue3-apexcharts) bundles the full ApexCharts library. If you want to reduce your bundle size by importing only the chart types and features you need, use the core entry point:

javascript
import VueApexCharts from "vue3-apexcharts/core";

// Import by the exact chart type name you use in :type or chart.type
import "apexcharts/line";
import "apexcharts/bar";
import "apexcharts/donut";
import "apexcharts/treemap";

// Import only the features you need
import "apexcharts/features/legend";
import "apexcharts/features/toolbar";

const app = createApp(App);
app.use(VueApexCharts);

The core entry imports ApexCharts from apexcharts/core, which is the bare class with only tooltip included. You must explicitly import the chart types and optional features your app uses.

Each chart type has its own import that matches the type name you pass to the component — no need to know which internal module it maps to:

Chart types:

Import type string
apexcharts/line "line"
apexcharts/area "area"
apexcharts/scatter "scatter"
apexcharts/bubble "bubble"
apexcharts/rangeArea "rangeArea"
apexcharts/bar "bar"
apexcharts/column "column"
apexcharts/barStacked "barStacked"
apexcharts/rangeBar "rangeBar"
apexcharts/pie "pie"
apexcharts/donut "donut"
apexcharts/polarArea "polarArea"
apexcharts/radialBar "radialBar"
apexcharts/radar "radar"
apexcharts/candlestick "candlestick"
apexcharts/boxPlot "boxPlot"
apexcharts/heatmap "heatmap"
apexcharts/treemap "treemap"

Optional features:

Import Description
apexcharts/features/legend Chart legend
apexcharts/features/toolbar Toolbar (zoom, pan, download)
apexcharts/features/annotations X/Y-axis and point annotations
apexcharts/features/exports PNG/SVG/CSV export
apexcharts/features/keyboard Keyboard navigation & accessibility

Note: Tree-shaking requires ApexCharts v5.10.3+.

Server-Side Rendering (SSR)

Vue3-ApexCharts includes dedicated components for SSR that work with Nuxt 3 and other Vue SSR frameworks.

Note: SSR support requires ApexCharts v5.6.0+.

Nuxt 3 Setup

Register the plugin so that components are available during both server and client render passes:

typescript
// plugins/apexcharts.ts
import VueApexCharts from "vue3-apexcharts";

export default defineNuxtPlugin({
  name: "apexcharts",
  parallel: true,
  setup(nuxtApp) {
    nuxtApp.vueApp.use(VueApexCharts);
  },
});

Server-Side Rendering with ``

Render charts to HTML on the server — the chart markup is included in the initial page load for better SEO and faster perceived performance:

xml

  

SSR + Client Hydration

For interactive charts, pair server rendering with client-side hydration. The chart is rendered on the server, then `` finds all server-rendered charts on the page and attaches client-side interactivity (tooltips, animations, click handlers):

xml

  

  
  

Client-Only Rendering (Traditional)

For purely client-side rendering in Nuxt, wrap the standard component in ``:

xml

  
    
  

SSR Component Reference

``

Prop Type Default Description
type String 'line' Chart type
width Number/String 400 Chart width
height Number/String 300 Chart height
series Array [] Chart data series
options Object {} ApexCharts configuration
className String '' CSS class for the container

``

Prop Type Default Description
clientOptions Object {} Client-side options merged during hydration
selector String '[data-apexcharts-hydrate]' CSS selector for charts to hydrate

Running the examples

Basic Examples are included to show how to get started using ApexCharts with Vue 3 easily.

bash
cd demo
npm install
npm run dev

An SSR demo using Nuxt 3 is also available:

bash
cd demo-ssr
npm install
npm run dev

Development

Install dependencies

bash
npm install

Bundling

bash
npm run build

Running tests

bash
npm test

Issues· 0 开放

查看全部 Issues在 GitHub 打开

暂无开放 Issues,或尚未同步最近议题。

> 标签

TypeScript

暂无评论,来聊聊你的看法吧

> 工具信息

发布日期2026年8月1日
最后更新2026年9月17日
分类编程语言
定价开源

> 相关工具

T
TypeScript
JavaScript 的超集,为前端与全栈提供静态类型
P
Python
通用编程语言,广泛用于 Web、数据与 AI
G
Go
Google 推出的简洁高效系统语言