User interactions in EJ2 TypeScript Maps control
13 Jun 202424 minutes to read
Zooming, panning, single and double click, highlight and selection are all options that allow for effective interaction with Map elements.
Zooming
The zooming feature is used to zoom in and out of Maps to show in-depth information. It is controlled by the zoomFactor
property of the zoomSettings
of the Maps. The zoomFactor
is increased or decrease dynamically based on zoom in and out interaction.
Enable zooming
Zooming of Maps is enabled by setting the enable
property of zoomSettings
to true. To enable Zooming in Maps, the Zoom module must be injected into Maps using Maps.Inject(Zoom) method. The following code snippet demonstrates injecting the Zoom module into the Maps component.
import { Maps, Zoom } from '@syncfusion/ej2-maps';
Maps.Inject(Zoom);
let map: Maps = new Maps({ });
Enable panning
To enable the panning feature, set the enablePanning
property of zoomSettings
to true.
import { world_map } from './world-map.ts';
import { Maps, Zoom } from '@syncfusion/ej2-maps';
Maps.Inject(Zoom);
let map: Maps = new Maps({
layers: [{
shapeData: world_map,
}],
zoomSettings:{
enable:true,
enablePanning:true
}
});
map.appendTo('#element');
Various type of zooming
Zooming can be performed in following types:
Zooming toolbar
By default, the toolbar is rendered with zoom-in, zoom-out, and reset options when it is set to true in the enable
property of zoomSettings
.
The following options are available in toolbar.
- Zoom - Provides rectangular zoom support.
- ZoomIn - Zoom in the Maps.
- ZoomOut - Zoom out the Maps.
- Pan - Switches to panning if rectangular zoom is activated.
- Reset - Restores the Maps to the default view.
import { usmap } from 'usa.ts';
import { Maps, Zoom } from '@syncfusion/ej2-maps';
Maps.Inject(Zoom);
let map: Maps = new Maps({
zoomSettings: {
enable: true,
toolbarSettings: {
buttonSettings: {
toolbarItems: ['Zoom', 'ZoomIn', 'ZoomOut', 'Pan', 'Reset'],
}
}
},
layers: [{
shapeData: usmap,
}]
});
map.appendTo('#element');
Pinch zooming
To enable or disable the pinch zooming, use the pinchZooming
property in zoomSettings
.
import { usmap } from 'usa.ts';
import { Maps, Zoom } from '@syncfusion/ej2-maps';
Maps.Inject(Zoom);
let map: Maps = new Maps({
zoomSettings: {
enable: true,
pinchZooming: true
},
layers: [{
shapeData: usmap,
}]
});
map.appendTo('#element');
Single-click zooming
To enable or disable the single-click zooming, use the zoomOnClick
property in zoomSettings
.
import { usmap } from 'usa.ts';
import { Maps, Zoom } from '@syncfusion/ej2-maps';
Maps.Inject(Zoom);
let map: Maps = new Maps({
zoomSettings: {
enable: true,
zoomOnClick: true
},
layers: [{
shapeData: usmap,
}]
});
map.appendTo('#element');
Double-click zooming
To enable or disable the double-click zooming, use the doubleClickZoom
property in zoomSettings
.
import { usmap } from 'usa.ts';
import { Maps, Zoom } from '@syncfusion/ej2-maps';
Maps.Inject(Zoom);
let map: Maps = new Maps({
zoomSettings: {
enable: true,
doubleClickZoom: true
},
layers: [{
shapeData: usmap,
}]
});
map.appendTo('#element');
Mouse wheel zooming
To enable or disable mouse wheel zooming, use the mouseWheelZoom
property in zoomSettings
.
import { usmap } from 'usa.ts';
import { Maps, Zoom } from '@syncfusion/ej2-maps';
Maps.Inject(Zoom);
let map: Maps = new Maps({
zoomSettings: {
enable: true,
mouseWheelZoom: true
},
layers: [{
shapeData: usmap,
}]
});
map.appendTo('#element');
Selection zooming
To enable or disable selection zooming, use the enableSelectionZooming
property in zoomSettings
. The enablePanning
property must be set to false to enable the selection zooming in Maps.
import { usmap } from 'usa.ts';
import { Maps, Zoom } from '@syncfusion/ej2-maps';
Maps.Inject(Zoom);
let map: Maps = new Maps({
zoomSettings: {
enable: true,
enableSelectionZooming: true,
enablePanning: false
},
layers: [{
shapeData: usmap,
}]
});
map.appendTo('#element');
Minimum and maximum zooming
The zooming range can be adjusted using the minZoom
and maxZoom
properties in zoomSettings
. The minZoom value is set to 1 by default, and the maxZoom value is set to 10.
import { usmap } from 'usa.ts';
import { Maps, Zoom } from '@syncfusion/ej2-maps';
Maps.Inject(Zoom);
let map: Maps = new Maps({
zoomSettings: {
enable: true,
minZoom: 2,
maxZoom: 12
},
layers: [{
shapeData: usmap,
}]
});
map.appendTo('#element');
Zooming with animation
To zoom in or zoom out the Maps with animation, use the animationDuration
property in layers
.
import { usmap } from 'usa.ts';
import { Maps, Zoom } from '@syncfusion/ej2-maps';
Maps.Inject(Zoom);
let map: Maps = new Maps({
zoomSettings: {
enable: true,
},
layers: [{
shapeData: usmap,
animationDuration: 500
}]
});
map.appendTo('#element');
Customizing the zoom toolbar
The zoom toolbar can be customized by using the toolbarSettings option in the zoomSettings. The following properties can be used to customize the zoom toolbar.
- backgroundColor - It is used to customize the background color of the zoom toolbar.
- borderOpacity - It is used to customize the opacity of the border of the zoom toolbar.
- borderWidth - It is used to customize the thickness of the border of the zoom toolbar.
- borderColor - It is used to customize the color of the border of the zoom toolbar.
- horizontalAlignment - It is used to position the zoom toolbar in near, far, and center positions to customize its horizontal placement.
- verticalAlignment - It is used to position the zoom toolbar in near, far, and center positions to customize its vertical placement.
- orientation - It is used to change the orientation (horizontal/vertical) of the zoom toolbar.
import { world_map } from './world-map.ts';
import { Maps, Zoom } from '@syncfusion/ej2-maps';
Maps.Inject(Zoom);
let map: Maps = new Maps({
zoomSettings: {
enable: true,
toolbarSettings:{
orientation:'Vertical',
backgroundColor:'pink',
borderWidth:3,
borderColor:'green',
verticalAlignment:'Near',
buttonSettings: {
toolbarItems: ['Zoom', 'ZoomIn', 'ZoomOut', 'Pan', 'Reset']
}
}
},
layers: [
{
shapeData: world_map,
shapeSettings: {
fill: '#C1DFF5'
}
}
]
});
map.appendTo('#element');
<!DOCTYPE html>
<html lang="en">
<head>
<title>EJ2 Maps</title>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="description" content="Typescript UI Controls" />
<meta name="author" content="Syncfusion" />
<link href="index.css" rel="stylesheet" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/systemjs/0.19.38/system.js"></script>
<script src="world-map.js"></script>
<script src="markerdata.js"></script>
<script src="systemjs.config.js"></script>
<script src="https://cdn.syncfusion.com/ej2/syncfusion-helper.js" type ="text/javascript"></script>
</head>
<body>
<div id='loader'>Loading....</div>
<div id='container' style="height: 500px; width: 700px">
<div id='element'></div>
</div>
</body>
</html>
Customizing the buttons in the zoom toolbar
The appearance of the buttons in the zoom toolbar can be customized by using the buttonSettings option in the toolbarSettings of the zoomSettings property. The following properties can be used to customize the zoom toolbar buttons.
- fill - It is used to set the background color of the buttons.
- color - It is used to customize the color of the icons inside the button.
- borderOpacity - It is used to set the opacity of the border of the zoom toolbar buttons.
- borderWidth - It is used to set the thickness of the border of the zoom toolbar buttons.
- borderColor - It is used to set the color of the border of the zoom toolbar buttons.
- radius - It is used to set the size of the button.
- selectionColor - It is used to set the color of the icons inside the button when selection is performed.
- highlightColor - It is used to change the color of the button when the mouse is hovered over it.
- padding - It is used to change the padding space between each button.
- opacity - It is used to change the opacity of the button.
- toolbarItems - It is used to change the items that should be displayed in the zoom toolbar. By default, zoom-in, zoom-out, and reset buttons will be available. Other options include selection zoom and panning.
import { world_map } from './world-map.ts';
import { Maps, Zoom } from '@syncfusion/ej2-maps';
Maps.Inject(Zoom);
let map: Maps = new Maps({
zoomSettings: {
enable: true,
toolbarSettings:{
buttonSettings: {
fill:'pink',
padding: 10,
toolbarItems: ['Zoom', 'ZoomIn', 'ZoomOut', 'Pan', 'Reset'],
color: 'red',
borderColor:'green',
radius:35,
selectionColor:'#d55e5e',
hightlightColor:'#5ed59a',
opacity:0.6,
borderWidth: 2
}
}
},
layers: [
{
shapeData: world_map,
shapeSettings: {
fill: '#C1DFF5'
}
}
]
});
map.appendTo('#element');
<!DOCTYPE html>
<html lang="en">
<head>
<title>EJ2 Maps</title>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="description" content="Typescript UI Controls" />
<meta name="author" content="Syncfusion" />
<link href="index.css" rel="stylesheet" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/systemjs/0.19.38/system.js"></script>
<script src="world-map.js"></script>
<script src="markerdata.js"></script>
<script src="systemjs.config.js"></script>
<script src="https://cdn.syncfusion.com/ej2/syncfusion-helper.js" type ="text/javascript"></script>
</head>
<body>
<div id='loader'>Loading....</div>
<div id='container' style="height: 500px; width: 700px">
<div id='element'></div>
</div>
</body>
</html>
Customizing the tooltip of the zoom toolbar
The appearance of the tooltip of the zoom toolbar can be customized by using the tooltipSettings option in the toolbarSettings of the zoomSettings property. The following properties are available to customize the zoom toolbar tooltip.
- visible - Enables or disables the tooltip of the zoom toolbar.
- fill - It is used to change the background color of the tooltip of the zoom toolbar.
- borderOpacity - It is used to change the opacity of the border of the zoom toolbar’s tooltip.
- borderWidth - It is used to change the thickness of the border of the zoom toolbar’s tooltip.
- borderColor - It is used to change the color of the border of the zoom toolbar’s tooltip.
- fontColor - It is used to change the color of the text in the tooltip of the zoom toolbar.
- fontFamily - It is used to change the font family of the text in the tooltip of the zoom toolbar.
- fontStyle - It is used to change the font style of the text in the tooltip of the zoom toolbar.
- fontWeight - It is used to change the font weight of the text in the tooltip of the zoom toolbar.
- fontSize - It is used to change the size of the text in the tooltip of the zoom toolbar.
- fontOpacity - It is used to change the opacity of the text in the tooltip of the zoom toolbar.
import { world_map } from './world-map.ts';
import { Maps, Zoom } from '@syncfusion/ej2-maps';
Maps.Inject(Zoom);
let map: Maps = new Maps({
zoomSettings: {
enable: true,
toolbarSettings:{
tooltipSettings:{
visible:true,
borderWidth:2,
borderColor:'green',
fontColor:'black',
fill:'violet',
fontFamily:'Times New Roman',
fontWeight:200,
fontSize:'22px',
fontOpacity:1
},
buttonSettings: {
toolbarItems: ['Zoom', 'ZoomIn', 'ZoomOut', 'Pan', 'Reset']
}
}
},
layers: [
{
shapeData: world_map,
shapeSettings: {
fill: '#C1DFF5'
}
}
]
});
map.appendTo('#element');
<!DOCTYPE html>
<html lang="en">
<head>
<title>EJ2 Maps</title>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="description" content="Typescript UI Controls" />
<meta name="author" content="Syncfusion" />
<link href="index.css" rel="stylesheet" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/systemjs/0.19.38/system.js"></script>
<script src="world-map.js"></script>
<script src="markerdata.js"></script>
<script src="systemjs.config.js"></script>
<script src="https://cdn.syncfusion.com/ej2/syncfusion-helper.js" type ="text/javascript"></script>
</head>
<body>
<div id='loader'>Loading....</div>
<div id='container' style="height: 500px; width: 700px">
<div id='element'></div>
</div>
</body>
</html>
Selection
Each shape in the Maps can be selected and deselected during interaction with the shapes. Selection is enabled by setting the enable
property of selectionSettings
to true. To enable selection in Maps, the Selection module must be injected into the Maps using Maps.Inject(Selection) method.
import { Maps, Selection } from '@syncfusion/ej2-maps';
Maps.Inject(Selection);
let map: Maps = new Maps({ });
The following properties are available to customize the selection of Map elements such as shapes, bubbles, markers and legends.
-
border
- To customize the color, width and opacity of the border of which element is selected in Maps. -
fill
- Applies the color for the element that is selected. -
opacity
- To customize the transparency for the element that is selected. -
enableMultiSelect
- To enable or disable the selection for multiple shapes or markers or bubbles in the Maps.
By tapping on the specific legend, the shapes which are bounded to the selected legend is also selected and vice versa.
import { world_map } from './world-map.ts';
import { Maps, Selection, Legend } from '@syncfusion/ej2-maps';
Maps.Inject(Selection, Legend);
let map: Maps = new Maps({
layers: [
{
shapeData: world_map,
dataSource: [{ "Country": "China", "Membership": "Permanent"},
{"Country": "France","Membership": "Permanent" },
{ "Country": "Russia","Membership": "Permanent"},
{"Country": "Kazakhstan","Membership": "Non-Permanent"},
{ "Country": "Poland","Membership": "Non-Permanent"},
{"Country": "Sweden","Membership": "Non-Permanent"}],
shapePropertyPath: 'name',
shapeDataPath: 'Country',
selectionSettings: {
enable: true,
fill: 'blue',
border: { color: 'white', width: 2}
},
shapeSettings: {
colorValuePath: 'Membership',
colorMapping: [
{
value: 'Permanent', color: '#D84444'
},
{
value: 'Non-Permanent', color: '#316DB5'
}]
}
}
],
legendSettings: {
visible: true
}
});
map.appendTo('#element');
<!DOCTYPE html>
<html lang="en">
<head>
<title>EJ2 Maps</title>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="description" content="Typescript UI Controls" />
<meta name="author" content="Syncfusion" />
<link href="index.css" rel="stylesheet" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/systemjs/0.19.38/system.js"></script>
<script src="world-map.js"></script>
<script src="markerdata.js"></script>
<script src="systemjs.config.js"></script>
<script src="https://cdn.syncfusion.com/ej2/syncfusion-helper.js" type ="text/javascript"></script>
</head>
<body>
<div id='loader'>Loading....</div>
<div id='container' style="height: 500px; width: 700px">
<div id='element'></div>
</div>
</body>
</html>
Enable selection for bubbles
To enable the selection for bubbles in Maps, set the selectionSettings
in bubbleSettings
and set the enable
property of selectionSettings
as true.
Note: To use the bubble feature, the Bubble module must be injected.
import { world_map } from './world-map.ts';
import { Maps, Bubble, Selection } from '@syncfusion/ej2-maps';
Maps.Inject(Selection, Bubble);
let map: Maps = new Maps({
layers: [{
shapeData: world_map,
shapeDataPath: 'name',
shapePropertyPath: 'name',
bubbleSettings: [{
visible: true,
dataSource: [
{ name: 'India', population: '38332521' },
{ name: 'South Africa', population: '19651127' },
{ name: 'Pakistan', population: '3090416' }
],
selectionSettings: {
enable: true,
fill: 'green',
border: { color: 'white', width: 2}
},
valuePath: 'population'
}]
}]
});
map.appendTo('#element');
<!DOCTYPE html>
<html lang="en">
<head>
<title>EJ2 Maps</title>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="description" content="Typescript UI Controls" />
<meta name="author" content="Syncfusion" />
<link href="index.css" rel="stylesheet" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/systemjs/0.19.38/system.js"></script>
<script src="world-map.js"></script>
<script src="markerdata.js"></script>
<script src="systemjs.config.js"></script>
<script src="https://cdn.syncfusion.com/ej2/syncfusion-helper.js" type ="text/javascript"></script>
</head>
<body>
<div id='loader'>Loading....</div>
<div id='container' style="height: 500px; width: 700px">
<div id='element'></div>
</div>
</body>
</html>
Enable selection for markers
To enable the selection for markers in Maps, set the selectionSettings
in the markerSettings
and set the enable
property of the selectionSettings
as true.
To use the marker feature, the Marker module must be injected.
import { world_map } from './world-map.ts';
import { Maps, Marker, Selection } from '@syncfusion/ej2-maps';
Maps.Inject(Selection, Marker);
let map: Maps = new Maps({
layers: [{
shapeData: world_map,
markerSettings: [{
visible: true,
height: 20,
width: 20,
fill: 'green',
shape:'Balloon',
selectionSettings: {
enable: true,
fill: 'blue',
border: { color: 'white', width: 2}
},
dataSource: [
{ latitude: 49.95121990866204, longitude: 18.468749999999998, name:'Europe' },
{ latitude: 59.88893689676585, longitude: -109.3359375, name:'North America'},
{ latitude: -6.64607562172573, longitude: -55.54687499999999, name:'South America'}
]
}],
}]
});
map.appendTo('#element');
<!DOCTYPE html>
<html lang="en">
<head>
<title>EJ2 Maps</title>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="description" content="Typescript UI Controls" />
<meta name="author" content="Syncfusion" />
<link href="index.css" rel="stylesheet" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/systemjs/0.19.38/system.js"></script>
<script src="world-map.js"></script>
<script src="markerdata.js"></script>
<script src="systemjs.config.js"></script>
<script src="https://cdn.syncfusion.com/ej2/syncfusion-helper.js" type ="text/javascript"></script>
</head>
<body>
<div id='loader'>Loading....</div>
<div id='container' style="height: 500px; width: 700px">
<div id='element'></div>
</div>
</body>
</html>
Enable selection for polygons
When the enable property of selectionSettings is set to true, the polygon shapes can be selected via user interaction. The following properties are available in selectionSettings
to customize the polygon shape when it is selected.
- enableMultiSelect - It is used to enable multiple selection of polygon shapes.
- fill - It is used to change the color of the selected polygon shape.
- opacity - It is used to change the opacity of the selected polygon shape.
- border - This property is used to change the color, width, and opacity of the border of the selected polygon shape.
To use the polygon feature, the Polygon module must be injected, as described in this link.
The following example shows how to select the polygon shape in the geometry map.
import { Maps, Polygon, Selection, Highlight } from '@syncfusion/ej2-maps';
import { world_map } from './world-map.ts';
Maps.Inject(Polygon, Selection, Highlight);
let map: Maps = new Maps({
layers: [
{
shapeData: world_map,
polygonSettings: {
polygons: [
{
points: [
{ longitude: -1.8920678947185365, latitude: 35.06195799239681 },
{ longitude: -1.6479633699113947, latitude: 33.58989612266137 },
{ longitude: -1.4201220366858252, latitude: 32.819439646045254 },
{ longitude: -1.197974596225663, latitude: 32.26940895444655 },
{ longitude: -2.891112397949655, latitude: 32.10303058820031 },
{ longitude: -3.8246984550501963, latitude: 31.34551662687602 },
{ longitude: -3.720166273688733, latitude: 30.758086682848685 },
{ longitude: -5.6571886081189575, latitude: 29.613582597203006 },
{ longitude: -7.423353242214745, latitude: 29.44328441403087 },
{ longitude: -8.6048931685323, latitude: 28.761444633616776 },
{ longitude: -8.695726975465703, latitude: 27.353491085576195 },
{ longitude: 3.837867279970908, latitude: 19.15916564839422 },
{ longitude: 6.0705408799045415, latitude: 19.48749097192868 },
{ longitude: 12.055736352807713, latitude: 23.694596786078293 },
{ longitude: 11.272522332402986, latitude: 24.289329186946034 },
{ longitude: 10.30872578261932, latitude: 24.65419958524693 },
{ longitude: 9.910236690050027, latitude: 25.48943950947175 },
{ longitude: 9.432639882414293, latitude: 26.398372489836902 },
{ longitude: 9.898266456582292, latitude: 26.73489453809293 },
{ longitude: 9.560243026853641, latitude: 30.31040379467153 },
{ longitude: 8.943853847283322, latitude: 32.350324876652195 },
{ longitude: 7.57004059025715, latitude: 33.75071049019398 },
{ longitude: 8.0906322609153, latitude: 34.69043151009983 },
{ longitude: 8.363285449347273, latitude: 35.38654406371319 },
{ longitude: 8.26139549449448, latitude: 36.44751078733985 },
{ longitude: 8.61100824823302, latitude: 36.881913362940196 },
{ longitude: 7.4216488925819135, latitude: 37.021408008916254 },
{ longitude: 6.461182254165351, latitude: 36.99092409199429 },
{ longitude: 5.297178918070159, latitude: 36.69985479014656 },
{ longitude: 3.6718056161224695, latitude: 36.86470546831693 },
{ longitude: 1.2050052555659931, latitude: 36.57658056301722 },
{ longitude: -0.26968570003779746, latitude: 35.806903541813625 },
{ longitude: -0.995191786435754, latitude: 35.58466127904214 },
{ longitude: -1.8920678947185365, latitude: 35.06195799239681 }
],
fill: 'blue',
opacity: 0.7,
borderColor: 'green',
borderWidth: 2,
borderOpacity: 0.7
}
],
highlightSettings: {
enable: true,
fill: 'blue',
opacity: 0.7,
border: {
color: 'green',
width: 2,
opacity: 0.7
}
},
selectionSettings: {
enable: true,
fill: 'violet',
enableMultiSelect: false,
opacity: 0.8,
border: {
color: 'cyan',
opacity: 1,
width: 7
}
}
}
}
]
});
map.appendTo('#element');
<!DOCTYPE html>
<html lang="en">
<head>
<title>EJ2 Maps</title>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="description" content="Typescript UI Controls" />
<meta name="author" content="Syncfusion" />
<link href="index.css" rel="stylesheet" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/systemjs/0.19.38/system.js"></script>
<script src="world-map.js"></script>
<script src="systemjs.config.js"></script>
<script src="https://cdn.syncfusion.com/ej2/syncfusion-helper.js" type ="text/javascript"></script>
</head>
<body>
<div id='loader'>Loading....</div>
<div id='container' style="height: 500px; width: 700px">
<div id='element'></div>
</div>
</body>
</html>
Public method for the shape selection
The shapeSelection
method can be used to select each shape in the Maps. LayerIndex, propertyName, country name, and selected value as a boolean state(true / false) are the input parameters for this method.
import { world_map } from '../default-map-cs1/world-map.ts';
import { Maps, Selection } from '@syncfusion/ej2-maps';
Maps.Inject(Selection);
let map: Maps = new Maps({
layers: [{
shapeData: world_map,
selectionSettings: {
enable: true,
fill: 'green',
border: { color: 'white', width: 2}
}
}]
});
map.appendTo('#element');
document.getElementById('selection').onclick = () => {
map.shapeSelection(0, "continent", "Asia", true);
};
document.getElementById('unselection').onclick = () => {
map.shapeSelection(0, "continent", "Asia", false);
};
<!DOCTYPE html>
<html lang="en">
<head>
<title>EJ2 Maps</title>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="description" content="Typescript UI Controls" />
<meta name="author" content="Syncfusion" />
<link href="index.css" rel="stylesheet" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/systemjs/0.19.38/system.js"></script>
<script src="systemjs.config.js"></script>
<script src="usa.js"></script>
<script src="https://cdn.syncfusion.com/ej2/syncfusion-helper.js" type ="text/javascript"></script>
</head>
<body>
<div id='loader'>Loading....</div>
<div id='container' style="margin-top: 125px">
<div id='element'></div>
<button id= "selection" type="button" width ='15%'>Select</button>
<button id= "unselection" type="button" width ='15%'>UnSelect</button>
</div>
</body>
</html>
Initial shape selection
The shape is initially selected using the initialShapeSelection
property, and the values are mapped to the shapePath
and shapeValue
.
initialShapeSelection is an Array property.
import { world_map } from './world-map.ts';
import { Maps, Selection } from '@syncfusion/ej2-maps';
Maps.Inject(Selection);
let map: Maps = new Maps({
layers: [{
shapeData: world_map,
initialShapeSelection: [
{ shapePath: 'continent', shapeValue: 'Africa' },
{ shapePath: 'name', shapeValue: 'India' }
],
selectionSettings: {
enable: true,
fill: 'green',
border: { color: 'white', width: 2}
}
}]
});
map.appendTo('#element');
<!DOCTYPE html>
<html lang="en">
<head>
<title>EJ2 Maps</title>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="description" content="Typescript UI Controls" />
<meta name="author" content="Syncfusion" />
<link href="index.css" rel="stylesheet" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/systemjs/0.19.38/system.js"></script>
<script src="world-map.js"></script>
<script src="markerdata.js"></script>
<script src="systemjs.config.js"></script>
<script src="https://cdn.syncfusion.com/ej2/syncfusion-helper.js" type ="text/javascript"></script>
</head>
<body>
<div id='loader'>Loading....</div>
<div id='container' style="height: 500px; width: 700px">
<div id='element'></div>
</div>
</body>
</html>
Initial marker selection
Using the initialMarkerSelection
property, the marker shape can be selected initially. Markers render based on the latitude
and longitude
values.
initialMarkerSelection is an Array property.
import { world_map } from './world-map.ts';
import { Maps, Marker, Selection } from '@syncfusion/ej2-maps';
Maps.Inject(Selection, Marker);
let map: Maps = new Maps({
layers: [{
shapeData: world_map,
markerSettings: [{
visible: true,
height: 20,
width: 20,
fill: 'green',
shape:'Balloon',
initialMarkerSelection: [{
latitude: -6.64607562172573, longitude: -55.54687499999999
}],
selectionSettings: {
enable: true,
fill: 'blue',
opacity: 1,
border: { color: 'white', width: 2, opacity: 1 }
},
dataSource: [
{ latitude: 49.95121990866204, longitude: 18.468749999999998, name:'Europe' },
{ latitude: 59.88893689676585, longitude: -109.3359375, name:'North America'},
{ latitude: -6.64607562172573, longitude: -55.54687499999999, name:'South America'}
]
}],
}]
});
map.appendTo('#element');
<!DOCTYPE html>
<html lang="en">
<head>
<title>EJ2 Maps</title>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="description" content="Typescript UI Controls" />
<meta name="author" content="Syncfusion" />
<link href="index.css" rel="stylesheet" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/systemjs/0.19.38/system.js"></script>
<script src="world-map.js"></script>
<script src="markerdata.js"></script>
<script src="systemjs.config.js"></script>
<script src="https://cdn.syncfusion.com/ej2/syncfusion-helper.js" type ="text/javascript"></script>
</head>
<body>
<div id='loader'>Loading....</div>
<div id='container' style="height: 500px; width: 700px">
<div id='element'></div>
</div>
</body>
</html>
Highlight
Each shape in the Map can be highlighted during mouse hover on the Map elements such as shapes, bubbles, markers and legends. Highlight is enabled by setting the enable
property of highlightSettings
to true. To enable highlight in Maps, the Highlight module must be injected into Maps using Maps.Inject(Highlight) method.
import { Maps, Highlight } from '@syncfusion/ej2-maps';
Maps.Inject(Highlight);
let map: Maps = new Maps({ });
The following properties are available to customize the highlight of Map elements such as shapes, bubbles, markers and legends.
-
border
- To customize the color, width and opacity of the border of which element is highlighted in Maps. -
fill
- Applies the color for the element that is highlighted. -
opacity
- To customize the transparency for the element that is highlighted.
Hovering on the specific legend, the shapes which are bounded to the selected legend is also highlighted and vice versa.
import { world_map } from './world-map.ts';
import { Maps, Highlight, Legend } from '@syncfusion/ej2-maps';
Maps.Inject(Highlight, Legend);
let map: Maps = new Maps({
layers: [
{
shapeData: world_map,
dataSource: [
{ "Country": "China", "Membership": "Permanent"},
{ "Country": "France", "Membership": "Permanent" },
{ "Country": "Russia", "Membership": "Permanent"},
{ "Country": "Kazakhstan", "Membership": "Non-Permanent"},
{ "Country": "Poland", "Membership": "Non-Permanent"},
{ "Country": "Sweden", "Membership": "Non-Permanent"}
],
shapePropertyPath: 'name',
shapeDataPath: 'Country',
highlightSettings: {
enable: true,
fill: 'blue',
border: { color: 'white', width: 2}
},
shapeSettings: {
colorValuePath: 'Membership',
colorMapping: [
{
value: 'Permanent', color: '#D84444'
},
{
value: 'Non-Permanent', color: '#316DB5'
}]
}
}
],
legendSettings: {
visible: true
}
});
map.appendTo('#element');
<!DOCTYPE html>
<html lang="en">
<head>
<title>EJ2 Maps</title>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="description" content="Typescript UI Controls" />
<meta name="author" content="Syncfusion" />
<link href="index.css" rel="stylesheet" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/systemjs/0.19.38/system.js"></script>
<script src="world-map.js"></script>
<script src="markerdata.js"></script>
<script src="systemjs.config.js"></script>
<script src="https://cdn.syncfusion.com/ej2/syncfusion-helper.js" type ="text/javascript"></script>
</head>
<body>
<div id='loader'>Loading....</div>
<div id='container' style="height: 500px; width: 700px">
<div id='element'></div>
</div>
</body>
</html>
Enable highlight for bubbles
To enable the highlight for bubbles in Maps, set the highlightSettings
in bubbleSettings
and set the enable
property of highlightSettings
as true.
To use the bubble feature, the Bubble module must be injected.
import { world_map } from './world-map.ts';
import { Maps, Bubble, Highlight } from '@syncfusion/ej2-maps';
Maps.Inject(Highlight, Bubble);
let map: Maps = new Maps({
layers: [{
shapeData: world_map,
shapeDataPath: 'name',
shapePropertyPath: 'name',
bubbleSettings: [{
visible: true,
dataSource: [
{ name: 'India', population: '38332521' },
{ name: 'South Africa', population: '19651127' },
{ name: 'Pakistan', population: '3090416' }
],
highlightSettings: {
enable: true,
fill: 'green',
border: { color: 'white', width: 2}
},
valuePath: 'population'
}]
}]
});
map.appendTo('#element');
<!DOCTYPE html>
<html lang="en">
<head>
<title>EJ2 Maps</title>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="description" content="Typescript UI Controls" />
<meta name="author" content="Syncfusion" />
<link href="index.css" rel="stylesheet" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/systemjs/0.19.38/system.js"></script>
<script src="world-map.js"></script>
<script src="markerdata.js"></script>
<script src="systemjs.config.js"></script>
<script src="https://cdn.syncfusion.com/ej2/syncfusion-helper.js" type ="text/javascript"></script>
</head>
<body>
<div id='loader'>Loading....</div>
<div id='container' style="height: 500px; width: 700px">
<div id='element'></div>
</div>
</body>
</html>
Enable highlight for markers
To enable the highlight for markers in Maps, set the highlightSettings
in markerSettings
and set the enable
property of highlightSettings
as true.
To use the marker feature, the Marker module must be injected.
import { world_map } from './world-map.ts';
import { Maps, Marker, Highlight } from '@syncfusion/ej2-maps';
Maps.Inject(Highlight, Marker);
let map: Maps = new Maps({
layers: [{
shapeData: world_map,
markerSettings: [{
visible: true,
height: 20,
width: 20,
fill: 'green',
shape:'Balloon',
highlightSettings: {
enable: true,
fill: 'blue',
border: { color: 'white', width: 2}
},
dataSource: [
{ latitude: 49.95121990866204, longitude: 18.468749999999998, name:'Europe' },
{ latitude: 59.88893689676585, longitude: -109.3359375, name:'North America'},
{ latitude: -6.64607562172573, longitude: -55.54687499999999, name:'South America'}
]
}],
}]
});
map.appendTo('#element');
<!DOCTYPE html>
<html lang="en">
<head>
<title>EJ2 Maps</title>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="description" content="Typescript UI Controls" />
<meta name="author" content="Syncfusion" />
<link href="index.css" rel="stylesheet" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/systemjs/0.19.38/system.js"></script>
<script src="world-map.js"></script>
<script src="markerdata.js"></script>
<script src="systemjs.config.js"></script>
<script src="https://cdn.syncfusion.com/ej2/syncfusion-helper.js" type ="text/javascript"></script>
</head>
<body>
<div id='loader'>Loading....</div>
<div id='container' style="height: 500px; width: 700px">
<div id='element'></div>
</div>
</body>
</html>
Enable highlight for polygons
The polygon shapes can be highlighted via user interaction if the enable property of highlightSettings is set to true. The following properties are available in highlightSettings
to customize the polygon shape when it is highlighted.
- fill - It is used to change the color of the highlighted polygon shape.
- opacity - It is used to change the opacity of the highlighted polygon shape.
- border - This property is used to change the color, width, and opacity of the border of the highlighted polygon shape.
To use the polygon feature, the Polygon module must be injected, as described in this link.
The following example shows how to highlight a polygon shape on a geometry map.
import { Maps, Polygon, Selection, Highlight } from '@syncfusion/ej2-maps';
import { world_map } from './world-map.ts';
Maps.Inject(Polygon, Selection, Highlight);
let map: Maps = new Maps({
layers: [
{
shapeData: world_map,
polygonSettings: {
polygons: [
{
points: [
{ longitude: -1.8920678947185365, latitude: 35.06195799239681 },
{ longitude: -1.6479633699113947, latitude: 33.58989612266137 },
{ longitude: -1.4201220366858252, latitude: 32.819439646045254 },
{ longitude: -1.197974596225663, latitude: 32.26940895444655 },
{ longitude: -2.891112397949655, latitude: 32.10303058820031 },
{ longitude: -3.8246984550501963, latitude: 31.34551662687602 },
{ longitude: -3.720166273688733, latitude: 30.758086682848685 },
{ longitude: -5.6571886081189575, latitude: 29.613582597203006 },
{ longitude: -7.423353242214745, latitude: 29.44328441403087 },
{ longitude: -8.6048931685323, latitude: 28.761444633616776 },
{ longitude: -8.695726975465703, latitude: 27.353491085576195 },
{ longitude: 3.837867279970908, latitude: 19.15916564839422 },
{ longitude: 6.0705408799045415, latitude: 19.48749097192868 },
{ longitude: 12.055736352807713, latitude: 23.694596786078293 },
{ longitude: 11.272522332402986, latitude: 24.289329186946034 },
{ longitude: 10.30872578261932, latitude: 24.65419958524693 },
{ longitude: 9.910236690050027, latitude: 25.48943950947175 },
{ longitude: 9.432639882414293, latitude: 26.398372489836902 },
{ longitude: 9.898266456582292, latitude: 26.73489453809293 },
{ longitude: 9.560243026853641, latitude: 30.31040379467153 },
{ longitude: 8.943853847283322, latitude: 32.350324876652195 },
{ longitude: 7.57004059025715, latitude: 33.75071049019398 },
{ longitude: 8.0906322609153, latitude: 34.69043151009983 },
{ longitude: 8.363285449347273, latitude: 35.38654406371319 },
{ longitude: 8.26139549449448, latitude: 36.44751078733985 },
{ longitude: 8.61100824823302, latitude: 36.881913362940196 },
{ longitude: 7.4216488925819135, latitude: 37.021408008916254 },
{ longitude: 6.461182254165351, latitude: 36.99092409199429 },
{ longitude: 5.297178918070159, latitude: 36.69985479014656 },
{ longitude: 3.6718056161224695, latitude: 36.86470546831693 },
{ longitude: 1.2050052555659931, latitude: 36.57658056301722 },
{ longitude: -0.26968570003779746, latitude: 35.806903541813625 },
{ longitude: -0.995191786435754, latitude: 35.58466127904214 },
{ longitude: -1.8920678947185365, latitude: 35.06195799239681 }
],
fill: 'red',
opacity: 0.7,
borderColor: 'green',
borderWidth: 2,
borderOpacity: 0.7
}
],
highlightSettings: {
enable: true,
fill: 'yellow',
opacity: 0.4,
border: {
color: 'blue',
opacity: 0.6,
width: 4
}
},
selectionSettings: {
enable: true,
fill: 'red',
opacity: 0.7,
border: {
color: 'green',
width: 2,
opacity: 0.7
}
}
}
}
]
});
map.appendTo('#element');
<!DOCTYPE html>
<html lang="en">
<head>
<title>EJ2 Maps</title>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="description" content="Typescript UI Controls" />
<meta name="author" content="Syncfusion" />
<link href="index.css" rel="stylesheet" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/systemjs/0.19.38/system.js"></script>
<script src="world-map.js"></script>
<script src="systemjs.config.js"></script>
<script src="https://cdn.syncfusion.com/ej2/syncfusion-helper.js" type ="text/javascript"></script>
</head>
<body>
<div id='loader'>Loading....</div>
<div id='container' style="height: 500px; width: 700px">
<div id='element'></div>
</div>
</body>
</html>
Tooltip
On mouse over or touch end event, the tooltip is used to get more information about the layer, bubble, or marker. To enable tooltip in Maps, the Tooltip module must be injected into Maps using Maps.Inject(Tooltip) method. It can be enabled separately for layer or bubble or marker by using the visible
property of tooltipSettings
as true. The valuePath
property in the tooltip takes the field name that presents in dataSource and displays that value as tooltip text. The tooltipDisplayMode
property is used to change the display mode of the tooltip in Maps. Following display modes of tooltip are available in the Maps component. By default, tooltipDisplayMode
is set to MouseMove.
- MouseMove
- Click
- DoubleClick
import { world_map } from './world-map.ts';
import { Maps, MapsTooltip } from '@syncfusion/ej2-maps';
Maps.Inject(MapsTooltip);
let map: Maps = new Maps({
layers: [{
shapeData: world_map,
tooltipSettings: {
visible: true,
valuePath: 'name'
}
}]
});
map.appendTo('#element');
<!DOCTYPE html>
<html lang="en">
<head>
<title>EJ2 Maps</title>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="description" content="Typescript UI Controls" />
<meta name="author" content="Syncfusion" />
<link href="index.css" rel="stylesheet" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/systemjs/0.19.38/system.js"></script>
<script src="world-map.js"></script>
<script src="markerdata.js"></script>
<script src="systemjs.config.js"></script>
<script src="https://cdn.syncfusion.com/ej2/syncfusion-helper.js" type ="text/javascript"></script>
</head>
<body>
<div id='loader'>Loading....</div>
<div id='container' style="height: 500px; width: 700px">
<div id='element'></div>
</div>
</body>
</html>
Customization
The following properties are available in the tooltipSettings
to customize the tooltip of the Maps component.
-
border
- To customize the color, width and opacity of the border of the tooltip in layers, markers, and bubbles of Maps. -
fill
- Applies the color of the tooltip in layers, markers, and bubbles of Maps. -
format
- To customize the format of the tooltip in layers, markers, and bubbles of Maps -
textStyle
- To customize the style of the text in the tooltip for layers, markers, and bubbles of Maps.
import { world_map } from './world-map.ts';
import { Maps, MapsTooltip, ITooltipRenderEventArgs } from '@syncfusion/ej2-maps';
Maps.Inject(MapsTooltip);
let map: Maps = new Maps({
tooltipRender: (args: ITooltipRenderEventArgs) => {
if (!args.options['data']) {
args.cancel = true;
}
},
layers: [{
shapeData: world_map,
shapePropertyPath: 'name',
shapeDataPath: 'name',
shapeSettings: {
fill: '#E5E5E5',
colorMapping: [
{ color: '#b3daff', value: '1' },
{ color: '#80c1ff', value: '2' },
{ color: '#1a90ff', value: '3' },
{ color: '#005cb3', value: '7' }
],
colorValuePath: 'value1'
},
dataSource: [
{ "name": "India", "value1": "3", "value1": "2", "country": "India" },
{ "name": "Dominican Rep.", "value1": "3", "value2": "2", "country": "West Indies" },
{ "name": "Cuba", "value1": "3", "value2": "2", "country": "West Indies" },
{ "name": "Jamaica", "value1": "3", "value2": "2", "country": "West Indies" },
{ "name": "Haiti", "value1": "3", "value2": "2", "country": "West Indies" },
{ "name": "Guyana", "value1": "3", "value2": "2", "country": "West Indies" },
{ "name": "Suriname", "value1": "3", "value2": "2", "country": "West Indies"},
{ "name": "Trinidad and Tobago", "value1": "3", "value2": "2", "country": "West Indies" },
{ "name": "Sri Lanka", "value1": "3", "value2": "1", "country": "Sri Lanka" },
{ "name": "United Kingdom", "value1": "3", "value2": "0", "country": "England" },
{ "name": "Pakistan", "value1": "2", "value2": "1", "country": "Pakistan" },
{ "name": "New Zealand", "value1": "1", "value2": "0", "country": "New Zealand" },
{ "name": "Australia", "value1": "7", "value2": "5", "country": "Australia" }
],
tooltipSettings: {
visible: true,
valuePath: 'name',
format: '${name}: ${value1}',
fill: '#D0D0D0',
textStyle: {
color: 'green',
fontFamily: 'Times New Roman',
fontStyle: 'Sans-serif'
}
}
}]
});
map.appendTo('#element');
<!DOCTYPE html>
<html lang="en">
<head>
<title>EJ2 Maps</title>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="description" content="Typescript UI Controls" />
<meta name="author" content="Syncfusion" />
<link href="index.css" rel="stylesheet" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/systemjs/0.19.38/system.js"></script>
<script src="world-map.js"></script>
<script src="markerdata.js"></script>
<script src="systemjs.config.js"></script>
<script src="https://cdn.syncfusion.com/ej2/syncfusion-helper.js" type ="text/javascript"></script>
</head>
<body>
<div id='loader'>Loading....</div>
<div id='container' style="height: 500px; width: 700px">
<div id='element'></div>
</div>
</body>
</html>
Tooltip template
The HTML element can be rendered in the tooltip of the Maps using the template
property of the tooltipSettings
. In the following example, ${value1} and ${value2} are the place holders in the HTML element to display the value1 and value2 values of the corresponding shape.
import { Maps, MapsTooltip, Legend, ITooltipRenderEventArgs, ILoadEventArgs, MapsTheme, MapAjax } from '@syncfusion/ej2-maps';
import { world_map } from './world-map.ts';
import { tooltipData } from './tooltip-datasource.ts';
Maps.Inject(MapsTooltip, Legend);
let maps: Maps = new Maps({
tooltipRender: (args: ITooltipRenderEventArgs) => {
if (!args.options['data']) {
args.cancel = true;
}
},
legendSettings: {
visible: true,
mode: 'Interactive',
position: 'Left',
orientation: 'Vertical',
height: '70%',
width: '10'
},
layers: [{
shapeData: world_map,
shapePropertyPath: 'name',
shapeDataPath: 'name',
dataSource: tooltipData,
tooltipSettings: {
visible: true,
valuePath: 'name',
template: '#template'
},
shapeSettings: {
fill: '#E5E5E5',
colorMapping: [
{ color: '#b3daff', value: '1' },
{ color: '#80c1ff', value: '2' },
{ color: '#1a90ff', value: '3' },
{ color: '#005cb3', value: '7' }
],
colorValuePath: 'value1'
}
}]
});
maps.appendTo('#container');
<!DOCTYPE html>
<html lang="en">
<head>
<title>EJ2 Maps</title>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="description" content="Typescript UI Controls" />
<meta name="author" content="Syncfusion" />
<link href="index.css" rel="stylesheet" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/systemjs/0.19.38/system.js"></script>
<script src="systemjs.config.js"></script>
<script src="world-map.js"></script>
<script src="https://cdn.syncfusion.com/ej2/syncfusion-helper.js" type ="text/javascript"></script>
</head>
<body>
<div id='loader'>Loading....</div>
<div id='container' style="margin-top: 125px">
<div id='element'></div>
</div>
<div id="template" style="display:none">
<div class="toolback">
<div class="listing2">
<center>
${country}
</center>
</div>
<hr style="margin-top: 2px;margin-bottom:5px;border:0.5px solid #DDDDDD">
<div>
<span class="listing1">Finalist : </span><span class="listing2">${value1}</span>
</div>
<div>
<span class="listing1">Win : </span><span class="listing2">${value2}</span>
</div>
</div>
</div>
</body>
<style>
.toolback {
border-radius: 4px;
border: 1px #abb9c6;
opacity: 90%;
background: rgba(53, 63, 76, 0.90);
box-shadow: 0px 2px 2px rgba(0, 0, 0, 0.40);
padding-bottom: 5px;
padding-top: 10px;
padding-left: 10px;
padding-right: 10px;
width: 90px;
}
.listing1 {
font-size:13px;
color:#cccccc
}
.listing2 {
font-size:13px;
color:#ffffff;
font-weight: 500;
}
</style>
</html>
Changing duration in mobile devices
To change the duration of the tooltips and tooltip templates in mobile devices, you can use the duration
property in tooltipSettings. By default, this property is set to 2000 milliseconds. Setting the value to 0 will keep the tooltip visible indefinitely. If it is greater than 0, the tooltip will be removed after the specified time.
import { world_map } from './world-map.ts';
import { Maps, MapsTooltip, ITooltipRenderEventArgs } from '@syncfusion/ej2-maps';
Maps.Inject(MapsTooltip);
let map: Maps = new Maps({
layers: [{
shapeData: world_map,
tooltipSettings: {
visible: true,
valuePath: 'name',
fill: '#D0D0D0',
textStyle: {
color: 'green',
fontFamily: 'Times New Roman',
fontStyle: 'Sans-serif'
},
duration: 3000
}
}]
});
map.appendTo('#element');
<!DOCTYPE html>
<html lang="en">
<head>
<title>EJ2 Maps</title>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="description" content="Typescript UI Controls" />
<meta name="author" content="Syncfusion" />
<link href="index.css" rel="stylesheet" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/systemjs/0.19.38/system.js"></script>
<script src="world-map.js"></script>
<script src="systemjs.config.js"></script>
<script src="https://cdn.syncfusion.com/ej2/syncfusion-helper.js" type ="text/javascript"></script>
</head>
<body>
<div id='loader'>Loading....</div>
<div id='container' style="height: 500px; width: 700px">
<div id='element'></div>
</div>
</body>
</html>