JavaScript/jQuery Vector Map - 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 JavaScript 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.

Was this demo helpful?

Thank you!

Feel free to share demo-related thoughts here.
If you have technical questions, please create a support ticket in the DevExpress Support Center.

Thank you for the feedback!

Backend API

$(() => { const formatNumber = new Intl.NumberFormat('en-US', { maximumFractionDigits: 0 }).format; $('#vector-map').dxVectorMap({ bounds: [-118, 55, -80, 23], commonAnnotationSettings: { type: 'custom', template(annotation, container) { const { data } = annotation; const contentItems = ["<svg class='annotation'>", "<image href='../../../../images/flags/", data.name.replace(/\s/, '').toLowerCase(), ".svg' width='60' height='40' />", "<rect class='border' x='0' y='0' />", "<text x='70' y='25' class='state'/>", "<text x='0' y='60'>", "<tspan class='caption'>Capital:</tspan>", "<tspan class='capital' dx='5'/>", "<tspan dy='14' x='0' class='caption'>Population:</tspan>", "<tspan class='population' dx='5'/>", "<tspan dy='14' x='0' class='caption'>Area:</tspan>", "<tspan class='area' dx='5'/>", "<tspan dx='5'>km</tspan><tspan dy='-2' class='sup'>2</tspan>", '</text></svg>']; const content = $(contentItems.join('')); content.find('.state').text(data.name); content.find('.capital').text(data.capital); content.find('.population').text(formatNumber(data.population)); content.find('.area').text(formatNumber(data.area)); content.appendTo(container); }, }, annotations: statesData, layers: [{ dataSource: DevExpress.viz.map.sources.usa, }], }); });

<!DOCTYPE html> <html xmlns="http://www.w3.org/1999/xhtml" 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" /> <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.5.1/jquery.min.js"></script> <script>window.jQuery || document.write(decodeURIComponent('%3Cscript src="js/jquery.min.js"%3E%3C/script%3E'))</script> <link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/25.1.3/css/dx.light.css" /> <script src="js/dx.all.js"></script> <script src="https://cdn3.devexpress.com/jslib/25.1.3/js/vectormap-data/world.js"></script> <script src="https://cdn3.devexpress.com/jslib/25.1.3/js/vectormap-data/africa.js"></script> <script src="https://cdn3.devexpress.com/jslib/25.1.3/js/vectormap-data/canada.js"></script> <script src="https://cdn3.devexpress.com/jslib/25.1.3/js/vectormap-data/eurasia.js"></script> <script src="https://cdn3.devexpress.com/jslib/25.1.3/js/vectormap-data/europe.js"></script> <script src="https://cdn3.devexpress.com/jslib/25.1.3/js/vectormap-data/usa.js"></script> <script src="data.js"></script> <link rel="stylesheet" type="text/css" href="styles.css" /> <script src="index.js"></script> </head> <body class="dx-viewport"> <div class="demo-container"> <div id="vector-map"></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; }

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, }, }];

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.