Reactive Vue.js wrapper for Google Charts lib
npm install vue-google-charts
Reactive Vue.js wrapper for Google Charts lib
Installation
•
Usage
•
Slack
•
Examples
``bash`
pnpm add vue-google-chartsor
yarn add vue-google-chartsor
npm i vue-google-charts
Need an API to fetch data? Consider Cube, an open-source API for data apps.
This package works with version 2.x and 3.x of Vue.
Use locally in a component:
`javascript
import { GChart } from 'vue-google-charts'
export default {
components: {
GChart
}
}
`
For Vue 2 projects, you need to import from vue-google-charts/legacy.
`javascript`
import { GChart } from 'vue-google-charts/legacy'
component is a wrapper for the original Google Charts, so it's assumed you are familiar with the vanilla Google Charts usage (https://developers.google.com/chart/).With
vue-google-charts package you don't need to link script loader and load Google Charts package manually.Another bonus — reactive data binding. A chart will be redrawn automatically once
data , type and options prop is changed.Simple usage:
`html
:data="chartData"
:options="chartOptions"
/>
`
---
javascript
export default {
data () {
return {
// Array will be automatically processed with visualization.arrayToDataTable function
chartData: [
['Year', 'Sales', 'Expenses', 'Profit'],
['2014', 1000, 400, 200],
['2015', 1170, 460, 250],
['2016', 660, 1120, 300],
['2017', 1030, 540, 350]
],
chartOptions: {
chart: {
title: 'Company Performance',
subtitle: 'Sales, Expenses, and Profit: 2014-2017',
}
}
}
}
}
`
---
Load additional packages:
html
type="Map"
:data="chartData"
:options="chartOptions"
/>
`
Using prop you can specify any setting available for google charts loader:
packages, language, callback, mapsApiKey.See more on available setting
There's also
version prop, so you can load a specific version, e.g. version="upcoming".See more on available versions
---
Add event listeners:
`html
:data="chartData"
:options="chartOptions"
:events="chartEvents"
/>
`javascript
export default {
data () {
return {
// {
// eventName: handlerFunction,
// eventName: handlerFunction,
// }
chartEvents: {
'select': () => {
// handle event here
}
}
}
}
}
`---
Use
for something very customYou can get chart instance and charts api references to draw a custom chart:
`html
@ready="onChartReady"
/>
`javascript
export default {
methods: {
onChartReady (chart, google) {
const query = new google.visualization.Query('https://url-to-spreadsheet...')
query.send(response => {
const options = {
// some custom options
}
const data = response.getDataTable()
chart.draw(data, options)
})
}
}
}
`---
propertyThis property allows you to create custom chart object from outside of the component.
createChart property is the function and accepts three arguments:
el - the reference to chart element,
google - Google chart library,
type - chart type`html
:data="chartData"
:options="chartOptions"
:createChart="(el, google) => new google.charts.Bar(el)"
/>
`By default the function looks like this:
javascript
(el, google, type) => {
return new google.visualizationtype
}
`For example
may be used to create Material bar charts (Material bar charts expect of class google.charts.Bar instead of google.visualization.BarChart). See: https://codesandbox.io/embed/z699l6oq4p?module=%2Fsrc%2FApp.vue---
Responsive Chart Behaviour
GCharts are responsive by default and they can change their width on
window.resize event.
The resize is debounces and you can control debounce time (ms) by using resizeDebounce property:
`html
/>
`
If you don't need responsive behaviour for your charts, set ---
Plugin Development
Installation
The first time you create or clone your plugin, you need to install the default dependencies:
npm i
Watch and compile
This will run webpack in watching mode and output the compiled files in the
folder.`
npm run dev
Use it in another project
While developing, you can follow the install instructions of your plugin and link it into the project that uses it.
In the plugin folder:
npm link
In the other project folder:
npm link vue-google-charts
This will install it in the dependencies as a symlink, so that it gets any modifications made to the plugin.
Manual build
This will build the plugin into the
folder in production mode.`
npm run build
---
- Area Chart: Vue 2 / Vue 3
- Bar Chart: Vue 2 / Vue 3
- Bubble Chart: Vue 2 / Vue 3
- Calendar Chart: Vue 2 / Vue 3
- Candlestick Chart: Vue 2 / Vue 3
- Column Chart: Vue 2 / Vue 3
- Combo Chart: Vue 2 / Vue 3
- Donut Chart: Vue 2 / Vue 3
- Gantt Chart: Vue 2 / Vue 3
- Gauge Chart: Vue 2 / Vue 3
- Geo Chart: Vue 2 / Vue 3
- Histogram Chart: Vue 2 / Vue 3
- Line Chart: Vue 2 / Vue 3
- Org Chart: Vue 2 / Vue 3
- Pie Chart: Vue 2 / Vue 3
- Sankey Chart: Vue 2 / Vue 3
- Scatter Chart: Vue 2 / Vue 3
- Stepped Area Chart: Vue 2 / Vue 3
- Table Chart: Vue 2 / Vue 3
- Timeline Chart: Vue 2 / Vue 3
- Tree Map Chart: Vue 2 / Vue 3
- Trendlines Chart: Vue 2 / Vue 3
- Waterfall Chart: Vue 2 / Vue 3
- Word Tree Chart: Vue 2 / Vue 3