add autorange exact min and max

plotly · archmoj · Aug 24, 2023 · Mar 31, 2023 · Mar 31, 2023 · Apr 3, 2023
commit cf7b2642c359d15d49f15dedf75c3f005834d4b2
diff --git a/src/plots/cartesian/autorange.js b/src/plots/cartesian/autorange.js
@@ -13,8 +13,8 @@ var getFromId = axIds.getFromId;
 var isLinked = axIds.isLinked;
 
 module.exports = {
-    applyAutorangeClipMin: applyAutorangeClipMin,
-    applyAutorangeClipMax: applyAutorangeClipMax,
+    applyAutorangeMinOptions: applyAutorangeMinOptions,
+    applyAutorangeMaxOptions: applyAutorangeMaxOptions,
     getAutoRange: getAutoRange,
     makePadFn: makePadFn,
     doAutoRange: doAutoRange,
@@ -178,8 +178,8 @@ function getAutoRange(gd, ax) {
         ];
     }
 
-    newRange[0] = applyAutorangeClipMin(newRange[0], ax);
-    newRange[1] = applyAutorangeClipMax(newRange[1], ax);
+    newRange[0] = applyAutorangeMinOptions(newRange[0], ax);
+    newRange[1] = applyAutorangeMaxOptions(newRange[1], ax);
 
     if(ax.limitRange) ax.limitRange();
 
@@ -631,12 +631,16 @@ function goodNumber(v) {
 function lessOrEqual(v0, v1) { return v0 <= v1; }
 function greaterOrEqual(v0, v1) { return v0 >= v1; }
 
-function applyAutorangeClipMin(v, ax) {
-    if(!ax || ax.autorangeclipmin === undefined) return v;
+function applyAutorangeMinOptions(v, ax) {
+    if(!ax) return v;
+    if(ax.autorangemin !== undefined) return ax.autorangemin;
+    if(ax.autorangeclipmin === undefined) return v;
     return Math.max(v, ax.d2l(ax.autorangeclipmin));
 }
 
-function applyAutorangeClipMax(v, ax) {
-    if(!ax || ax.autorangeclipmax === undefined) return v;
+function applyAutorangeMaxOptions(v, ax) {
+    if(!ax) return v;
+    if(ax.autorangemax !== undefined) return ax.autorangemax;
+    if(ax.autorangeclipmax === undefined) return v;
     return Math.min(v, ax.d2l(ax.autorangeclipmax));
 }
diff --git a/src/plots/cartesian/axis_defaults.js b/src/plots/cartesian/axis_defaults.js
@@ -95,8 +95,11 @@ module.exports = function handleAxisDefaults(containerIn, containerOut, coerce,
     if(autorangeDflt && options.reverseDflt) autorangeDflt = 'reversed';
     var autoRange = coerce('autorange', autorangeDflt);
     if(autoRange) {
-        coerce('autorangeclipmin');
-        coerce('autorangeclipmax');
+        var autorangemin = coerce('autorangemin');
+        var autorangemax = coerce('autorangemax');
+
+        if(autorangemin === undefined) coerce('autorangeclipmin');
+        if(autorangemax === undefined) coerce('autorangeclipmax');
 
         if(axType === 'linear' || axType === '-') coerce('rangemode');
     }

diff --git a/src/plots/cartesian/layout_attributes.js b/src/plots/cartesian/layout_attributes.js
@@ -283,6 +283,22 @@ module.exports = {
             'If `range` is provided, then `autorange` is set to *false*.'
         ].join(' ')
     },
+    autorangemin: {
+        valType: 'any',
+        editType: 'plot',
+        impliedEdits: {'range[0]': undefined, 'range[1]': undefined},
+        description: [
+            'Use this value exactly as autorange minimum.'
+        ].join(' ')
+    },
+    autorangemax: {
+        valType: 'any',
+        editType: 'plot',
+        impliedEdits: {'range[0]': undefined, 'range[1]': undefined},
+        description: [
+            'Use this value exactly as autorange maximum.'
+        ].join(' ')
+    },
     autorangeclipmin: {
         valType: 'any',
         editType: 'plot',

diff --git a/src/plots/gl3d/layout/axis_attributes.js b/src/plots/gl3d/layout/axis_attributes.js
@@ -65,6 +65,8 @@ module.exports = overrideAll({
     }),
     autotypenumbers: axesAttrs.autotypenumbers,
     autorange: axesAttrs.autorange,
+    autorangemin: axesAttrs.autorangemin,
+    autorangemax: axesAttrs.autorangemax,
     autorangeclipmin: axesAttrs.autorangeclipmin,
     autorangeclipmax: axesAttrs.autorangeclipmax,
     rangemode: axesAttrs.rangemode,

diff --git a/src/plots/gl3d/scene.js b/src/plots/gl3d/scene.js
@@ -22,8 +22,8 @@ var createAxesOptions = require('./layout/convert');
 var createSpikeOptions = require('./layout/spikes');
 var computeTickMarks = require('./layout/tick_marks');
 
-var applyAutorangeClipMin = require('../cartesian/autorange').applyAutorangeClipMin;
-var applyAutorangeClipMax = require('../cartesian/autorange').applyAutorangeClipMax;
+var applyAutorangeMinOptions = require('../cartesian/autorange').applyAutorangeMinOptions;
+var applyAutorangeMaxOptions = require('../cartesian/autorange').applyAutorangeMaxOptions;
 
 var STATIC_CANVAS, STATIC_CONTEXT;
 
@@ -727,8 +727,8 @@ proto.plot = function(sceneData, fullLayout, layout) {
                 sceneBounds[1][i] += d / 32.0;
             }
 
-            sceneBounds[0][i] = applyAutorangeClipMin(sceneBounds[0][i], axis);
-            sceneBounds[1][i] = applyAutorangeClipMax(sceneBounds[1][i], axis);
+            sceneBounds[0][i] = applyAutorangeMinOptions(sceneBounds[0][i], axis);
+            sceneBounds[1][i] = applyAutorangeMaxOptions(sceneBounds[1][i], axis);
 
             if(axis.autorange === 'reversed') {
                 // swap bounds:

diff --git a/src/plots/polar/layout_attributes.js b/src/plots/polar/layout_attributes.js
@@ -58,6 +58,8 @@ var radialAxisAttrs = {
     }),
     autotypenumbers: axesAttrs.autotypenumbers,
 
+    autorangemin: axesAttrs.autorangemin,
+    autorangemax: axesAttrs.autorangemax,
     autorangeclipmin: axesAttrs.autorangeclipmin,
     autorangeclipmax: axesAttrs.autorangeclipmax,
     autorange: extendFlat({}, axesAttrs.autorange, {editType: 'plot'}),

diff --git a/src/plots/polar/layout_defaults.js b/src/plots/polar/layout_defaults.js
@@ -79,8 +79,12 @@ function handleDefaults(contIn, contOut, coerce, opts) {
                 var autoRange = coerceAxis('autorange', !axOut.isValidRange(axIn.range));
                 axIn.autorange = autoRange;
                 if(autoRange) {
-                    coerceAxis('autorangeclipmin');
-                    coerceAxis('autorangeclipmax');
+                    var autorangemin = coerceAxis('autorangemin');
+                    var autorangemax = coerceAxis('autorangemax');
+
+                    if(autorangemin === undefined) coerceAxis('autorangeclipmin');
+                    if(autorangemax === undefined) coerceAxis('autorangeclipmax');
+
                     if(axType === 'linear' || axType === '-') coerceAxis('rangemode');
                     if(autoRange === 'reversed') axOut._m = -1;
                 }

diff --git a/test/image/baselines/bar-colorscale-colorbar.png b/test/image/baselines/bar-colorscale-colorbar.png
diff --git a/test/image/baselines/bar_errorbars_inherit_color.png b/test/image/baselines/bar_errorbars_inherit_color.png
diff --git a/test/image/baselines/gl3d_mesh3d_enable-alpha-with-rgba-color.png b/test/image/baselines/gl3d_mesh3d_enable-alpha-with-rgba-color.png
diff --git a/test/image/mocks/bar-colorscale-colorbar.json b/test/image/mocks/bar-colorscale-colorbar.json
@@ -58,6 +58,7 @@
             "text": "bars + colorbar = <3"
         },
         "xaxis": {
+            "autorangemin": 0.5,
             "type": "linear",
             "range": [
                 -0.5,

diff --git a/test/image/mocks/bar_errorbars_inherit_color.json b/test/image/mocks/bar_errorbars_inherit_color.json
@@ -63,6 +63,9 @@
   ],
   "layout": {
       "width": 600,
+      "yaxis": {
+        "autorangemax": 1100
+      },
       "title": {
           "text": "Bar chart error bars inherit color from marker.line not marker"
       }

diff --git a/test/image/mocks/gl3d_mesh3d_enable-alpha-with-rgba-color.json b/test/image/mocks/gl3d_mesh3d_enable-alpha-with-rgba-color.json
@@ -20,6 +20,17 @@
         "title": {
             "text": "Should draw transparent mesh<br>when having transparent rgba color"
         },
+        "scene": {
+            "xaxis": {
+                "autorangemin": -0.5
+            },
+            "yaxis": {
+                "autorangemin": -0.5
+            },
+            "zaxis": {
+                "autorangemax": 2.5
+            }
+        },
         "width": 400,
         "height": 400
     }

diff --git a/test/image/mocks/polar_fills.json b/test/image/mocks/polar_fills.json
@@ -47,7 +47,8 @@
         "y": [0.54, 1]
       },
       "radialaxis": {
-        "range": [2, 5]
+        "autorangeclipmin": 2,
+        "autorangeclipmax": 5
       }
     },
     "showlegend": false,

diff --git a/test/plot-schema.json b/test/plot-schema.json
@@ -4320,6 +4320,18 @@
       "impliedEdits": {},
       "valType": "any"
      },
+     "autorangemax": {
+      "description": "Use this value exactly as autorange maximum.",
+      "editType": "plot",
+      "impliedEdits": {},
+      "valType": "any"
+     },
+     "autorangemin": {
+      "description": "Use this value exactly as autorange minimum.",
+      "editType": "plot",
+      "impliedEdits": {},
+      "valType": "any"
+     },
      "autotypenumbers": {
       "description": "Using *strict* a numeric string in trace data is not converted to a number. Using *convert types* a numeric string in trace data may be treated as a number during automatic axis `type` detection. Defaults to layout.autotypenumbers.",
       "dflt": "convert types",
@@ -5459,6 +5471,18 @@
       "impliedEdits": {},
       "valType": "any"
      },
+     "autorangemax": {
+      "description": "Use this value exactly as autorange maximum.",
+      "editType": "plot",
+      "impliedEdits": {},
+      "valType": "any"
+     },
+     "autorangemin": {
+      "description": "Use this value exactly as autorange minimum.",
+      "editType": "plot",
+      "impliedEdits": {},
+      "valType": "any"
+     },
      "autotypenumbers": {
       "description": "Using *strict* a numeric string in trace data is not converted to a number. Using *convert types* a numeric string in trace data may be treated as a number during automatic axis `type` detection. Defaults to layout.autotypenumbers.",
       "dflt": "convert types",
@@ -6055,6 +6079,18 @@
       "impliedEdits": {},
       "valType": "any"
      },
+     "autorangemax": {
+      "description": "Use this value exactly as autorange maximum.",
+      "editType": "plot",
+      "impliedEdits": {},
+      "valType": "any"
+     },
+     "autorangemin": {
+      "description": "Use this value exactly as autorange minimum.",
+      "editType": "plot",
+      "impliedEdits": {},
+      "valType": "any"
+     },
      "autotypenumbers": {
       "description": "Using *strict* a numeric string in trace data is not converted to a number. Using *convert types* a numeric string in trace data may be treated as a number during automatic axis `type` detection. Defaults to layout.autotypenumbers.",
       "dflt": "convert types",
@@ -6651,6 +6687,18 @@
       "impliedEdits": {},
       "valType": "any"
      },
+     "autorangemax": {
+      "description": "Use this value exactly as autorange maximum.",
+      "editType": "plot",
+      "impliedEdits": {},
+      "valType": "any"
+     },
+     "autorangemin": {
+      "description": "Use this value exactly as autorange minimum.",
+      "editType": "plot",
+      "impliedEdits": {},
+      "valType": "any"
+     },
      "autotypenumbers": {
       "description": "Using *strict* a numeric string in trace data is not converted to a number. Using *convert types* a numeric string in trace data may be treated as a number during automatic axis `type` detection. Defaults to layout.autotypenumbers.",
       "dflt": "convert types",
@@ -10361,6 +10409,18 @@
      "impliedEdits": {},
      "valType": "any"
     },
+    "autorangemax": {
+     "description": "Use this value exactly as autorange maximum.",
+     "editType": "plot",
+     "impliedEdits": {},
+     "valType": "any"
+    },
+    "autorangemin": {
+     "description": "Use this value exactly as autorange minimum.",
+     "editType": "plot",
+     "impliedEdits": {},
+     "valType": "any"
+    },
     "autotypenumbers": {
      "description": "Using *strict* a numeric string in trace data is not converted to a number. Using *convert types* a numeric string in trace data may be treated as a number during automatic axis `type` detection. Defaults to layout.autotypenumbers.",
      "dflt": "convert types",
@@ -11647,6 +11707,18 @@
      "impliedEdits": {},
      "valType": "any"
     },
+    "autorangemax": {
+     "description": "Use this value exactly as autorange maximum.",
+     "editType": "plot",
+     "impliedEdits": {},
+     "valType": "any"
+    },
+    "autorangemin": {
+     "description": "Use this value exactly as autorange minimum.",
+     "editType": "plot",
+     "impliedEdits": {},
+     "valType": "any"
+    },
     "autoshift": {
      "description": "Automatically reposition the axis to avoid overlap with other axes with the same `overlaying` value. This repositioning will account for any `shift` amount applied to other axes on the same side with `autoshift` is set to true. Only has an effect if `anchor` is set to *free*.",
      "dflt": false,