graphieros / vue-data-ui

An open source user-empowering data visualization Vue 3 components library for eloquent data storytelling
https://vue-data-ui.graphieros.com/
MIT License
1.01k stars 42 forks source link
charts components-library dashboard data-storytelling data-visualization donut gauge heatmap quadrant radar rating-stars scatter screenshot skeleton-loader sparkline table vue-data-ui vue3 vuejs vuejs3




vue-data-ui

npm Static Badge GitHub issues License MadeWithVueJs.com shield npm

Interactive documentation

A user-empowering data visualization Vue components library for eloquent data storytelling.

Available components

Charts

Mini charts

3d

Tables

Rating

Utilities

Installation

npm i vue-data-ui

You can declare components globally in your main.js:

import { createApp } from "vue";
import App from "./App.vue";
// Include the css;
import "vue-data-ui/style.css";

// You can declare Vue Data UI components globally
import { VueUiRadar } from "vue-data-ui";

const app = createApp(App);

app.component("VueUiRadar", VueUiRadar);
app.mount("#app");

Or you can import just what you need in your files:

<script setup>import {(VueUiRadar, VueUiXy)} from "vue-data-ui";</script>

Since v.2.0.38, you can also use the "VueDataUi" universal component, just specifying which component you are using. You can of course use the slots provided, if the target component has them.

<script setup>
import { ref } from "vue";
import { VueDataUi } from "vue-data-ui";
// Include the css;
import "vue-data-ui/style.css";

const config = ref({...});
const dataset = ref([...]);

</script>

<template>

  <VueDataUi
    component="VueUiXy"
    :config="config"
    :dataset="dataset"
  />

</template>

Typescript

Types are available in the 'vue-data-ui.d.ts' file under the types directory of the package.

Nuxt

This repo contains a boilerplate implementation of the vue-data-ui package in Nuxt

Customizable tooltips

Charts with tooltips have a config option to customize tooltip contents:


customFormat: ({ seriesIndex, datapoint, series, config }) => {
  return `<div>${ ... }</div>`;
}

Data formatting

Data labels can be customized using the formatter config attribute (since v2.3.29 on all chart components):

// the formatter attribute is generally placed under label or dataLabel config attribute objects

const config = ref({
  formatter: ({ value, config }) => {
    return `formatted ${value}`;
  }
})

Slots

svg slot

Most Vue Data UI chart components include a #svg slot you can use to introduce customized svg elements (shapes, text, etc).

<VueUiXy :dataset="dataset" :config="config">
  <template #svg="{ svg }">
    <foreignObject x="100" y="0" height="100" width="150">
      <div>This is a custom caption</div>
    </foreignObject>
  </template>
</VueUiXy>

The svg slot also works when using the VueDataUi universal component, if the component it wraps supports it.

legend slot (since v.2.0.41)

All charts expose a #legend slot except for:

The legend slot also works when using the VueDataUi universal component, if the component it wraps supports it. It is recommended to set the show legend config attribute to false, to hide the default legend.

<VueUiDonut :config="config" :dataset="dataset">
  <template #legend="{ legend }">
    <div v-for="item in legend">{{ legend.name }}</div>
  </template>
</VueUiDonut>

Tooltip #tooltip-before & #tooltip-after slots

Since v.2.0.57, it is possible to further customize tooltip contents with #tooltip-before and #tooltip-after slots. It is that easy to include an image, another chart or any other content into your tooltips. It's an alternative to the config option tooltip.customFormat, in case richer tooltip content is needed.

Both slots expose the following object:

{
  datapoint,
  seriesIndex,
  series,
  config,
}

The following charts bear these slots:

* VueUiXy slots specifically expose the following additional attributes:


{
  ...,
  bars,
  lines,
  plots
}
<VueUiDonut :config="config" :dataset="dataset">
  <template #tooltip-before={ datapoint, seriesIndex, dataset, config }">
    <div>
      This content shows first
    </div>
  </template>
  <template #tooltip-after={ datapoint, seriesIndex, dataset, config }">
    <div>
      This content shows last
    </div>
  </template>
</VueUiDonut>

The #tooltip-before & #tooltip-after slots also works when using the VueDataUi universal component, if the component it wraps supports them.

Add a watermark using the #watermark slot

You can use the #watermark slot to include any watermark content with your own styling. This slot exposes the isPrinting boolean you can use to display the watermark only when producing a pdf or an image.

<VueUiDonut :config="config" :dataset="dataset">
  <template #watermark="{ isPrinting }">
    <div
      v-if="isPrinting"
      style="font-size: 100px; opacity: 0.1; transform: rotate(-10deg)"
    >
      WATERMARK
    </div>
  </template>
</VueUiDonut>

Customization of the zoom reset button with the #reset-action slot

Available for the following components:

The config option zoom.useResetSlot must be set to true to use the slot.

<VueUiXy :config="config" :dataset="dataset">
  <template #reset-action="{ reset }">
    <button @click="reset()">RESET ZOOM</button>
  </template>
</VueUiXy>

Config

If for some reason you can't access the documentation website and need to get the default config object for a component:

import { getVueDataUiConfig } from "vue-data-ui";

const defaultConfigXy = getVueDataUiConfig("vue_ui_xy");

Themes (since v2.2.9)

All charts are set by default without a theme, and use the default color palette.

3 themes are available for all charts:

Any color provided in dataset props will override the colors used by the theme for datapoints.

To use a theme, set the theme attribute of the config prop, for example:

const donutConfig = ref({
  theme: 'zen',
  ...
})

Available components : details

Type definitions are available in the vue-data-ui.d.ts file in the dist/types directory.

Universal component

Name dataset type config type emits / exposed methods slots custom tooltip themes
VueDataUi (depends on component) (depends on component) (depends on component) (depends on component) (depends on component) (depends on component)

Quick chart

From the dataset you pass into the props, this component will produce the most adapted chart (either a line, bar or donut chart)

Name dataset type config type emits / exposed methods slots custom tooltip themes
VueUiQuickChart VueUiQuickChartDataset VueUiQuickChartConfig @selectDatapoint, @selectLegend, generatePdf, generateImage, toggleTooltip #legend, #tooltip-before, #tooltip-after, #reset-action, #watermark

Mini charts

Name dataset type config type emits / exposed methods slots custom tooltip themes
VueUiSparkline VueUiSparklineDatasetItem[] VueUiSparklineConfig @selectDatapoint #svg, #before
VueUiSparkbar VueUiSparkbarDatasetItem[] VueUiSparkbarConfig @selectDatapoint #data-label, #title
VueUiSparkStackbar VueUiSparkStackbarDatasetItem[] VueUiSparkStackbarConfig @selectDatapoint
VueUiSparkHistogram VueUiSparkHistogramDatasetItem[] VueUiSparkHistogramConfig @selectDatapoint
VueUiSparkGauge VueUiSparkGaugeDataset VueUiSparkGaugeConfig
VueUiSparkTrend number[] VueUiSparkTrendConfig
VueUiGizmo VueUiGizmoDataset VueUiGizmoConfig

Charts

Name dataset type config type emits / exposed methods slots custom tooltip themes
VueUiAgePyramid Array<Array<string / number>> VueUiSparklineConfig generatePdf, generateImage, generateCsv, toggleTable, toggleTooltip #svg, #legend, #tooltip-before, #tooltip-after, #watermark
VueUiCandlestick Array<Array<string / number>> VueUiCandlestickConfig generatePdf, generateImage, generateCsv, toggleTable, toggleTooltip #svg, #legend, #tooltip-before, #tooltip-after, #reset-action, #watermark
VueUiChestnut VueUiChestnutDatasetRoot[] VueUiChestnutConfig @selectRoot, @selectBranch, @selectNut, getData, generatePdf, generateCsv, generateImage, toggleTable #svg, #legend, #watermark
VueUiDonutEvolution VueUiDonutEvolutionDatasetItem[] VueUiDonutEvolutionConfig @selectLegend, getData, generatePdf, generateCsv, generateImage, toggleTable #svg, #legend, #reset-action, #watermark
VueUiDonut VueUiDonutDatasetItem[] VueUiDonutConfig @selectDatapoint, @selectLegend, getData, generatePdf, generateCsv, generateImage, toggleTable, toggleLabels, toggleTooltip #svg, #legend, #dataLabel, #tooltip-before, #tooltip-after, #plot-comment, #watermark
VueUiDumbbell VueUiDumbbellDataset[] VueUiDumbbellConfig getData, generatePdf, generateCsv, generateImage, toggleTable #svg, #legend, #watermark
VueUiFlow VueUiFlowDatasetItem[] VueUiFlowConfig getData, generatePdf, generateCsv, generateImage, toggleTable #svg,, #watermark
VueUiGalaxy VueUiGalaxyDatasetItem[] VueUiGalaxyConfig @selectDatapoint, @selectLegend, getData, generatePdf, generateCsv, generateImage, toggleTable, toggleTooltip #svg, #legend,#tooltip-before, #tooltip-after
VueUiGauge VueUiGaugeDataset VueUiGaugeConfig generatePdf, generateImage #svg, #legend, #watermark
VueUiHeatmap VueUiHeatmapDatasetItem[] VueUiHeatmapConfig generatePdf, generateCsv, generateImage, toggleTable, toggleTooltip #svg, #tooltip-before, #tooltip-after, #watermark
VueUiMolecule VueUiMoleculeDatasetNode[] VueUiMoleculeConfig getData, generatePdf, generateCsv, generateImage, toggleTable, toggleLabels, toggleTooltip #svg, #tooltip-before, #tooltip-after, #watermark
VueUiMoodRadar VueUiMoodRadarDataset VueUiMoodRadarConfig getData, generatePdf, generateCsv, generateImage, toggleTable #svg, #legend, #watermark
VueUiNestedDonuts VueUiNestedDonutsDatasetItem[] VueUiNestedDonutsConfig @selectDatapoint, @selectLegend, getData, generatePdf, generateCsv, generateImage, toggleTable, toggleLabels, toggleTooltip #svg, #legend, #tooltip-before, #tooltip-after, #watermark
VueUiOnion VueUiOnionDatasetItem[] VueUiOnionConfig @selectLegend, getData, generatePdf, generateCsv, generateImage, toggleTable, toggleTooltip #svg, #legend, #tooltip-before, #tooltip-after, #watermark
VueUiParallelCoordinatePlot VueUiParallelCoordinatePlotDatasetItem[] VueUiParallelCoordinatePlotConfig @selectLegend, @selectDatapoint, getData, generatePdf, generateCsv, generateImage, toggleTable, toggleLabels, toggleTooltip #svg, #legend, #tooltip-before, #tooltip-after, #plot-comment, #watermark
VueUiQuadrant VueUiQuadrantDatasetItem[] VueUiQuadrantConfig @selectLegend, @selectPlot, @selectSide, getData, generatePdf, generateCsv, generateImage, toggleTable, toggleLabels, toggleTooltip #svg, #legend, #tooltip-before, #tooltip-after, #watermark
VueUiRadar VueUiRadarDataset VueUiRadarConfig @selectLegend, getData, generatePdf, generateCsv, generateImage, toggleTable, toggleTooltip #svg, #legend, #tooltip-before, #tooltip-after, #watermark
VueUiRings VueUiRingsDatasetItem[] VueUiRingsConfig @selectLegend, getData, generatePdf, generateCsv, generateImage, toggleTable, toggleTooltip #svg, #legend, #tooltip-before, #tooltip-after, #watermark
VueUiScatter VueUiScatterDatasetItem[] VueUiScatterConfig getData, generatePdf, generateCsv, generateImage, toggleTable, toggleTooltip #svg, #legend, #tooltip-before, #tooltip-after, #watermark
VueUiStackbar VueUiStackbarDatasetItem[] VueUiStackbarConfig @selectLegend, @selectDatapoint, getData, generatePdf, generateCsv, generateImage, toggleTable, toggleLabels, toggleTooltip #svg, #legend, #tooltip-before, #tooltip-after, #reset-action, #watermark
VueUiStripPlot VueUiStripPlotDataset[] VueUiStripPlotConfig @selectDatapoint, getData, generatePdf, generateCsv, generateImage, toggleTable, toggleLabels, toggleTooltip #svg, #legend, #tooltip-before, #tooltip-after, #watermark
VueUiThermometer VueUiThermometerDataset VueUiThermometerConfig generatePdf, generateImage #svg, #watermark
VueUiTiremarks VueUiTiremarksDataset VueUiTiremarksConfig generatePdf, generateImage #svg, #legend, #watermark
VueUiTreemap VueUiTreemapDatasetItem[] VueUiTreemapConfig @selectLegend, @selectDatapoint, getData, generatePdf, generateCsv, generateImage, toggleTable, toggleTooltip #svg, #rect, #legend, #tooltip-before, #tooltip-after, #watermark
VueUiVerticalBar VueUiVerticalBarDatasetItem[] VueUiWheelConfig @selectLegend, getData, generatePdf, generateCsv, generateImage, toggleTable, toggleSort, toggleTooltip #svg, #legend, #tooltip-before, #tooltip-after, #watermark
VueUiWaffle VueUiWaffleDatasetItem[] VueUiWaffleConfig @selectLegend, getData, generatePdf, generateCsv, generateImage, toggleTable, toggleTooltip #svg, #legend, #tooltip-before, #tooltip-after, #watermark
VueUiWheel VueUiWheelDataset VueUiWheelConfig generatePdf, generateImage #svg, #watermark
VueUiWordCloud VueUiWordCloudDatasetItem[] / string VueUiWordCloudConfig getData, generatePdf, generateImage, generateCsv #svg, #reset-action, #watermark
VueUiXyCanvas VueUiXyCanvasDatasetItem[] VueUiXyCanvasConfig @selectLegend, getData, generatePdf, generateCsv, generateImage, toggleTable, toggleLabels, toggleStack, toggleTooltip #legend, #tooltip-before, #tooltip-after, #reset-action, #watermark
VueUiXy VueUiXyDatasetItem[] VueUiXyConfig @selectLegend, @selectX, getData, generatePdf, generateCsv, generateImage, toggleTable, toggleLabels, toggleStack, toggleTooltip #svg, #legend, #tooltip-before, #tooltip-after, #reset-action, #plot-comment,#watermark

3D charts

Name dataset type config type emits / exposed methods slots custom tooltip themes
VueUi3dBar VueUi3dBarDataset VueUi3dBarConfig generatePdf, generateImage, toggleTable #svg, #watermark

Data tables

Name dataset type config type emits / exposed methods slots themes
VueUiTable VueUiTableDataset VueUiTableConfig
VueUiTableHeatmap VueUiTableHeatmapDatasetItem[] VueUiTableHeatmapConfig generatePdf, generateCsv, generateImage #caption, #rowTitle, #cell, #sum, #average, #median
VueUiTableSparkline VueUiTableSparklineDatasetItem[] VueUiTableSparklineConfig generatePdf, generateCsv, generateImage
VueUiCarouselTable VueUiCarouselTableDataset VueUiCarouselTableConfig generatePdf, generateImage, generateCsv, toggleAnimation, pauseAnimation, resumeAnimation #caption, #th, #td

Rating

Name dataset type config type emits / exposed methods
VueUiRating VueUiRatingDataset VueUiRatingConfig @rate, getData,toggleReadonly
VueUiSmiley VueUiRatingDataset VueUiSmileyConfig @rate, getData,toggleReadonly

Utilities

Name dataset type config type emits / exposed methods slots
VueUiAccordion VueUiAccordionConfig #arrow, #title, #content
VueUiAnnotator VueUiAnnotatorDataset VueUiAnnotatorConfig @toggleOpenState, @saveAnnotations
VueUiCursor VueUiCursorConfig
VueUiDashboard VueUiDashboardElement[] VueUiDashboardConfig @change #content
VueUiDigits number VueUiDigitsConfig
VueUiKpi number VueUiKpiConfig #title, #value, #comment-before, #comment-after
VueUiMiniLoader VueUiMiniLoaderConfig
VueUiScreenshot VueUiScreenshotConfig @postImage, shoot, close
VueUiSkeleton VueUiSkeletonConfig
VueUiTimer VueUiTimerConfig @start, @pause, @reset, @restart, @lap #time, #controls, #laps
VueUiIcon see below

Icons

Tailor made icons are available through the VueUiIcon component:

<VueUiIcon name="arrowRight" :size="24" stroke="#6376DD" />

All names of available icons are available in the vue-data-ui.d.ts file under the VueUiIconName type.

User options

User options menu is accessible in the burger menu located on the top right of charts, and visible by default. To hide user options menu, set config.userOptions.show to false:

const config = ref({
  userOptions: {
    show: false
  },
  ...
})

Predefined actions in user options menu depend on the type of chart. Some charts have more or less actions available. Action buttons contain an predefined icons by default.

To hide a given action, set the userOption.buttons, for example:

const config = ref({
  userOptions: {
    show: true,
    buttons: {
      pdf: false,
      fullscreen: false,
      // all other actions will be visible by default (list of all actions below)
    },
  },
});

You can use slots to override the content of action buttons. What happens when the button is clicked is taken care of by the component, except for the optionFullscreen slot.

<VueUiDonut :config="config" :dataset="dataset">
  <template #optionPdf> GENERATE PDF </template>

  <!-- This is the only action where scoped content is provided -->
  <template template #optionFullscreen="{ isFullscreen, toggleFullscreen }">
    <div @click="toggleFullscreen(isFullscreen ? 'out' : 'in')">
      TOGGLE FULLSCREEN
    </div>
  </template>
</VueUiDonut>

User options actions available per chart:

Chart name User options actions slot names
VueUi3dBar optionPdf, optionImg, optionCsv, optionTable, optionFullscreen
VueUiAgePyramid optionTooltip, optionPdf, optionImg, optionCsv, optionTable, optionFullscreen
VueUiCandlestick optionTooltip, optionPdf, optionImg, optionCsv, optionTable, optionFullscreen
VueUiCarouselTable optionPdf, optionImg, optionCsv, optionAnimation, optionFullscreen
VueUiChestnut optionPdf, optionImg, optionCsv, optionTable, optionFullscreen
VueUiDonut optionTooltip, optionPdf, optionImg, optionCsv, optionTable, optionLabels, optionFullscreen
VueUiDonutEvolution optionPdf, optionImg, optionCsv, optionTable, optionFullscreen
VueUiDumbbell optionPdf, optionImg, optionCsv, optionTable, optionFullscreen
VueUiFlow optionPdf, optionImg, optionCsv, optionTable, optionFullscreen
VueUiGalaxy optionTooltip, optionPdf, optionImg, optionCsv, optionTable, optionFullscreen
VueUiGauge optionPdf, optionImg, optionFullscreen
VueUiHeatmap optionTooltip, optionPdf, optionImg, optionCsv, optionTable, optionFullscreen
VueUiMolecule optionTooltip, optionPdf, optionImg, optionCsv, optionTable, optionLabels, optionFullscreen
VueUiMoodRadar optionPdf, optionImg, optionCsv, optionTable, optionFullscreen
VueUiNestedDonuts optionTooltip, optionPdf, optionImg, optionCsv, optionTable, optionLabels, optionFullscreen
VueUiOnion optionTooltip, optionPdf, optionImg, optionCsv, optionTable, optionFullscreen
VueUiParallelCoordinatePlot optionTooltip, optionPdf, optionImg, optionCsv, optionTable, optionLabels, optionFullscreen
VueUiQuadrant optionTooltip, optionPdf, optionImg, optionCsv, optionTable, optionLabels, optionFullscreen
VueUiQuickChart optionTooltip, optionPdf, optionImg, optionFullscreen
VueUiRadar optionTooltip, optionPdf, optionImg, optionCsv, optionTable, optionFullscreen
VueUiRelationCircle optionPdf, optionImg, optionFullscreen
VueUiRings optionTooltip, optionPdf, optionImg, optionCsv, optionTable, optionFullscreen
VueUiScatter optionTooltip, optionPdf, optionImg, optionCsv, optionTable, optionFullscreen
VueUiSparkHistogram (no user options menu)
VueUiSparkStackbar (no user options menu)
VueUiSparkTrend (no user options menu)
VueUiSparkbar (no user options menu)
VueUiSparkgauge (no user options menu)
VueUiSparkline (no user options menu)
VueUiStackbar optionTooltip, optionPdf, optionImg, optionCsv, optionTable, optionLabels, optionFullscreen
VueUiStripPlot optionTooltip, optionPdf, optionImg, optionCsv, optionTable, optionLabels, optionFullscreen
VueUiTableHeatmap optionPdf, optionImg, optionCsv, optionFullscreen
VueUiTableSparkline optionPdf, optionImg, optionCsv, optionFullscreen
VueUiThermometer optionPdf, optionImg, optionFullscreen
VueUiTiremarks optionPdf, optionImg, optionFullscreen
VueUiTreemap optionTooltip, optionPdf, optionImg, optionCsv, optionTable, optionFullscreen
VueUiVerticalBar optionTooltip, optionPdf, optionImg, optionCsv, optionTable, optionSort, optionFullscreen
VueUiWaffle optionTooltip, optionPdf, optionImg, optionCsv, optionTable, optionFullscreen
VueUiWheel optionPdf, optionImg, optionFullscreen
VueUiWordCloud optionPdf, optionImg, optionCsv, optionTable, optionFullscreen
VueUiXy optionTooltip, optionPdf, optionImg, optionCsv, optionTable, optionLabels, optionFullscreen, optionStack
VueUiXyCanvas optionTooltip, optionPdf, optionImg, optionCsv, optionTable, optionLabels, optionFullscreen, optionStack

Custom palette

It is possible to provide a custom palette in the config prop through config.customPalette (string[]) for the following components:

If the array of colors provided in customPalette is too small for the dataset, remaining colors will be computed from the default internal palette. Accepted color formats: HEX, RGB, HSL, named colors.

Responsive charts

By default, all charts will scale to the width of their container. However the folowing charts can be made fully responsive, making them better to use in resizable containers:

Component Responsive feature implemented
VueUi3dBar -
VueUiAgePyramid
VueUiCandlestick
VueUiCarouselTable -
VueUiChestnut -
VueUiDonut
VueUiDonutEvolution -
VueUiDumbbell
VueUiFlow -
VueUiGalaxy -
VueUiGauge
VueUiHeatmap -
VueUiMolecule -
VueUiMoodRadar -
VueUiNestedDonuts
VueUiOnion
VueUiParallelCoordinatePlot
VueUiQuadrant
VueUiQuickChart
VueUiRadar
VueUiRelationCircle
VueUiRings
VueUiScatter
VueUiSparkHistogram -
VueUiSparkStackbar -
VueUiSparkTrend -
VueUiSparkbar -
VueUiSparkgauge -
VueUiSparkline
VueUiStackbar
VueUiStripPlot
VueUiTableHeatmap -
VueUiTableSparkline -
VueUiThermometer -
VueUiTimer
VueUiTiremarks -
VueUiTreemap
VueUiVerticalBar
VueUiWaffle
VueUiWheel
VueUiWordCloud
VueUiXy
VueUiXyCanvas

To activate responsiveness, set the config.responsive attribute to true:

const config = ref({
  responsive: true,
  // rest of your config
});

Important: when using the responsive feature, charts must be placed inside a container with fixed dimensions. Avoid setting a 100% height to this container, as it will result in the chart growing infinitely.