Skip to content

open-data-plan/g2plot-vue

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

@opd/g2plot-vue

G2Plot for Vue, see documentation for more

build npm npm npm codecov FOSSA Status

Install

npm install @opd/g2plot-vue 

Usage

Edit g2plot-vue-basic-example

jsx

import { defineComponent, ref } from 'vue' import { LineChart, LineChartProps } from '@opd/g2plot-vue' const config: LineChartProps = { height: 350, autoFit: true, xField: 'year', yField: 'value', smooth: true, meta: { value: { max: 15, }, }, data: [ { year: '1991', value: 3 }, { year: '1992', value: 4 }, { year: '1993', value: 3.5 }, { year: '1994', value: 5 }, { year: '1995', value: 4.9 }, { year: '1996', value: 6 }, { year: '1997', value: 7 }, { year: '1998', value: 9 }, { year: '1999', value: 11 }, ], } export default defineComponent(() => { const chartRef = ref(null) return () => <LineChart {...config} chartRef={chartRef} /> })

template

<template> <line-chart v-bind="config" /> </template> <script> import Vue from 'vue' import { LineChart } from '@opd/g2plot-vue'  Vue.use(LineChart)  export default {  data() {  return {  config: {  height: 350,  autoFit: true,  xField: 'year',  yField: 'value',  smooth: true,  meta: {  value: {  max: 15,  },  },  data: [  { year: '1991', value: 3 },  { year: '1992', value: 4 },  { year: '1993', value: 3.5 },  { year: '1994', value: 5 },  { year: '1995', value: 4.9 },  { year: '1996', value: 6 },  { year: '1997', value: 7 },  { year: '1998', value: 9 },  { year: '1999', value: 11 },  ],  },  }  }, } </script>

DEMO

API

All config defined in G2Plot document can be used as props or attrs

Notable API in g2plot-vue

  • chartRef: ref of rendered plot, available after plot mounted, NOT component mounted
  • onReady: callback after plot mounted, NOT component mounted

FYI

  • Build failed with vite

    g2plot-vue use babel to build output files, and transform @babel/runtime with dependencies, so @babel/runtime is required.

Develop

npm install npm run build 

License

FOSSA Status

Packages

No packages published

Contributors 5