vue-chart-3

Typescript

Each component props is properly typed and should be throwing errors if you are using Volaropen in new window

Code example

<template>
  <div>
    <DoughnutChart ref="doughnutRef" :chartData="testData" :options="options" />
    <button @click="shuffleData">Shuffle</button>
  </div>
</template>

<script lang="ts">
import { shuffle } from 'lodash';
import { computed, defineComponent, ref } from 'vue';
import { DoughnutChart, ExtractComponentData } from 'vue-chart-3';

export default defineComponent({
  name: 'Home',
  components: { DoughnutChart },
  setup() {
    const data = ref([30, 40, 60, 70, 5]);
    const doughnutRef = ref<ExtractComponentData<typeof DoughnutChart>>();

    const options = ref<ChartOptions<'doughnut'>>({
      responsive: true,
      plugins: {
        legend: {
          position: 'top',
        },
        title: {
          display: true,
          text: 'Chart.js Doughnut Chart',
        },
      },
    });

    const testData = computed<ChartData<'doughnut'>>(() => ({
      labels: ['Paris', 'Nîmes', 'Toulon', 'Perpignan', 'Autre'],
      datasets: [
        {
          data: data.value,
          backgroundColor: ['#77CEFF', '#0079AF', '#123E6B', '#97B0C4', '#A5C8ED'],
        },
      ],
    }));

    function shuffleData() {
      data.value = shuffle(data.value);
    }

    return { testData, shuffleData, doughnutRef, options };
  },
});
</script>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

Helper types

ExtractComponentData<T>

This component is useful if you want to access the Chart component ref.

Ex:

setup() {
  const doughnutRef = ref<ExtractComponentData<typeof doughnutChart>>()

  foo() {
    doughnutRef.value?.chartInstance.toBase64Image();
  }
}
1
2
3
4
5
6
7

ExtractComponentProps<T>

This type will extracts prop types from the component if you want to type your v-bind.

Ex:

setup() {
  const barChartProps = computed<ExtractComponentProps<typeof BarChart>>(() => ({
    chartData: {...},
    options: {}
  }))
}
1
2
3
4
5
6