Add docstring and improve code clarity/consistency

Author: alexshoe

src/components/shapes/calc_autorange.js

@@ -52,6 +52,14 @@ module.exports = function calcAutorange(gd) {
     }
 };
 
+/**
+ * Calculate autorange extremes for shapes that reference multiple axes (array refs).
+ *
+ * @param {object} gd - main graph div object
+ * @param {object} shape - shape object
+ * @param {string} axLetter - 'x' or 'y' indicating which axis dimension to process
+ * @returns {object} - mapping of axis IDs to arrays of converted coordinate values
+ */
 function calcArrayRefAutorange(gd, shape, axLetter) {
     var refs = shape[axLetter + 'ref'];
     var paramsToUse = axLetter === 'x' ? constants.paramIsX : constants.paramIsY;

src/components/shapes/defaults.js

@@ -68,6 +68,9 @@ function handleShapeDefaults(shapeIn, shapeOut, fullLayout) {
     var ySizeMode = coerce('ysizemode');
 
     // positioning
+    var dflts = [0.25, 0.75];
+    var pixelDflts = [0, 10];
+
     ['x', 'y'].forEach(axLetter => {
         var attrAnchor = axLetter + 'anchor';
         var sizeMode = axLetter === 'x' ? xSizeMode : ySizeMode;
@@ -86,8 +89,13 @@ function handleShapeDefaults(shapeIn, shapeOut, fullLayout) {
             var expectedLen = helpers.countDefiningCoords(shapeType, path, axLetter);
             axRef = Axes.coerceRefArray(shapeIn, shapeOut, gdMock, axLetter, undefined, 'paper', expectedLen);
             shapeOut['_' + axLetter + 'refArray'] = true;
+        } else {
+            // String/undefined case: use coerceRef
+            axRef = Axes.coerceRef(shapeIn, shapeOut, gdMock, axLetter, undefined, 'paper');
+        }
 
-            // Need to register the shape with all referenced axes for redrawing purposes
+        if(Array.isArray(axRef)) {
+            // Register the shape with all referenced axes for redrawing purposes
             axRef.forEach(function(ref) {
                 if(Axes.getRefType(ref) === 'range') {
                     ax = Axes.getFromId(gdMock, ref);
@@ -96,16 +104,8 @@ function handleShapeDefaults(shapeIn, shapeOut, fullLayout) {
                     }
                 }
             });
-        } else {
-            // String/undefined case: use coerceRef
-            axRef = Axes.coerceRef(shapeIn, shapeOut, gdMock, axLetter, undefined, 'paper');
-        }
 
-        if(Array.isArray(axRef)) {
             if(noPath) {
-                var dflts = [0.25, 0.75];
-                var pixelDflts = [0, 10];
-
                 [0, 1].forEach(function(i) {
                     var ref = axRef[i];
                     var refType = Axes.getRefType(ref);
@@ -160,9 +160,6 @@ function handleShapeDefaults(shapeIn, shapeOut, fullLayout) {
 
             // Coerce x0, x1, y0, y1
             if(noPath) {
-                var dflt0 = 0.25;
-                var dflt1 = 0.75;
-
                 // hack until V3.0 when log has regular range behavior - make it look like other
                 // ranges to send to coerce, then put it back after
                 // this is all to give reasonable default position behavior on log axes, which is
@@ -175,11 +172,11 @@ function handleShapeDefaults(shapeIn, shapeOut, fullLayout) {
                 shapeIn[attr1] = pos2r(shapeIn[attr1], true);
 
                 if(sizeMode === 'pixel') {
-                    coerce(attr0, 0);
-                    coerce(attr1, 10);
+                    coerce(attr0, pixelDflts[0]);
+                    coerce(attr1, pixelDflts[1]);
                 } else {
-                    Axes.coercePosition(shapeOut, gdMock, coerce, axRef, attr0, dflt0);
-                    Axes.coercePosition(shapeOut, gdMock, coerce, axRef, attr1, dflt1);
+                    Axes.coercePosition(shapeOut, gdMock, coerce, axRef, attr0, dflts[0]);
+                    Axes.coercePosition(shapeOut, gdMock, coerce, axRef, attr1, dflts[1]);
                 }
 
                 // hack part 2

src/components/shapes/draw.js

@@ -212,11 +212,10 @@ function setClipPath(shapePath, gd, shapeOptions) {
         }).select('rect').attr(rect);
 
         Drawing.setClipUrl(shapePath, clipId, gd);
-        return;
+    } else {
+        var clipAxes = (xref + yref).replace(/paper/g, '').replace(/[xyz][0-9]* *domain/g, '');
+        Drawing.setClipUrl(shapePath, clipAxes ? 'clip' + gd._fullLayout._uid + clipAxes : null, gd);
     }
-
-    var clipAxes = (xref + yref).replace(/paper/g, '').replace(/[xyz][0-9]* *domain/g, '');
-    Drawing.setClipUrl(shapePath, clipAxes ? 'clip' + gd._fullLayout._uid + clipAxes : null, gd);
 }
 
 function getMultiAxisClipRect(gd, xref, yref) {