feat(geo): support min/max scale limits

fixes #5191
plotly · camdecoster · Oct 5, 2020 · Oct 26, 2020 · Oct 26, 2020 · Oct 26, 2020
commit 57307ee8ab72d4e8555e97af8168c30dfd9f0b8d
diff --git a/src/components/modebar/buttons.js b/src/components/modebar/buttons.js
@@ -543,8 +543,18 @@ function handleGeo(gd, ev) {
 
         if(attr === 'zoom') {
             var scale = geoLayout.projection.scale;
+            var minScale = geoLayout.projection.minScale;
+            var maxScale = geoLayout.projection.maxScale;
+
             var newScale = (val === 'in') ? 2 * scale : 0.5 * scale;
 
+            // make sure the scale is within the min/max bounds
+            if(newScale > maxScale) {
+                newScale = maxScale;
+            } else if(newScale < minScale) {
+                newScale = minScale;
+            }
+
             Registry.call('_guiRelayout', gd, id + '.projection.scale', newScale);
         }
     }

diff --git a/src/plots/geo/geo.js b/src/plots/geo/geo.js
@@ -709,6 +709,14 @@ function getProjection(geoLayout) {
 
     projection.precision(constants.precision);
 
+    // https://github.com/d3/d3-zoom/blob/master/README.md#zoom_scaleExtent
+    projection.scaleExtent = function() {
+        var minscale = projLayout.minscale;
+        var maxscale = projLayout.maxscale;
+        if(maxscale === -1) maxscale = Infinity;
+        return [100 * minscale, 100 * maxscale];
+    };
+
     if(geoLayout._isSatellite) {
         projection.tilt(projLayout.tilt).distance(projLayout.distance);
     }

diff --git a/src/plots/geo/layout_attributes.js b/src/plots/geo/layout_attributes.js
@@ -177,6 +177,26 @@ var attrs = module.exports = overrideAll({
                 'that fits the map\'s lon and lat ranges. '
             ].join(' ')
         },
+        minScale: {
+            valType: 'number',
+            min: 0,
+            dflt: 0,
+            description: [
+                'Minimal zoom level of the map view.',
+                'A minScale of *0.5* (50%) corresponds to a zoom level',
+                'where the map has half the size of base zoom level.'
+            ].join(' ')
+        },
+        maxScale: {
+            valType: 'number',
+            min: 0,
+            dflt: Infinity,
+            description: [
+                'Maximal zoom level of the map view.',
+                'A maxScale of *2* (200%) corresponds to a zoom level',
+                'where the map is twice as big as the base layer.'
+            ].join(' ')
+        },
     },
     center: {
         lon: {

diff --git a/src/plots/geo/layout_defaults.js b/src/plots/geo/layout_defaults.js
@@ -161,6 +161,8 @@ function handleGeoDefaults(geoLayoutIn, geoLayoutOut, coerce, opts) {
     }
 
     coerce('projection.scale');
+    coerce('projection.minScale');
+    coerce('projection.maxScale');
 
     show = coerce('showland', !visible ? false : undefined);
     if(show) coerce('landcolor');
@@ -205,6 +207,8 @@ function handleGeoDefaults(geoLayoutIn, geoLayoutOut, coerce, opts) {
     // clear attributes that will get auto-filled later
     if(fitBounds) {
         delete geoLayoutOut.projection.scale;
+        delete geoLayoutOut.projection.minScale;
+        delete geoLayoutOut.projection.maxScale;
 
         if(isScoped) {
             delete geoLayoutOut.center.lon;

diff --git a/src/plots/geo/zoom.js b/src/plots/geo/zoom.js
@@ -32,6 +32,7 @@ module.exports = createGeoZoom;
 function initZoom(geo, projection) {
     return d3.behavior.zoom()
         .translate(projection.translate())
+        .scaleExtent(projection.scaleExtent())
         .scale(projection.scale());
 }