svgmap 1.3.4 → 1.5.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 Stephan Wagner
+Copyright (c) 2020 Stephan Wagner
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -6,7 +6,7 @@ Live demo: https://stephanwagner.me/create-world-map-charts-with-svgmap#svgMapDe
 
 ## Install
 
-```
+```bash
 npm install svgmap
 ```
 
@@ -55,9 +55,9 @@ You can pass the following options into svgMap:
 
 * `targetElementID` (`string`) The ID of the element where the world map will render (Required)
 
-* `minZoom`, `maxZoom` (`float`) Minimal and maximal zoom level between 1 and 10. Default: `1` for `minZoom`, `10` for `maxZoom`
+* `minZoom`, `maxZoom` (`float`) Minimal and maximal zoom level. Default: `1` for `minZoom`, `25` for `maxZoom`
 
-* `initialZoom` (`float`) Initial zoom level between 1 and 10. Default: `1.06`
+* `initialZoom` (`float`) Initial zoom level. Default: `1.06`
 
 * `zoomScaleSensitivity` (`float`) Sensitivity when zooming. Default: `0.2`
 
@@ -73,7 +73,11 @@ You can pass the following options into svgMap:
 
 * `noDataText` (`string`) The default text to be shown when no data is present
 
-* `data` (`object`) The chart data to use for coloring and to show in the tooltip. Use a unique data-id as key and provide
+* `countries` (`object`) Additional options specific to countries:
+
+  * `EH` (`boolean`) When set to `false`, Western Sahara (EH) will be combined with Morocco (MA)
+
+* `data` (`object`) The chart data to use for coloring and to show in the tooltip. Use a unique data-id as key and provide following options as value:
 
   * `name` (`string`) The name of the data, it will be shown in the tooltip
 
@@ -106,3 +110,15 @@ svgMap uses [svg-pan-zoom](https://github.com/ariutta/svg-pan-zoom) by [Anders R
 The country flag images are from [country-flags](https://github.com/hjnilsson/country-flags) by [Hampus Nilsson](https://github.com/hjnilsson).
 
 Most data in the demos was taken from [Wikipedia](https://www.wikipedia.org).
+
+---
+
+## Appendix - Internet Explorer 11 Support
+
+The library uses both `Object.assign` and `classlist.add`, which are not supported by IE11. In order to make this library work in IE11, you need to use a polyfill, which adds this functionalty to the browser. You can create a bundle by going to https://polyfill.io/v3/, or can use the pre-defined one below, which adds both of these two polyfills.
+
+```html
+<script src="https://polyfill.io/v3/polyfill.min.js?features=Element.prototype.classList%2CObject.assign"></script>
+```
+
+Ensure to include this script before the svgMap scripts.