svgmap 2.20.1 → 2.21.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "svgmap",
   "description": "svgMap is a JavaScript library that lets you easily create an interactable world map comparing customizable data for each country.",
-  "version": "2.20.1",
+  "version": "2.21.0",
   "type": "module",
   "license": "MIT",
   "keywords": [

package/src/js/core/svg-map.js

@@ -101,7 +101,34 @@ export default class svgMap {
       showContinentSelector: false,
 
       // Reset zoom on resize
-      resetZoomOnResize: false
+      resetZoomOnResize: false,
+
+      // Static pins: false | string[] | function(countryID, countryValues) => boolean
+      staticPins: false,
+
+      // Default pin fill color
+      pinColor: '#000000',
+
+      // Default pin stroke color and width (circle pins; width is in screen pixels with non-scaling stroke)
+      pinStrokeColor: '#ffffff',
+      pinStrokeWidth: 1.5,
+
+      // Default pin radius in SVG units (viewBox is 2000 × 1001)
+      pinSize: 8,
+
+      // Custom pin element: function(countryID, countryValues) => SVGElement | null
+      onGetPin: null,
+
+      // Image URL to use as a pin instead of the default circle (can also be set per-country via values[id].pinImage)
+      pinImage: null,
+
+      // Width and height of the pin image in SVG units (viewBox is 2000 × 1001)
+      pinImageWidth: 20,
+      pinImageHeight: 20,
+
+      // Offset from computed pin position, in SVG units (added after auto center or pinX/pinY)
+      pinOffsetX: 0,
+      pinOffsetY: 0
     };
 
     this.options = Object.assign({}, defaultOptions, options);
@@ -975,7 +1002,7 @@ export default class svgMap {
       }
       countryElement.parentNode.insertBefore(
         countryElement,
-        this.persistentTooltipGroup || null
+        this.persistentTooltipGroup || this.pinGroup || null
       );
       if (setActive) {
         countryElement.classList.add('svgMap-active');
@@ -1095,6 +1122,10 @@ export default class svgMap {
       this.createPersistentTooltips(countryElements);
     }
 
+    if (this.options.staticPins) {
+      this.createStaticPins(countryElements);
+    }
+
     let pointerStart = null;
     let activeCountry = null;
 
@@ -1157,7 +1188,7 @@ export default class svgMap {
             clearActive();
             countryElement.parentNode.insertBefore(
               countryElement,
-              this.persistentTooltipGroup || null
+              this.persistentTooltipGroup || this.pinGroup || null
             );
             countryElement.classList.add('svgMap-active');
             this.setTooltipContent(this.getTooltipContent(countryID));
@@ -1171,7 +1202,7 @@ export default class svgMap {
         clearActive();
         countryElement.parentNode.insertBefore(
           countryElement,
-          this.persistentTooltipGroup || null
+          this.persistentTooltipGroup || this.pinGroup || null
         );
         countryElement.classList.add('svgMap-active');
         this.setTooltipContent(this.getTooltipContent(countryID));
@@ -1359,6 +1390,157 @@ export default class svgMap {
     );
   }
 
+  // Create static pins on the map
+
+  createStaticPins(countryElements) {
+    if (this.pinGroup) {
+      this.pinGroup.remove();
+    }
+
+    this.pinGroup = document.createElementNS('http://www.w3.org/2000/svg', 'g');
+    this.pinGroup.classList.add('svgMap-pin-group');
+    this.mapImage.appendChild(this.pinGroup);
+
+    countryElements.forEach(
+      function (countryElement) {
+        var countryID = countryElement.getAttribute('data-id');
+        if (!this.shouldShowPin(countryID)) {
+          return;
+        }
+
+        var countryValues = this.options.data.values[countryID];
+        var cx, cy;
+
+        if (
+          countryValues &&
+          countryValues.pinX != null &&
+          countryValues.pinY != null
+        ) {
+          cx = countryValues.pinX;
+          cy = countryValues.pinY;
+        } else {
+          // Split the path at absolute M commands and use the largest sub-path
+          // to avoid overseas territories (islands, colonies) skewing the center.
+          var d = countryElement.getAttribute('d');
+          var subPaths = d.split(/(?=M)/).filter((s) => s.trim().length > 0);
+          var largestBB = null;
+          var largestArea = -1;
+
+          subPaths.forEach(
+            function (subPath) {
+              var tmp = document.createElementNS(
+                'http://www.w3.org/2000/svg',
+                'path'
+              );
+              tmp.setAttribute('d', subPath);
+              this.mapImage.appendChild(tmp);
+              var bb = tmp.getBBox();
+              var area = bb.width * bb.height;
+              if (area > largestArea) {
+                largestArea = area;
+                largestBB = bb;
+              }
+              this.mapImage.removeChild(tmp);
+            }.bind(this)
+          );
+
+          cx = largestBB.x + largestBB.width / 2;
+          cy = largestBB.y + largestBB.height / 2;
+        }
+
+        var offsetX =
+          countryValues && countryValues.pinOffsetX != null
+            ? countryValues.pinOffsetX
+            : this.options.pinOffsetX;
+        var offsetY =
+          countryValues && countryValues.pinOffsetY != null
+            ? countryValues.pinOffsetY
+            : this.options.pinOffsetY;
+        cx += offsetX;
+        cy += offsetY;
+
+        var color =
+          (countryValues && countryValues.pinColor) || this.options.pinColor;
+        var size =
+          (countryValues && countryValues.pinSize) || this.options.pinSize;
+        var strokeColor =
+          (countryValues && countryValues.pinStrokeColor) ||
+          this.options.pinStrokeColor;
+        var strokeWidth =
+          (countryValues && countryValues.pinStrokeWidth) ||
+          this.options.pinStrokeWidth;
+
+        if (typeof this.options.onGetPin === 'function') {
+          var custom = this.options.onGetPin(countryID, countryValues);
+          if (custom) {
+            custom.setAttribute(
+              'transform',
+              'translate(' + cx + ',' + cy + ')'
+            );
+            this.pinGroup.appendChild(custom);
+            return;
+          }
+        }
+
+        var pinImage =
+          (countryValues && countryValues.pinImage) || this.options.pinImage;
+
+        if (pinImage) {
+          var pinW =
+            (countryValues && countryValues.pinImageWidth) ||
+            this.options.pinImageWidth;
+          var pinH =
+            (countryValues && countryValues.pinImageHeight) ||
+            this.options.pinImageHeight;
+          var img = document.createElementNS(
+            'http://www.w3.org/2000/svg',
+            'image'
+          );
+          img.setAttribute('href', pinImage);
+          img.setAttribute('x', cx - pinW / 2);
+          img.setAttribute('y', cy - pinH / 2);
+          img.setAttribute('width', pinW);
+          img.setAttribute('height', pinH);
+          img.setAttribute('data-id', countryID);
+          img.classList.add('svgMap-pin');
+          this.pinGroup.appendChild(img);
+          return;
+        }
+
+        var circle = document.createElementNS(
+          'http://www.w3.org/2000/svg',
+          'circle'
+        );
+        circle.setAttribute('cx', cx);
+        circle.setAttribute('cy', cy);
+        circle.setAttribute('r', size);
+        circle.setAttribute('fill', color);
+        if (strokeWidth > 0) {
+          circle.setAttribute('stroke', strokeColor);
+          circle.setAttribute('stroke-width', strokeWidth);
+          circle.setAttribute('vector-effect', 'non-scaling-stroke');
+        }
+        circle.setAttribute('data-id', countryID);
+        circle.classList.add('svgMap-pin');
+        this.pinGroup.appendChild(circle);
+      }.bind(this)
+    );
+  }
+
+  // Check if a static pin should be shown for a country
+
+  shouldShowPin(countryID) {
+    var pins = this.options.staticPins;
+    var countryValues = this.options.data.values[countryID];
+    if (Array.isArray(pins)) {
+      return pins.indexOf(countryID) !== -1;
+    }
+    if (typeof pins === 'function') {
+      return pins(countryID, countryValues);
+    }
+    return false;
+  }
+
   // Check if a persistent tooltip should be shown on load
 
   shouldShowTooltipOnLoad(countryID) {

package/src/scss/map.scss

@@ -259,3 +259,14 @@
 .svgMap-wrapper.svgMap-country-click-callback .svgMap-map-wrapper .svgMap-country {
   cursor: pointer;
 }
+
+// Static pins
+
+.svgMap-pin-group {
+  pointer-events: none;
+}
+
+.svgMap-pin {
+  vector-effect: non-scaling-stroke;
+  transition: r 250ms;
+}