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
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]; export default function App() { return ( <VectorMap id="vector-map" bounds={bounds}> <Layer dataSource={mapsData.usa} > </Layer> <CommonAnnotationSettings type="custom" render={AnnotationTemplate} > </CommonAnnotationSettings> {statesData.map(state => { return ( <Annotation coordinates={state.coordinates} offsetX={state.offsetX} offsetY={state.offsetY} key={state.data.name} data={state.data} > </Annotation> ); }) } </VectorMap> ); }
import React from 'react'; function getImagePath(data) { return `../../../../images/flags/${data.name.replace(/\s/, '')}.svg`; } const formatNumber = new Intl.NumberFormat('en-US', { minimumFractionDigits: 0 }).format; export default function AnnotationTemplate(annotation) { const data = annotation.data; return ( <svg className="annotation"> <image href={getImagePath(data)} width="60" height="40" /> <rect x={0} y={0} className="border"></rect> <text x="70" y="25" className="state">{data.name}</text> <text x="0" y="60"> <tspan className="caption">Capital:</tspan> <tspan className="capital" dx="5">{data.capital}</tspan> <tspan dy="14" x="0" className="caption">Population:</tspan> <tspan className="population" dx="5">{formatNumber(data.population)}</tspan> <tspan dy="14" x="0" className="caption">Area:</tspan> <tspan className="area" dx="5">{formatNumber(data.area)}</tspan> <tspan dx="5">km</tspan> <tspan className="sup" dy="-2">2</tspan> </text> </svg> ); }
import React from 'react'; import ReactDOM from 'react-dom'; import App from './App.js'; ReactDOM.render( <App />, document.getElementById('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" /> <link rel="stylesheet" type="text/css" href="styles.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>
#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; }
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: { 'devextreme/dist/js/vectormap-data/*': { 'esModule': true }, }, paths: { 'npm:': 'https://unpkg.com/' }, defaultExtension: 'js', map: { 'react': 'npm:react@16.14.0/umd/react.development.js', 'react-dom': 'npm:react-dom@16.14.0/umd/react-dom.development.js', 'prop-types': 'npm:prop-types@15.7.2/prop-types.js', 'devextreme/dist/js/vectormap-data': 'js/vectormap-data', '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-react': 'npm:devextreme-react@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', // 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' }, packages: { 'devextreme': { defaultExtension: 'js' }, 'devextreme-react': { main: 'index.js' }, 'devextreme/events/utils': { main: 'index' }, 'devextreme/events': { main: 'index' }, 'es6-object-assign': { main: './index.js', defaultExtension: 'js' } }, babelOptions: { sourceMaps: false, stage0: true, react: true } });