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 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.
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.
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!
If you have technical questions, please create a support ticket in the DevExpress Support Center.
Backend API
<dx-vector-map id="vector-map" [bounds]="[-118, 55, -80, 23]">
<dxi-layer [dataSource]="usaMap"></dxi-layer>
<dxo-common-annotation-settings type="custom" template="template">
</dxo-common-annotation-settings>
<dxi-annotation
*ngFor="let data of states"
[data]="data.data"
[offsetX]="data.offsetX"
[offsetY]="data.offsetY"
[coordinates]="data.coordinates"
>
</dxi-annotation>
<svg *dxTemplate="let annotation of 'template'" class="annotation">
<image attr.href="{{ getImagePath(annotation) }}" width="60" height="40" />
<rect x="0" y="0" class="border" />
<text x="70" y="25" class="state">{{ annotation.data.name }}</text>
<text x="0" y="60">
<tspan class="caption">Capital:</tspan>
<tspan class="capital" dx="5">{{ annotation.data.capital }}</tspan>
<tspan dy="14" x="0" class="caption">Population:</tspan>
<!-- display: inline -->
<tspan class="population" dx="5">{{
annotation.data.population | number : "3.0-0"
}}</tspan>
<tspan dy="14" x="0" class="caption">Area:</tspan>
<!-- display: inline -->
<tspan class="area" dx="5">{{
annotation.data.area | number : "3.0-0"
}}</tspan>
<tspan dx="5">km</tspan>
<tspan class="sup" dy="-2">2</tspan>
</text>
</svg>
</dx-vector-map>
import { NgModule, Component, enableProdMode } from '@angular/core';
import { BrowserModule, BrowserTransferStateModule } from '@angular/platform-browser';
import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
import { DxVectorMapModule } from 'devextreme-angular';
import * as mapsData from 'devextreme-dist/js/vectormap-data/usa.js';
import { StatesCollection, Service } from './app.service';
if (!/localhost/.test(document.location.host)) {
enableProdMode();
}
@Component({
selector: 'demo-app',
providers: [Service],
templateUrl: 'app/app.component.html',
styleUrls: ['app/app.component.css'],
})
export class AppComponent {
usaMap: any = mapsData.usa;
states: StatesCollection[];
constructor(service: Service) {
this.states = service.getStatesData();
}
getImagePath = (annotation) => {
const name = annotation.data.name.replace(/\s/, '');
return `../../../../images/flags/${name}.svg`;
};
}
@NgModule({
imports: [
BrowserModule,
BrowserTransferStateModule,
DxVectorMapModule,
],
declarations: [AppComponent],
bootstrap: [AppComponent],
})
export class AppModule {}
platformBrowserDynamic().bootstrapModule(AppModule);
::ng-deep #vector-map {
height: 440px;
}
::ng-deep .annotation {
font-size: 12px;
}
::ng-deep .border {
width: 60px;
height: 40px;
stroke: rgba(191, 191, 191, 0.25);
stroke-width: 1px;
fill: transparent;
}
::ng-deep .state {
font-weight: 500;
font-size: 14px;
}
::ng-deep .caption {
font-weight: 500;
}
::ng-deep .sup {
font-size: 0.8em;
}
import { Injectable } from '@angular/core';
export class StatesCollection {
coordinates: number[];
offsetX?: number;
offsetY?: number;
data: object;
}
const statesData: StatesCollection[] = [
{
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,
},
},
];
@Injectable()
export class Service {
getStatesData(): StatesCollection[] {
return statesData;
}
}
// In real applications, you should not transpile code in the browser.
// You can see how to create your own application with Angular and DevExtreme here:
// https://js.devexpress.com/Documentation/Guide/Angular_Components/Getting_Started/Create_a_DevExtreme_Application/
window.exports = window.exports || {};
window.config = {
transpiler: 'ts',
typescriptOptions: {
module: 'system',
emitDecoratorMetadata: true,
experimentalDecorators: true,
},
meta: {
'typescript': {
'exports': 'ts',
},
'devextreme-dist/js/vectormap-data/*': {
'esModule': true,
},
'devextreme/localization.js': {
'esModule': true,
},
},
paths: {
'npm:': 'https://unpkg.com/',
},
map: {
'ts': 'npm:plugin-typescript@4.2.4/lib/plugin.js',
'typescript': 'npm:typescript@4.2.4/lib/typescript.js',
'@angular/core': 'npm:@angular/core@12.2.17',
'@angular/platform-browser': 'npm:@angular/platform-browser@12.2.17',
'@angular/platform-browser-dynamic': 'npm:@angular/platform-browser-dynamic@12.2.17',
'@angular/forms': 'npm:@angular/forms@12.2.17',
'@angular/common': 'npm:@angular/common@12.2.17',
'@angular/compiler': 'npm:@angular/compiler@12.2.17',
'tslib': 'npm:tslib@2.3.1/tslib.js',
'rxjs': 'npm:rxjs@7.5.3/dist/bundles/rxjs.umd.js',
'rxjs/operators': 'npm:rxjs@7.5.3/dist/cjs/operators/index.js',
'devextreme-dist/js/vectormap-data': 'npm:devextreme-dist@23.1.6/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@23.1.6/cjs',
'devextreme/bundles/dx.all': 'npm:devextreme@23.1.6/bundles/dx.all.js',
'jszip': 'npm:jszip@3.7.1/dist/jszip.min.js',
'devextreme-quill': 'npm:devextreme-quill@1.6.2/dist/dx-quill.min.js',
'devexpress-diagram': 'npm:devexpress-diagram@2.2.2',
'devexpress-gantt': 'npm:devexpress-gantt@4.1.49',
'devextreme-angular': 'npm:devextreme-angular@23.1.6',
'@devextreme/runtime': 'npm:@devextreme/runtime@3.0.12',
'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',
// Prettier
'prettier/standalone': 'npm:prettier@2.8.4/standalone.js',
'prettier/parser-html': 'npm:prettier@2.8.4/parser-html.js',
},
packages: {
'app': {
main: './app.component.ts',
defaultExtension: 'ts',
},
'devextreme': {
defaultExtension: 'js',
},
'devextreme/events/utils': {
main: 'index',
},
'devextreme/events': {
main: 'index',
},
'es6-object-assign': {
main: './index.js',
defaultExtension: 'js',
},
'rxjs': {
defaultExtension: 'js',
},
'rxjs/operators': {
defaultExtension: 'js',
},
},
packageConfigPaths: [
'npm:@devextreme/*/package.json',
'npm:@devextreme/runtime@3.0.12/inferno/package.json',
'npm:@angular/*/package.json',
'npm:@angular/common@12.2.17/*/package.json',
'npm:rxjs@7.5.3/package.json',
'npm:rxjs@7.5.3/operators/package.json',
'npm:devextreme-angular@23.1.6/*/package.json',
'npm:devextreme-angular@23.1.6/ui/*/package.json',
'npm:devextreme-angular@23.1.6/package.json',
'npm:devexpress-diagram@2.2.2/package.json',
'npm:devexpress-gantt@4.1.49/package.json',
],
};
System.config(window.config);
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<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/23.1.5/css/dx.light.css" />
<script src="https://unpkg.com/core-js@2.6.12/client/shim.min.js"></script>
<script src="https://unpkg.com/zone.js@0.12.0/dist/zone.js"></script>
<script src="https://unpkg.com/reflect-metadata@0.1.13/Reflect.js"></script>
<script src="https://unpkg.com/systemjs@0.21.3/dist/system.js"></script>
<script src="config.js"></script>
<script>
System.import("app").catch(console.error.bind(console));
</script>
</head>
<body class="dx-viewport">
<div class="demo-container">
<demo-app>Loading...</demo-app>
</div>
</body>
</html>