DevExtreme v24.1 is now available.

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

Your search did not match any results.

Custom Annotations

Annotations are containers for images, text blocks, and custom content. By using annotations, you can display additional information to your end users and improve the readability of data visualized within your app.

To create annotations, populate the VectorMap'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
import React from 'react'; import VectorMap, { Layer, CommonAnnotationSettings, Annotation, } from 'devextreme-react/vector-map'; import * as mapsData from 'devextreme-dist/js/vectormap-data/usa.js'; import { statesData } from './data.ts'; import AnnotationTemplate from './AnnotationTemplate.tsx'; const bounds = [-118, 55, -80, 23]; const App = () => ( <VectorMap id="vector-map" bounds={bounds}> <Layer dataSource={mapsData.usa} > </Layer> <CommonAnnotationSettings type="custom" render={AnnotationTemplate} > </CommonAnnotationSettings> {statesData.map((state) => ( <Annotation coordinates={state.coordinates} offsetX={state.offsetX} offsetY={state.offsetY} key={state.data.name} data={state.data} > </Annotation> )) } </VectorMap> ); export default App;
import React from 'react'; import VectorMap, { Layer, CommonAnnotationSettings, Annotation, } from 'devextreme-react/vector-map'; import * as mapsData from 'devextreme-dist/js/vectormap-data/usa.js'; import { statesData } from './data.js'; import AnnotationTemplate from './AnnotationTemplate.js'; const bounds = [-118, 55, -80, 23]; const App = () => ( <VectorMap id="vector-map" bounds={bounds} > <Layer dataSource={mapsData.usa}></Layer> <CommonAnnotationSettings type="custom" render={AnnotationTemplate} ></CommonAnnotationSettings> {statesData.map((state) => ( <Annotation coordinates={state.coordinates} offsetX={state.offsetX} offsetY={state.offsetY} key={state.data.name} data={state.data} ></Annotation> ))} </VectorMap> ); export default App;
import React from 'react'; import { ICommonAnnotationSettingsProps } from 'devextreme-react/vector-map'; const getImagePath = (name: string) => `../../../../images/flags/${name?.replace(/\s/, '')}.svg`; const formatNumber = new Intl.NumberFormat('en-US', { minimumFractionDigits: 0, }).format; const AnnotationTemplate: ICommonAnnotationSettingsProps['render'] = ({ data: { name, capital, population, area, }, }) => ( <svg className="annotation"> <image href={getImagePath(name)} width="60" height="40" /> <rect x={0} y={0} className="border"></rect> <text x="70" y="25" className="state">{name}</text> <text x="0" y="60"> <tspan className="caption">Capital:</tspan> <tspan className="capital" dx="5">{capital}</tspan> <tspan dy="14" x="0" className="caption">Population:</tspan> <tspan className="population" dx="5">{formatNumber(population)}</tspan> <tspan dy="14" x="0" className="caption">Area:</tspan> <tspan className="area" dx="5">{formatNumber(area)}</tspan> <tspan dx="5">km</tspan> <tspan className="sup" dy="-2">2</tspan> </text> </svg> ); export default AnnotationTemplate;
import React from 'react'; import ReactDOM from 'react-dom'; import App from './App.tsx'; ReactDOM.render( <App />, document.getElementById('app'), );
export const statesData = [{ coordinates: [-75.4999, 43.00035], data: { name: 'New York', population: 19746227, capital: 'Albany', area: 141297, }, }, { coordinates: [-89, 40], offsetX: -100, offsetY: -80, data: { name: 'Illinois', population: 12880580, capital: 'Springfield', area: 149995, }, }, { coordinates: [-81.760254, 27.994402], data: { name: 'Florida', population: 19893297, capital: 'Tallahassee', area: 170312, }, }, { coordinates: [-100, 31], data: { name: 'Texas', population: 26956958, capital: 'Austin', area: 695662, }, }, { coordinates: [-119.417931, 36.778259], data: { name: 'California', population: 38802500, capital: 'Sacramento', area: 423967, }, }];
window.exports = window.exports || {}; window.config = { transpiler: 'ts', typescriptOptions: { module: 'system', emitDecoratorMetadata: true, experimentalDecorators: true, jsx: 'react', }, meta: { 'react': { 'esModule': true, }, 'typescript': { 'exports': 'ts', }, 'devextreme/time_zone_utils.js': { 'esModule': true, }, 'devextreme/localization.js': { 'esModule': true, }, 'devextreme/viz/palette.js': { 'esModule': true, }, 'devextreme-dist/js/vectormap-data/*': { 'esModule': true, }, }, paths: { 'npm:': 'https://unpkg.com/', }, defaultExtension: 'js', map: { 'ts': 'npm:plugin-typescript@4.2.4/lib/plugin.js', 'typescript': 'npm:typescript@4.2.4/lib/typescript.js', 'react': 'npm:react@17.0.2/umd/react.development.js', 'react-dom': 'npm:react-dom@17.0.2/umd/react-dom.development.js', 'prop-types': 'npm:prop-types@15.8.1/prop-types.js', 'devextreme-dist/js/vectormap-data': 'npm:devextreme-dist@24.1.4/js/vectormap-data', '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.4/cjs', 'devextreme-react': 'npm:devextreme-react@24.1.4/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.10/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', 'devextreme-cldr-data': 'npm:devextreme-cldr-data@1.0.3', // SystemJS plugins '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': { defaultExtension: 'js', }, 'devextreme-react': { main: 'index.js', }, 'devextreme/events/utils': { main: 'index', }, 'devextreme/localization/messages': { format: 'json', defaultExtension: 'json', }, '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, react: true, }, }; System.config(window.config);
import React from 'react'; const getImagePath = (name) => `../../../../images/flags/${name?.replace(/\s/, '')}.svg`; const formatNumber = new Intl.NumberFormat('en-US', { minimumFractionDigits: 0, }).format; const AnnotationTemplate = ({ data: { name, capital, population, area, }, }) => ( <svg className="annotation"> <image href={getImagePath(name)} width="60" height="40" /> <rect x={0} y={0} className="border" ></rect> <text x="70" y="25" className="state" > {name} </text> <text x="0" y="60" > <tspan className="caption">Capital:</tspan> <tspan className="capital" dx="5" > {capital} </tspan> <tspan dy="14" x="0" className="caption" > Population: </tspan> <tspan className="population" dx="5" > {formatNumber(population)} </tspan> <tspan dy="14" x="0" className="caption" > Area: </tspan> <tspan className="area" dx="5" > {formatNumber(area)} </tspan> <tspan dx="5">km</tspan> <tspan className="sup" dy="-2" > 2 </tspan> </text> </svg> ); export default AnnotationTemplate;
import React from 'react'; import ReactDOM from 'react-dom'; import App from './App.js'; ReactDOM.render(<App />, document.getElementById('app'));
export const statesData = [ { coordinates: [-75.4999, 43.00035], data: { name: 'New York', population: 19746227, capital: 'Albany', area: 141297, }, }, { coordinates: [-89, 40], offsetX: -100, offsetY: -80, data: { name: 'Illinois', population: 12880580, capital: 'Springfield', area: 149995, }, }, { coordinates: [-81.760254, 27.994402], data: { name: 'Florida', population: 19893297, capital: 'Tallahassee', area: 170312, }, }, { coordinates: [-100, 31], data: { name: 'Texas', population: 26956958, capital: 'Austin', area: 695662, }, }, { coordinates: [-119.417931, 36.778259], data: { name: 'California', population: 38802500, capital: 'Sacramento', area: 423967, }, }, ];
<!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.4/css/dx.light.css" /> <link rel="stylesheet" type="text/css" href="styles.css" /> <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.tsx"); </script> </head> <body class="dx-viewport"> <div class="demo-container"> <div id="app"></div> </div> </body> </html>
#vector-map { height: 440px; } .annotation { font-size: 12px; } .border { width: 60px; height: 40px; stroke: rgba(191, 191, 191, 0.25); stroke-width: 1px; fill: transparent; } .state { font-weight: 500; font-size: 14px; } .caption { font-weight: 500; } .sup { font-size: 0.8em; }

You can set each annotation type property to "text", "image", or "custom". In this demo, annotation type has been set to "custom".

Custom annotations require that you specify your own display template in SVG format. As you can see in the demo code, you can access annotation data within template markup.

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