Your search did not match any results.
Vector Map

Custom Annotations

Documentation

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 widget'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.

You can set each annotation type option 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.

Copy to CodeSandBox
Apply
Reset
<template> <DxVectorMap id="vector-map" :bounds="bounds" > <DxLayer :data-source="usa" /> <DxCommonAnnotationSettings type="custom" template="annotationTemplate" /> <DxAnnotation v-for="state in statesData" :coordinates="state.coordinates" :offset-x="state.offsetX" :offset-y="state.offsetY" :data="state.data" :key="state.data.name" /> <template #annotationTemplate="{ data }"> <AnnotationTemplate :annotation="data"/> </template> </DxVectorMap> </template> <script> import * as mapsData from 'devextreme/dist/js/vectormap-data/usa.js'; import { DxVectorMap, DxLayer, DxAnnotation, DxCommonAnnotationSettings } from 'devextreme-vue/vector-map'; import { statesData } from './data.js'; import AnnotationTemplate from './AnnotationTemplate.vue'; export default { components: { DxVectorMap, DxLayer, DxAnnotation, DxCommonAnnotationSettings, AnnotationTemplate }, data() { return { statesData, usa: mapsData.usa, bounds: [-118, 55, -80, 23] }; } }; </script> <style> #vector-map { height: 440px; } </style>
<template> <svg class="annotation"> <image :href="getImagePath()" width="60" height="40" /> <rect x="0" y="0" class="border" /> <text x="70" y="25" class="state" >{{ data.name }}</text> <text x="0" y="60" > <tspan class="caption">Capital:</tspan><tspan class="capital" dx="5">{{ data.capital }}</tspan><tspan dy="14" x="0" class="caption" >Population:</tspan><tspan class="population" dx="5">{{ formatNumber(data.population) }}</tspan><tspan dy="14" x="0" class="caption" >Area:</tspan><tspan class="area" dx="5">{{ formatNumber(data.area) }}</tspan><tspan dx="5">km</tspan><tspan class="sup" dy="-2" >2</tspan> </text> </svg> </template> <script> export default { props: { annotation: { type: Object, default: () => ({}) } }, data() { return { data: this.annotation.data }; }, methods: { getImagePath() { return `../../../../images/flags/${this.data.name.replace(/\s/, '')}.svg`; }, formatNumber: new Intl.NumberFormat('en-US', { minimumFractionDigits: 0 }).format } }; </script> <style> .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; } </style>
import { createApp } from 'vue'; import App from './App.vue'; createApp(App).mount('#app');
<!DOCTYPE html> <html> <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=1.0" /> <link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/20.2.4/css/dx.common.css" /> <link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/20.2.4/css/dx.light.css" /> <script src="https://unpkg.com/core-js@2.4.1/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.js'); </script> </head> <body class="dx-viewport"> <div class="demo-container"> <div id="app"></div> </div> </body> </html>
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 } }];
System.config({ transpiler: 'plugin-babel', meta: { '*.vue': { loader: 'vue-loader' }, 'devextreme/dist/js/vectormap-data/*': { 'esModule': true }, }, paths: { 'npm:': 'https://unpkg.com/' }, map: { 'vue': 'npm:vue@3.0.0/dist/vue.esm-browser.js', 'vue-loader': 'npm:dx-systemjs-vue-browser@1.0.15/index.js', 'devextreme/dist/js/vectormap-data': 'js/vectormap-data', 'mitt': 'npm:mitt/dist/mitt.umd.js', 'rrule': 'npm:rrule@2.6.6/dist/es5/rrule.js', 'luxon': 'npm:luxon@1.25.0/build/global/luxon.min.js', 'es6-object-assign': 'npm:es6-object-assign@1.1.0', 'devextreme': 'npm:devextreme@20.2.4', 'devextreme-vue': 'npm:devextreme-vue@20.2.4', 'jszip': 'npm:jszip@3.5.0/dist/jszip.min.js', 'devextreme-quill': 'npm:devextreme-quill@0.9.7/dist/dx-quill.min.js', 'devexpress-diagram': 'npm:devexpress-diagram@2.0.5/dist/dx-diagram.js', 'devexpress-gantt': 'npm:devexpress-gantt@2.0.8/dist/dx-gantt.js', 'preact': 'npm:preact@10.5.7/dist/preact.js', 'preact/hooks': 'npm:preact@10.5.7/hooks/dist/hooks.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' }, 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' } }, babelOptions: { sourceMaps: false, stage0: true } });