npmpackage.info

Gathering detailed insights and metrics for vue3-apexcharts

Other packages similar to vue3-apexcharts

vue-apexcharts

1.7.0

Vue.js wrapper for ApexCharts

react-apexcharts

1.6.0

React.js wrapper for ApexCharts

apexcharts

4.1.0

A JavaScript Chart Library

ng-apexcharts

1.15.0

An angular implementation of ApexCharts

Gathering detailed insights and metrics for vue3-apexcharts

vue3-apexcharts

📊 Vue-3 component for ApexCharts

1.8.0

314

MIT

JavaScript

1.29 kB

9,072,239 4.3

Installations

npm install vue3-apexcharts

Pull Requests

Open

0

Total

15

Closed

3

Merged

12

Issues

Open

37

Total

117

Closed

80

Releases

Unable to fetch releases

Developer

apexcharts

Developer Guide

BETA

Module System

ESM

Min. Node Version

Typescript Support

No

Node Version

22.2.0

NPM Version

10.7.0 Statistics

314 Stars

73 Commits

35 Forks

6 Watching

1 Branches

13 Contributors

Updated on 22 Nov 2024

Bundle Size

3.17 kB

Minified

1.29 kB

Minified + Gzipped

Bundlephobia

Languages

JavaScript (85.05%)

TypeScript (8.59%)

HTML (6.35%)

Total Downloads

Cumulative downloads

Total Downloads

9,072,239

Last day

6.7%

30,550

Compared to previous day

Last week

11.8%

155,313

Compared to previous week

Last month

10.7%

625,029

Compared to previous month

Last year

92.5%

5,232,907

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Peer Dependencies

vue apexcharts

Dev Dependencies

@types/node @vitejs/plugin-vue typescript vite vue-tsc apexcharts vue copyfiles

Versions

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

Download and Installation

Installing via npm

1npm install --save apexcharts
2npm install --save vue3-apexcharts

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

Usage

1import VueApexCharts from "vue3-apexcharts";
2
3const app = createApp(App);
4app.use(VueApexCharts);
5// The app.use(VueApexCharts) will make <apexchart> component available everywhere.

1// you can import in a particular component and register the component like below
2import VueApexCharts from "vue3-apexcharts";
3export default {
4  components: {
5    apexchart: VueApexCharts,
6  },
7};

To provide a $apexcharts reference inside Vue instance

1import ApexCharts from "apexcharts";
2
3app.config.globalProperties.$apexcharts = ApexCharts;
4
5// Add this when into a TypeScript codebase
6declare module "@vue/runtime-core" {
7  interface ComponentCustomProperties {
8    $apexcharts: typeof ApexCharts;
9  }
10}

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

1<template>
2  <div>
3    <apexchart
4      width="500"
5      type="bar"
6      :options="chartOptions"
7      :series="series"
8    ></apexchart>
9  </div>
10</template>

1export default {
2  data: function () {
3    return {
4      chartOptions: {
5        chart: {
6          id: "vuechart-example",
7        },
8        xaxis: {
9          categories: [1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998],
10        },
11      },
12      series: [
13        {
14          name: "series-1",
15          data: [30, 40, 35, 50, 49, 60, 70, 91],
16        },
17      ],
18    };
19  },
20};

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

1<template>
2  <div class="app">
3    <apexchart
4      width="550"
5      type="bar"
6      :options="chartOptions"
7      :series="series"
8    ></apexchart>
9    <div>
10      <button @click="updateChart">Update!</button>
11    </div>
12  </div>
13</template>

1export default {
2  data: function () {
3    return {
4      chartOptions: {
5        chart: {
6          id: "vuechart-example",
7        },
8        xaxis: {
9          categories: [1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998],
10        },
11      },
12      series: [
13        {
14          name: "series-1",
15          data: [30, 40, 45, 50, 49, 60, 70, 81],
16        },
17      ],
18    };
19  },
20  methods: {
21    updateChart() {
22      const max = 90;
23      const min = 20;
24      const newData = this.series[0].data.map(() => {
25        return Math.floor(Math.random() * (max - min + 1)) + min;
26      });
27
28      const colors = ["#008FFB", "#00E396", "#FEB019", "#FF4560", "#775DD0"];
29
30      // Make sure to update the whole options config and not just a single property to allow the Vue watch catch the change.
31      this.chartOptions = {
32        colors: [colors[Math.floor(Math.random() * colors.length)]],
33      };
34      // In the same way, update the series option
35      this.series = [
36        {
37          data: newData,
38        },
39      ];
40    },
41  },
42};

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

✅ Do this

1this.chartOptions = {
2  ...this.chartOptions,
3  ...{
4    xaxis: {
5      labels: {
6        style: {
7          colors: ["red"],
8        },
9      },
10    },
11  },
12};

❌ Not this

1this.chartOptions.xaxis = {
2    labels: {
3        style: {
4          colors: ['red']
5        }
6    }
7}}

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

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

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.

Running the examples

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

To run the examples,

1cd demo
2yarn install
3yarn start

Development

Install dependencies

1yarn install

Bundling

1yarn build

License

Vue3-ApexCharts is released under MIT license. You are free to use, modify and distribute this software, as long as the copyright header is left intact.

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

9

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

8

Maintained

Determines if the project is "actively maintained".

2

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

85 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-x9w5-v3q2-3rhw
Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-phwq-j96m-2c2q
Warn: Project is vulnerable to: GHSA-ghr5-ch3p-vcr6
Warn: Project is vulnerable to: GHSA-434g-2637-qmqr
Warn: Project is vulnerable to: GHSA-49q7-c7j4-3p7m
Warn: Project is vulnerable to: GHSA-977x-g7h5-7qgw
Warn: Project is vulnerable to: GHSA-f7q4-pwc6-w24p
Warn: Project is vulnerable to: GHSA-fc9h-whq2-v747
Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc
Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc
Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
Warn: Project is vulnerable to: GHSA-pfq8-rq6v-vf5m
Warn: Project is vulnerable to: GHSA-c7qv-q95q-8v27
Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq
Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488
Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-5rrq-pxf6-6jx5
Warn: Project is vulnerable to: GHSA-8fr3-hfg3-gpgp
Warn: Project is vulnerable to: GHSA-gf8q-jrpm-jvxq
Warn: Project is vulnerable to: GHSA-2r2c-g63r-vccr
Warn: Project is vulnerable to: GHSA-cfm4-qjh2-4765
Warn: Project is vulnerable to: GHSA-x4jg-mjrx-434g
Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr
Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-wr3j-pwj9-hqq6
Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Warn: Project is vulnerable to: GHSA-whgm-jr23-g3j9
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-w46j-8hm6-h8mm
Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5
Warn: Project is vulnerable to: GHSA-257v-vj4p-3w2h
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-3wcq-x3mq-6r9p
Warn: Project is vulnerable to: GHSA-r9p9-mrjm-926w
Warn: Project is vulnerable to: GHSA-6h5x-7c5m-7cr7
Warn: Project is vulnerable to: GHSA-74fj-2j2h-c42q
Warn: Project is vulnerable to: GHSA-pw2r-vq6v-hr8c
Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6
Warn: Project is vulnerable to: GHSA-7wwv-vh3v-89cq
Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
Warn: Project is vulnerable to: GHSA-7r28-3m3f-r2pr
Warn: Project is vulnerable to: GHSA-r8j5-h5cx-65gg
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-566m-qj78-rww5
Warn: Project is vulnerable to: GHSA-hwj9-h5mp-3pm3
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-g4rg-993r-mgx7
Warn: Project is vulnerable to: GHSA-vx3p-948g-6vhq
Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc
Warn: Project is vulnerable to: GHSA-9m6j-fcg5-2442
Warn: Project is vulnerable to: GHSA-hh27-ffr2-f2jc
Warn: Project is vulnerable to: GHSA-rqff-837h-mm52
Warn: Project is vulnerable to: GHSA-8v38-pw62-9cw2
Warn: Project is vulnerable to: GHSA-hgjh-723h-mx2j
Warn: Project is vulnerable to: GHSA-jf5r-8hm2-f872
Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693
Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
Warn: Project is vulnerable to: GHSA-8jhw-289h-jh2g
Warn: Project is vulnerable to: GHSA-64vr-g452-qvp3
Warn: Project is vulnerable to: GHSA-9cwx-2883-4wfx
Warn: Project is vulnerable to: GHSA-g3ch-rx76-35fx

Score

4.3

/10

Last Scanned on 2024-11-25

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More