testingthepackage v1.0.0
Jsvectormap
First of all I'd like to thank jvectormap since jsvectormap core is based on their own but of course with lots of diffrent changes have been done. jQuery removed and the project now is pure Javascript!
IE 8 has been dropped. The VML is no longer supported.
Installation
Installing with npm is recommended.
npm i jsvectormap
Download
You can download the latest version from the Github: Download
Quick start
<link rel="stylesheet" href="dist/css/jsvectormap.min.css" />
<script src="dist/js/jsvectormap.min.js"></script>
<script src="dist/maps/world.js"></script>
<script>
var map = new JsVectorMap({
selector: '#map', // Or Element example: document.querySelector('#map')
map: 'world'
});
</script>
If you're using webpack or something like that you'll need to import the map you want to work with after importing the library.
@import 'jsvectormap'
@import 'jsvectormap/dist/maps/world.js'
var map = new JsVectorMap({
selector: '#map',
map: 'world',
})
Sass
@import 'jsvectormap'
@import '../../node_modules/jsvectormap/dist/css/jsvectormap.min.css'
Options
map 'world'
mapBgColor 'transparent'
The map's container background color
draggable 'true'
Change the map scale when dragging
zoomButtons 'true'
Show zoom buttons
zoomOnScroll 'true'
Zoom the map when scolling.
zoomOnScrollSpeed '3'
The scroll speed when scrolling
zoomMax '12'
Maximum map zoom
zoomMin '1'
Minimum map zoom
zoomAnimate 'true'
Animate when zomming the map
showTooltip 'true'
Show tooltip
Markers options
markersSelectable 'false'
The marker is selectable
markerStyle 'object'
Let's see an example instead, since the options is so clear.
markerStyle: {
initial: {
r: 8, // Marker width
fill: 'black', // Marker color
fillOpacity: 1, // The opacity of the marker shape
stroke: '#FFF', // Stroke
strokeWidth: 6, // the stroke width
strokeOpacity: .65, // The stroke opacity
},
// All options in initial object can be overitten in hover, selected, selectedHover object as well.
hover: {
stroke: 'black',
cursor: 'pointer',
strokeWidth: 2,
},
selected: {
fill: 'blue'
},
selectedHover: {
fill: 'red'
}
},
regionStyle 'object'
The same as markerStyle there's no diffrence.
Don't forget to see samples folder it has important tips.
Events
Name | Description | Params |
---|---|---|
onViewportChange | Triggered when map viewport was changed | scale - transX - transY |
onRegionSelected | Triggered when a region was selected | index, isSelected, selectedRegions |
onMarkerSelected | Triggered when a marker was selected | code, isSelected, selectedMarkers |
onRegionTooltipShow | Triggered when region tooltip was shown | tooltip, code |
onMarkerTooltipShow | Triggered when marker tooltip was shown | tooltip, code |
License
jsvectormap licensed under MIT.
5 years ago