React Charts - 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.

TS JS

Backend API

import React from 'react'; import PieChart, { CommonAnnotationSettings, Annotation, Image, Border, Shadow, Series, Label, Font, Tooltip, Legend, } from 'devextreme-react/pie-chart'; import { dataSource, getAnnotationSources } from './data.ts'; import TooltipTemplate from './TooltipTemplate.tsx'; const annotationSources = getAnnotationSources(); function App() { return ( <PieChart id="pie" palette="Vintage" dataSource={dataSource} title="Ice Hockey World Championship Gold Medal Winners" > <CommonAnnotationSettings type="image" color="transparent" paddingLeftRight={0} paddingTopBottom={0} tooltipRender={TooltipTemplate} > <Image height={60} width={90} /> <Border color="transparent" /> </CommonAnnotationSettings> { annotationSources.map((item) => ( <Annotation key={item.country} argument={item.country} data={item.data} location={item.location} offsetX={item.offsetX} offsetY={item.offsetY} color={item.color}> <Image url={item.image} /> <Border color={item.borderColor} /> <Shadow opacity={item.shadowOpacity} /> </Annotation> )) } <Series argumentField="country" valueField="gold"> <Label visible position="inside" radialOffset={83} backgroundColor="transparent"> <Font size={16} weight={600} /> </Label> </Series> <Tooltip paddingLeftRight={12} paddingTopBottom={10} /> <Legend visible={false} /> </PieChart> ); } export default App;

import React from 'react'; import PieChart, { CommonAnnotationSettings, Annotation, Image, Border, Shadow, Series, Label, Font, Tooltip, Legend, } from 'devextreme-react/pie-chart'; import { dataSource, getAnnotationSources } from './data.js'; import TooltipTemplate from './TooltipTemplate.js'; const annotationSources = getAnnotationSources(); function App() { return ( <PieChart id="pie" palette="Vintage" dataSource={dataSource} title="Ice Hockey World Championship Gold Medal Winners" > <CommonAnnotationSettings type="image" color="transparent" paddingLeftRight={0} paddingTopBottom={0} tooltipRender={TooltipTemplate} > <Image height={60} width={90} /> <Border color="transparent" /> </CommonAnnotationSettings> {annotationSources.map((item) => ( <Annotation key={item.country} argument={item.country} data={item.data} location={item.location} offsetX={item.offsetX} offsetY={item.offsetY} color={item.color} > <Image url={item.image} /> <Border color={item.borderColor} /> <Shadow opacity={item.shadowOpacity} /> </Annotation> ))} <Series argumentField="country" valueField="gold" > <Label visible position="inside" radialOffset={83} backgroundColor="transparent" > <Font size={16} weight={600} /> </Label> </Series> <Tooltip paddingLeftRight={12} paddingTopBottom={10} /> <Legend visible={false} /> </PieChart> ); } export default App;

import React from 'react'; interface AnnotationData { country: string, oldCountryName: string, gold: number, silver: number, bronze: number, } export default function TooltipTemplate(annotation: { data: AnnotationData; }) { const { data } = annotation; return ( <div className='medal-tooltip'> <div className='country-name'>{data.country} {data.oldCountryName && <br />}{data.oldCountryName} </div> <div className='gold'> <span className='caption'>Gold</span>: {data.gold} </div> <div className='silver'> <span className='caption'>Silver</span>: {data.silver} </div> <div className='bronze'> <span className='caption'>Bronze</span>: {data.bronze} </div> </div> ); }

import React from 'react'; import ReactDOM from 'react-dom'; import App from './App.tsx'; ReactDOM.render( <App />, document.getElementById('app'), );

import React from 'react'; export default function TooltipTemplate(annotation) { const { data } = annotation; return ( <div className="medal-tooltip"> <div className="country-name"> {data.country} {data.oldCountryName && <br />} {data.oldCountryName} </div> <div className="gold"> <span className="caption">Gold</span>: {data.gold} </div> <div className="silver"> <span className="caption">Silver</span>: {data.silver} </div> <div className="bronze"> <span className="caption">Bronze</span>: {data.bronze} </div> </div> ); }

import React from 'react'; import ReactDOM from 'react-dom'; import App from './App.js'; ReactDOM.render(<App />, document.getElementById('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/25.1.6/css/dx.light.css" /> <link rel="stylesheet" type="text/css" href="styles.css" /> <script src="https://cdn.jsdelivr.net/npm/core-js@2.6.12/client/shim.min.js"></script> <script src="https://cdn.jsdelivr.net/npm/systemjs@0.21.3/dist/system.js"></script> <script type="text/javascript" src="config.js"></script> <script type="text/javascript"> System.import("./index.tsx"); </script> </head> <body class="dx-viewport"> <div class="demo-container"> <div id="app"></div> </div> </body> </html>

#pie { height: 440px; } .medal-tooltip { font-size: 12px; } .medal-tooltip .country-name { font-size: 14px; font-weight: 700; margin: 5px 0 10px; } .medal-tooltip .caption { font-weight: 600; }

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.