DevExtreme v24.1 is now available.

Explore our newest features/capabilities and share your thoughts with us.

Your search did not match any results.

Pie with Annotations

Annotations are containers for images, text blocks, and custom content. Annotations can help deliver a more refined user-experience and can improve analysis and readability (by displaying additional information for visualized data).

To create annotations, populate the PieChart's annotations array. Each object in the array configures an individual annotation. To specify settings for all annotations, use the commonAnnotationSettings object. Individual settings take precedence over common settings.

Backend API
<template> <DxPieChart id="pie" :data-source="dataSource" palette="Vintage" title="Ice Hockey World Championship Gold Medal Winners" > <DxCommonAnnotationSettings :padding-left-right="0" :padding-top-bottom="0" type="image" color="transparent" tooltip-template="tooltipTemplate" > <DxImage :height="60" :width="90" /> <DxBorder color="transparent"/> </DxCommonAnnotationSettings> <DxAnnotation v-for="item in annotations" :key="item.country" :argument="item.country" :data="item.data" :location="item.location" :offset-x="item.offsetX" :offset-y="item.offsetY" :color="item.color" > <DxImage :url="item.image"/> <DxBorder :color="item.borderColor"/> <DxShadow :opacity="item.shadowOpacity"/> </DxAnnotation> <DxSeries argument-field="country" value-field="gold" > <DxLabel :visible="true" :radial-offset="83" position="inside" background-color="transparent" > <DxFont :size="16" :weight="600" /> </DxLabel> </DxSeries> <DxTooltip :padding-left-right="12" :padding-top-bottom="10" /> <DxLegend :visible="false"/> <template #tooltipTemplate="{ data }"> <TooltipTemplate :annotation="data"/> </template> </DxPieChart> </template> <script setup lang="ts"> import DxPieChart, { DxCommonAnnotationSettings, DxAnnotation, DxImage, DxBorder, DxShadow, DxSeries, DxLabel, DxFont, DxTooltip, DxLegend, } from 'devextreme-vue/pie-chart'; import { dataSource, getAnnotationSources } from './data.ts'; import TooltipTemplate from './TooltipTemplate.vue'; const annotations = getAnnotationSources(); </script> <style> #pie { height: 440px; } </style>
<template> <div class="medal-tooltip"> <div class="country-name">{{ data.country }} <br v-if="data.oldCountryName">{{ data.oldCountryName }} </div> <div class="gold"> <span class="caption">Gold</span>: {{ data.gold }} </div> <div class="silver"> <span class="caption">Silver</span>: {{ data.silver }} </div> <div class="bronze"> <span class="caption">Bronze</span>: {{ data.bronze }} </div> </div> </template> <script setup lang="ts"> import { ref } from 'vue'; const props = withDefaults(defineProps<{ annotation?: Record<string, any> }>(), { annotation: () => ({}), }); const data = ref(props.annotation.data); </script> <style> .medal-tooltip { font-size: 12px; } .medal-tooltip .country-name { font-size: 14px; font-weight: 700; margin: 5px 0 10px 0; } .medal-tooltip .caption { font-weight: 600; } </style>
window.exports = window.exports || {}; window.config = { transpiler: 'plugin-babel', meta: { '*.vue': { loader: 'vue-loader', }, '*.ts': { loader: 'demo-ts-loader', }, '*.svg': { loader: 'svg-loader', }, 'devextreme/time_zone_utils.js': { 'esModule': true, }, 'devextreme/localization.js': { 'esModule': true, }, 'devextreme/viz/palette.js': { 'esModule': true, }, }, paths: { 'root:': '../../../../', 'npm:': 'https://unpkg.com/', }, map: { 'vue': 'npm:vue@3.2.47/dist/vue.esm-browser.js', 'vue-loader': 'npm:dx-systemjs-vue-browser@1.1.1/index.js', 'demo-ts-loader': 'root:utils/demo-ts-loader.js', 'svg-loader': 'root:utils/svg-loader.js', 'mitt': 'npm:mitt/dist/mitt.umd.js', 'rrule': 'npm:rrule@2.6.4/dist/es5/rrule.js', 'luxon': 'npm:luxon@1.28.1/build/global/luxon.min.js', 'es6-object-assign': 'npm:es6-object-assign@1.1.0', 'devextreme': 'npm:devextreme@24.1.3/cjs', 'devextreme-vue': 'npm:devextreme-vue@24.1.3/cjs', 'jszip': 'npm:jszip@3.10.1/dist/jszip.min.js', 'devextreme-quill': 'npm:devextreme-quill@1.7.1/dist/dx-quill.min.js', 'devexpress-diagram': 'npm:devexpress-diagram@2.2.8/dist/dx-diagram.js', 'devexpress-gantt': 'npm:devexpress-gantt@4.1.56/dist/dx-gantt.js', '@devextreme/runtime': 'npm:@devextreme/runtime@3.0.13', 'inferno': 'npm:inferno@7.4.11/dist/inferno.min.js', 'inferno-compat': 'npm:inferno-compat/dist/inferno-compat.min.js', 'inferno-create-element': 'npm:inferno-create-element@7.4.11/dist/inferno-create-element.min.js', 'inferno-dom': 'npm:inferno-dom/dist/inferno-dom.min.js', 'inferno-hydrate': 'npm:inferno-hydrate@7.4.11/dist/inferno-hydrate.min.js', 'inferno-clone-vnode': 'npm:inferno-clone-vnode/dist/inferno-clone-vnode.min.js', 'inferno-create-class': 'npm:inferno-create-class/dist/inferno-create-class.min.js', 'inferno-extras': 'npm:inferno-extras/dist/inferno-extras.min.js', 'plugin-babel': 'npm:systemjs-plugin-babel@0.0.25/plugin-babel.js', 'systemjs-babel-build': 'npm:systemjs-plugin-babel@0.0.25/systemjs-babel-browser.js', // Prettier 'prettier/standalone': 'npm:prettier@2.8.8/standalone.js', 'prettier/parser-html': 'npm:prettier@2.8.8/parser-html.js', }, packages: { 'devextreme-vue': { main: 'index.js', }, 'devextreme': { defaultExtension: 'js', }, 'devextreme/events/utils': { main: 'index', }, 'devextreme/events': { main: 'index', }, 'es6-object-assign': { main: './index.js', defaultExtension: 'js', }, }, packageConfigPaths: [ 'npm:@devextreme/*/package.json', 'npm:@devextreme/runtime@3.0.13/inferno/package.json', ], babelOptions: { sourceMaps: false, stage0: true, }, }; System.config(window.config);
const annotationSources = [{ country: 'Russia', offsetX: 15, offsetY: 5, }, { country: 'Canada', offsetY: 10, }, { country: 'Czech Republic', offsetX: -5, offsetY: -35, }, { country: 'Sweden', offsetX: 20, offsetY: -25, }, { country: 'Finland', location: 'edge', offsetX: 45, offsetY: -85, }, { country: 'United States', location: 'edge', offsetX: 85, offsetY: -45, }, { country: 'Great Britain', location: 'edge', offsetX: 81, offsetY: 15, }, { country: 'Slovakia', location: 'edge', offsetX: 45, offsetY: 80, }]; const edgeAnnotationSettings = { color: '#aaaaaa', borderColor: '#aaaaaa', shadowOpacity: 0.3, }; export const dataSource = [{ country: 'Russia', oldCountryName: 'Soviet Union', gold: 27, silver: 10, bronze: 10, }, { country: 'Canada', gold: 26, silver: 15, bronze: 9, }, { country: 'Czech Republic', oldCountryName: 'Czechoslovakia', gold: 12, silver: 13, bronze: 21, }, { country: 'Sweden', gold: 11, silver: 19, bronze: 17, }, { country: 'Finland', gold: 3, silver: 8, bronze: 3, }, { country: 'United States', gold: 2, silver: 9, bronze: 8, }, { country: 'Great Britain', gold: 1, silver: 2, bronze: 2, }, { country: 'Slovakia', gold: 1, silver: 2, bronze: 1, }]; export function getAnnotationSources() { const annotations = []; for (let i = 0; i < annotationSources.length; i += 1) { const annotation = annotationSources[i]; const { country } = annotation; const image = `../../../../images/flags/3x2/${country.replace(/\s/, '')}.svg`; const data = { ...dataSource.filter((d) => (d.country === country))[0] }; annotations.push({ ...annotation, image, data, ...(annotation.location === 'edge' ? edgeAnnotationSettings : {}), }); } return annotations; }
import { createApp } from 'vue'; import App from './App.vue'; createApp(App).mount('#app');
<!DOCTYPE html> <html lang="en"> <head> <title>DevExtreme Demo</title> <meta http-equiv="X-UA-Compatible" content="IE=edge" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=5.0" /> <link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/24.1.3/css/dx.light.css" /> <script src="https://unpkg.com/typescript@4.9.5/lib/typescript.js"></script> <script type="module"> import * as vueCompilerSFC from "https://unpkg.com/@vue/compiler-sfc@3.4.16/dist/compiler-sfc.esm-browser.js"; window.vueCompilerSFC = vueCompilerSFC; </script> <script src="https://unpkg.com/core-js@2.6.12/client/shim.min.js"></script> <script src="https://unpkg.com/systemjs@0.21.3/dist/system.js"></script> <script type="text/javascript" src="config.js"></script> <script type="text/javascript"> System.import("./index.ts"); </script> </head> <body class="dx-viewport"> <div class="demo-container"> <div id="app"> </div> </div> </body> </html>

You can set each annotation type property to "text", "image", or "custom". In this demo, the type used for all annotations is "image".

Annotations can deliver more information if you add tooltips. A tooltip appears when users hover the mouse pointer over an annotation. This demo illustrates how you can implement a tooltip with custom content via the tooltipTemplate property.

For more information on annotation settings, refer to the annotations[] help topic.