vue-data-ui

Interactive documentation

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

Available components

Charts

• VueUiAgePyramid
• VueUiBump
• VueUiCandlestick
• VueUiChestnut
• VueUiChord
• VueUiCirclePack
• VueUiDag
• VueUiDonutEvolution
• VueUiDonut
• VueUiDumbbell
• VueUiFlow
• VueUiFunnel
• VueUiGalaxy
• VueUiGauge
• VueUiHeatmap
• VueUiHistoryPlot
• VueUiHorizontalBar
• VueUiMolecule
• VueUiMoodRadar
• VueUiNestedDonuts
• VueUiOnion
• VueUiParallelCoordinatePlot
• VueUiQuadrant
• VueUiQuickChart
• VueUiRadar
• VueUiRelationCircle
• VueUiRidgeline
• VueUiRings
• VueUiScatter
• VueUiStackbar
• VueUiStackline
• VueUiStripPlot
• VueUiThermometer
• VueUiTiremarks
• VueUiTreemap
• VueUiWaffle
• VueUiWheel
• VueUiWordCloud
• VueUiXyCanvas
• VueUiXy

Mini charts

• VueUiSparkHistogram
• VueUiSparkbar
• VueUiSparkgauge
• VueUiSparkline
• VueUiSparkStackbar
• VueUiSparkTrend
• VueUiGizmo
• VueUiBullet

3d

• VueUi3dBar

Tables

• VueUiTableHeatmap
• VueUiTableSparkline
• VueUiTable
• VueUiCarouselTable

Rating

• VueUiRating
• VueUiSmiley

Maps

• VueUiGeo
• VueUiWorld

Utilities

• VueUiAccordion
• VueUiAnnotator
• VueUiCursor
• VueUiDashboard
• VueUiDigits
• VueUiIcon
• VueUiKpi
• VueUiMiniLoader
• VueUiSkeleton
• VueUiTimer

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 into your files:

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

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>

Note that the following utility components are not supported by the universal VueDataUi component and must be imported individually:

• Arrow
• VueUiIcon
• VueUiPattern

Typescript

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

Vue Data UI version2 -> version3 migration

Vue Data UI v3 does not contain breaking changes. However, some charts have their padding configs modified, which can lead to excessive padding with a v2 config.

Version 3 features

• config.loading (default: false) toggle loading state manually, to display a beautiful skeleton loader which uses the same chart component and shares layout features derived from your config. This skeleton loader is also triggered automatically if the provided dataset is undefined.

• config.debug (default: false) set to true to show warning messages during development, turn off for production.

• smart label resizing and auto-rotating features

• more charts support responsive mode

• config event callbacks

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 the 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:

• VueUiCirclePack
• VueUiDumbbell
• VueUiFlow
• VueUiFunnel
• VueUiHeatmap
• VueUiRelationCircle
• VueUiSparkHistogram
• VueUiSparkStackbar
• VueUiSparkbar
• VueUiSparkgauge
• VueUiSparkline
• VueUiThermometer
• VueUiTimer
• VueUiTiremarks
• VueUiWheel

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

Customize tooltip contents with #tooltip-before and #tooltip-after slots, to include an image, another chart or any other rich 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:

• VueUiAgePyramid
• VueUiCandlestick
• VueUiCirclePack
• VueUiDonut
• VueUiGalaxy
• VueUiHeatmap
• VueUiHistoryPlot
• VueUiHorizontalBar
• VueUiMolecule
• VueUiNestedDonuts
• VueUiOnion
• VueUiParallelCoordinatePlot
• VueUiQuadrant
• VueUiQuickChart
• VueUiRadar
• VueUiRings
• VueUiScatter
• VueUiSparkStackbar
• VueUiStackbar
• VueUiStackline
• VueUiTreemap
• VueUiWordCloud
• VueUiWorld
• VueUiXy *
• VueUiXyCanvas
• VueUiwaffle

* 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 the last
    </div>
  </template>
</VueUiDonut>

The #tooltip-before & #tooltip-after slots also work 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:

• VueUiQuickChart (for line & bar types only)
• VueUiXy
• VueUiDonutEvolution
• VueUiCandlestick
• VueUiWordCloud

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.

9 themes are available for all charts:

• default (or '')
• dark
• zen
• hack
• concrete
• celebration
• celebrationNight
• minimal
• minimalDark

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',
  ...
})

Quick custom theme

You can quickly setup your own theme for a given chart:

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

// Get the default config and set color options
const customTheme = getVueDataUiConfig("vue_ui_xy", {
  colorBackground: "#1A1A1A",
  colorTextPrimary: "#CD9077",
  colorTextSecondary: "#825848",
  colorGrid: "#CD9077",
  colorBorder: "#CD9077",
});

const config = computed(() => {
  // Use the `mergeConfigs` utility to set additional configurations while preserving your theme
  return mergeConfigs({
    defaultConfig: customTheme,
    userConfig: {
      chart: {
        title: {
          text: "Title",
          subtitle: {
            text: "Subtitle",
          },
        },
      },
    },
  });
});

Available components : details

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

Universal 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)

Mini charts

Charts

3D charts

Maps

Data tables

Rating

Utilities

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.

VueUiIcon props:

Icons have 2 slots that can be used to display exp or sub icons:

<VueUiIcon name="database">
  <template #exp v-if="isLoading">
    <VueUiIcon name="spinner2" :is-spin="true"/>
  </template>
  <template #sub>
    <VueUiIcon name="person"/>
  </sub>
</VueUiIcon>

User options

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

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

The user options menu can be set to appear only when hovering over the component:

const config = ref({
  userOptions: {
    show: true,
    showOnChartHover: true, // Default: false
    keepStateOnChartLeave: true, // Set to false to always close the menu when hovering out of the chart
  },
});

Predefined actions in the user options menu depend on the type of chart. Some charts have more or fewer actions available. Action buttons contain 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>

You can pass a callback through the config, for each button, to override the default behavior:

const config = {
  userOptions: {
    callbacks: {
      pdf: ({ chartElement, imageUri, base64 }) => {
        console.log(chartElement);
      },
      img: ({ chartElement, imageUri, base64 }) => {
        console.log(base64);
      },
      csv: (csvStr: string) => {
        console.log(csvStr);
      },
      // the other attributes also have the same names as the buttons
    },
  },
};

User options actions available per chart:

User options menu icon can be customized using the #menuIcon slot:

<template #menuIcon="{ isOpen, color }">
  <div>{{ isOpen ? 'close' : 'open' }}</div>
</template>

Since version 3.5.1, slots are exposed to customize the chart annotator sub-menu:

<VueUiXy :dataset="dataset" :config="config">
  <template #annotator-action-close>
    <MyCloseIcon />
  </template>
  <template #annotator-action-color="{ color }">
    <MyColorIcon :color="color" />
  </template>
  <template #annotator-action-draw="{ mode }">
    <MyDrawIcon v-if="mode === 'draw'" />
    <MyTextIcon v-else />
  </template>
  <template #annotator-action-undo="{ disabled }">
    <MyUndoIcon />
  </template>
  <template #annotator-action-redo="{ disabled }">
    <MyRedoIcon />
  </template>
  <template #annotator-action-delete="{ disabled }">
    <MyDeleteIcon />
  </template>
</VueUiXy>

Custom palette

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

• VueUi3dBar
• VueUiBump
• VueUiChestnut
• VueUiChord
• VueUiCirclePack
• VueUiDonut
• VueUiDonutEvolution
• VueUiFlow
• VueUiGalaxy
• VueUiGauge
• VueUiHistoryPlot
• VueUiHorizontalBar
• VueUiMolecule
• VueUiNestedDonuts
• VueUiOnion
• VueUiParallelCoordinatePlot
• VueUiQuadrant
• VueUiQuickChart
• VueUiRadar
• VueUiRelationCircle
• VueUiRidgeline
• VueUiRings
• VueUiScatter
• VueUiSparkStackbar
• VueUiSparkbar
• VueUiStackbar
• VueUiStackline
• VueUiStripPlot
• VueUiTableSparkline
• VueUiThermometer
• VueUiTreemap
• VueUiWaffle
• VueUiWordCloud
• VueUiWorld
• VueUiXy
• VueUiXyCanvas

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 following charts can be made fully responsive, making them better to use in resizable containers:

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.

Big data optimization (since v2.4.11)

Very large datasets (> 5k or > 10k datapoints) will cause the browsers rendering engines to slow down, caused by too many SVG DOM elements to render. The following charts use the LTTB algorithm (Largest-Triangle-Three-Bucket) beyond a certain threshold to downsample the rendered dataset while preserving its shape. These components are the most susceptible to be used with very large datasets:

The downsample threshold for each component can be set in the config prop passed to components:

const config = ref({
  downsample: {
    threshold: 500,
  },
  ...// rest of your config
})

Chart custom background (since v2.4.59)

A #chart-background slot is available on most charts to customize their background, to display a gradient, an image, etc. The content placed inside this slot has pointer-events set to none, so it does not interfere with the components' interactivity.

<VueUiXy :config="config" :dataset="dataset">
  <template #chart-background>
    <div
      style="width: 100%; height: 100%; background: radial-gradient(at top left, red, white)"
    />
  </template>
</VueUiXy>

The following components do not support this slot, because it would not make sense:

• VueUiCarouselTable
• VueUiDag
• VueUiGizmo
• VueUiIcon
• VueUiKpi
• VueUiRating
• VueUiSmiley
• VueUiSparkStackbar
• VueUiSparkbar
• VueUiTableHeatmap
• VueUiTableSparkline
• VueUiTreemap
• VueUiWaffle
• VueUiXyCanvas

Pattern slot (v2.4.67+)

A #pattern slot is available on some components to apply custom patterns on datapoints for further customization. The slot exposes the seriesIndex, and a patternId which must be used on the pattern element to be recognized. A pattern element must be used inside this slot. It will be injected inside a defs element of the component.

<VueUiDonut :config="config" :dataset="dataset">
  <template #pattern="{ seriesIndex, patternId }">
    <!-- Apply a pattern on the first datapoint only -->
    <pattern
      v-if="seriesIndex === 0"
      :id="patternId"
      viewBox="0,0,10,10"
      width="10%"
      height="10%"
    >
      <polygon points="0,0 2,5 0,10 5,8 10,10 8,5 10,0 5,2" />
    </pattern>
  </template>
</VueUiDonut>

The #pattern slot is available on the following components:

• VueUiChord
• VueUiCirclePack
• VueUiDonut
• VueUiGauge
• VueUiRidgeline
• VueUiRings
• VueUiStackbar
• VueUiStackline
• VueUiHorizontalBar
• VueUiWaffle
• VueUiWorld
• VueUiXy

A set of 12 readymade patterns is available through the VueUiPattern component:

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

<VueUiDonut :dataset="dataset" :config="config">
  <template #pattern="{ seriesIndex, patternId }">
    <VueUiPattern :id="patternId" name="bubbles" v-if="seriesIndex === 0" />
    <VueUiPattern :id="patternId" name="squares" v-if="seriesIndex === 1" />
  </template>
</VueUiDonut>

VueUiPattern accepts the following props:

• id: string, required. Pass the patternId provided by the #pattern slot
• name: string, required. The name of the pattern to use
• fill: string, optional. The backgroundColor of the pattern. Transparent by default to show the datapoint base color
• stroke: string, optional. Default: #2D353C
• strokeWidth: number, optional. Default: 1
• scale: number, optional. Default: 1

List of available patterns:

Utility functions

A set of utility functions is available:

import {
  abbreviate,
  darkenColor,
  lightenColor,
  shiftColorHue,
  createTSpans,
  getCumulativeAverage,
  getCumulativeMedian,
} from "vue-data-ui";

abreviate

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

const text = "lorem ipsum dolor sit amet";
const abbreviated = abbreviate({
  source: text,
  length: 5,
}); // Result: LIDSA

darkenColor

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

const color = "#FF0000";
const darkened = darkenColor(color, 0.5); // Result: #800000ff

lightenColor

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

const color = "#FF0000";
const lightened = lightenColor(color, 0.5); // Result: #ff8080ff

shiftColorHue

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

// Color format can be HEX (with or without alpha channel), RGB, RGBA, or named color
const color = "#FF0000";
const shifted = shiftColorHue(color, 0.1); // Result: #ff9900ff

createTSpans

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

const textContent = createTSpans({
  content: "This is an example of multiline text",
  fontSize: 16,
  fill: "#1A1A1A",
  maxWords: 3,
  x: 10,
  y: 20,
});

<!-- The output must be used inside a svg text element with `v-html`, for example in a #data-label slot, or in your own svg -->

<text
  :x="10"
  :y="20"
  fill="#1A1A1A"
  :font-size="16"
  text-anchor="middle"
  v-html="textContent"
/>

getCumulativeAverage

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

// simple usage
const arr = [0, 1, 2, 3, 4];
const cumulativeAvg = getCumulativeAverage({ values: arr });

// Ignore invalid values entirely
const arrWithInvalid = [1, null, 2, Infinity, NaN, undefined];
const cumulativeAvgNoInvalid = getCumulativeAverage({
  values: arrWithInvalid,
  config: {
    keepInvalid: false,
  },
});

// Convert invalid values to zero
const cumulativeAvgZeroed = getCumulativeAverage({
  values: arrWithInvalid,
  config: {
    convertInvalidToZero: true,
  },
});

getCumulativeMedian

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

// simple usage
const arr = [0, 1, 2, 3, 4];
const cumulativeMed = getCumulativeMedian({ values: arr });

// Ignore invalid values entirely
const arrWithInvalid = [1, null, 2, Infinity, NaN, undefined];
const cumulativeMedNoInvalid = getCumulativeMedian({
  values: arrWithInvalid,
  config: {
    keepInvalid: false,
  },
});

// Convert invalid values to zero
const cumulativeMedZeroed = getCumulativeMedian({
  values: arrWithInvalid,
  config: {
    convertInvalidToZero: true,
  },
});

mergeConfigs

import { mergeConfigs, getVueDataUiConfig } from "vue-data-ui";
const defaultConfig = getVueDataUiConfig("vue_ui_xy");

// Create a full config with user overrides
const merged = mergeConfigs({
  defaultConfig,
  userConfig: {
    chart: {
      backgroundColor: "#FF0000",
    },
  },
});

Multiline data labels

Some components will display labels on multiple lines when the provided text contains a line break. (example: "I contain a\nline break"). Below is a table of the places where such line breaks can be used:

PDF generation

This package requires jspdf as a peer dependency. Please install it in your project if you intend to use the PDF printing feature.

useObjectBindings

A composable that flattens a reactive object into a set of refs (one for each “leaf” property) so you can easily bind to deeply nested values by their string paths.

Why use it?

• Automatic reactivity: Every nested property becomes a Ref, with automatic getters/setters that keep your source object in sync.
• Flat API surface: Access or update any nested field by its dot‑delimited path, without writing deep destructuring or ref plumbing.
• Dynamic path support: New paths added at runtime are discovered automatically (and proxied), so you never lose reactivity when mutating the structure.

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

const config = ref(getVueDataUiConfig("vue_ui_donut")); // or your custom config for this component

const bindings = useObjectBindings(config);
// Now `bindings` has computed refs for each leaf path:
//   bindings["style.chart.backgroundColor"] → Ref<string>
//   bindings["style.chart.color"] → Ref<string>
//   bindings["customPalette"] → Ref<boolean>
//   by default, arrays are skipped:
//   no "customPalette.0", unless you disable skipArrays

You can then use these in your template:

<template>
  <div>
    <input
      type="color"
      v-model="bindings['style.chart.backgroundColor'].value"
    />
  </div>
</template>

Exposed methods

Most chart components expose the following methods:

getData

const componentRef = ref(null);

onMounted(async () => {
  if (componentRef) {
    const data = await componentRef.value.getData();
    console.log(data);
  }
});

getImage

const componentRef = ref(null);

onMounted(async () => {
  if (componentRef) {
    const { imgUri, base64, title, width, height, aspectRatio } =
      await componentRef.value.getImage({ scale: 2 }); // optional scale, defaults to 2, increase for better image quality
    console.log(imageUri);
  }
});

showSeries / hideSeries

showSeries: (name: string) => void
hideSeries: (name: string) => void

Set a ref on your chart component to call exposed methods:

<VueUiXy ref="chart" :dataset="dataset" :config="config" />

Example:

const chart = ref(null); // Add this ref on the chart component

function showSeriesByName(name) {
  if (!chart.value) return;
  chart.value.showSeries(name);
}

function hideSeriesByName(name) {
  if (!chart.value) return;
  chart.value.hideSeries(name);
}

showSeries and hideSeries exposed methods are available on the following components:

• VueUiDonut
• VueUiDonutEvolution
• VueUiGalaxy
• VueUiHistoryPlot
• VueUiHorizontalBar
• VueUiNestedDonuts
• VueUiOnion
• VueUiParallelCoordinatePlot
• VueUiQuadrant
• VueUiRadar
• VueUiRidgeline
• VueUiRings
• VueUiScatter
• VueUiSparkStackbar
• VueUiStackbar
• VueUiStackline
• VueUiTreemap
• VueUiWaffle
• VueUiXy
• VueUiXyCanvas