Rename x_shift/y_shift → xshift/yshift

my-tien · my-tien · commit fdcaa0c8c02f · 2024-05-31T11:10:18.000+02:00
diff --git a/src/components/selections/attributes.js b/src/components/selections/attributes.js
@@ -53,7 +53,8 @@ module.exports = overrideAll(templatedArray('selection', {
         valType: 'any',
         description: 'Sets the selection\'s end y position.'
     },
-    x_shift: {
+
+    xshift: {
         valType: 'number',
         dflt: 0,
         min: -0.5,
@@ -64,7 +65,7 @@ module.exports = overrideAll(templatedArray('selection', {
             'the reference unit.'
         ].join(' ')
     },
-    y_shift: {
+    yshift: {
         valType: 'number',
         dflt: 0,
         min: -0.5,
@@ -75,6 +76,7 @@ module.exports = overrideAll(templatedArray('selection', {
             'the reference unit.'
         ].join(' ')
     },
+
     path: {
         valType: 'string',
         editType: 'arraydraw',
diff --git a/src/components/selections/defaults.js b/src/components/selections/defaults.js
@@ -49,8 +49,8 @@ function handleSelectionDefaults(selectionIn, selectionOut, fullLayout) {
     coerce('line.color');
     coerce('line.width');
     coerce('line.dash');
-    coerce('x_shift');
-    coerce('y_shift');
+    coerce('xshift');
+    coerce('yshift');
 
     // positioning
     var axLetters = ['x', 'y'];
diff --git a/src/components/shapes/attributes.js b/src/components/shapes/attributes.js
@@ -169,7 +169,17 @@ module.exports = templatedArray('shape', {
             'See `type` and `xsizemode` for more info.'
         ].join(' ')
     },
-
+    xshift: {
+        valType: 'number',
+        dflt: 0,
+        min: -0.5,
+        max: 0.5,
+        editType: 'calc',
+        description: [
+            'Only relevant if xref is a (multi-)category axes. Shifts x0 and x1 by a fraction of',
+            'the reference unit.'
+        ].join(' ')
+    },
     yref: extendFlat({}, annAttrs.yref, {
         description: [
             'Sets the shape\'s y coordinate axis.',
@@ -220,18 +230,7 @@ module.exports = templatedArray('shape', {
             'See `type` and `ysizemode` for more info.'
         ].join(' ')
     },
-    x_shift: {
-        valType: 'number',
-        dflt: 0,
-        min: -0.5,
-        max: 0.5,
-        editType: 'calc',
-        description: [
-            'Only relevant if xref is a (multi-)category axes. Shifts x0 and x1 by a fraction of',
-            'the reference unit.'
-        ].join(' ')
-    },
-    y_shift: {
+    yshift: {
         valType: 'number',
         dflt: 0,
         min: -0.5,
diff --git a/src/components/shapes/calc_autorange.js b/src/components/shapes/calc_autorange.js
@@ -27,7 +27,7 @@ module.exports = function calcAutorange(gd) {
             var vx1 = shape.xsizemode === 'pixel' ? shape.xanchor : shape.x1;
             ax = Axes.getFromId(gd, shape.xref);
 
-            bounds = shapeBounds(ax, vx0, vx1, shape.path, shape.x_shift, constants.paramIsX);
+            bounds = shapeBounds(ax, vx0, vx1, shape.path, shape.xshift, constants.paramIsX);
             if(bounds) {
                 shape._extremes[ax._id] = Axes.findExtremes(ax, bounds, calcXPaddingOptions(shape));
             }
@@ -38,7 +38,7 @@ module.exports = function calcAutorange(gd) {
             var vy1 = shape.ysizemode === 'pixel' ? shape.yanchor : shape.y1;
             ax = Axes.getFromId(gd, shape.yref);
 
-            bounds = shapeBounds(ax, vy0, vy1, shape.path, shape.y_shift, constants.paramIsY);
+            bounds = shapeBounds(ax, vy0, vy1, shape.path, shape.yshift, constants.paramIsY);
             if(bounds) {
                 shape._extremes[ax._id] = Axes.findExtremes(ax, bounds, calcYPaddingOptions(shape));
             }
diff --git a/src/components/shapes/defaults.js b/src/components/shapes/defaults.js
@@ -75,8 +75,8 @@ function handleShapeDefaults(shapeIn, shapeOut, fullLayout) {
         var pos2r;
         var r2pos;
 
-        coerce('x_shift');
-        coerce('y_shift');
+        coerce('xshift');
+        coerce('yshift');
 
         // xref, yref
         var axRef = Axes.coerceRef(shapeIn, shapeOut, gdMock, axLetter, undefined,
diff --git a/src/components/shapes/display_labels.js b/src/components/shapes/display_labels.js
@@ -89,10 +89,10 @@ module.exports = function drawLabel(gd, index, options, shapeGroup) {
         // Setup conversion functions
         var xa = Axes.getFromId(gd, options.xref);
         var xRefType = Axes.getRefType(options.xref);
-        var xShift = options.x_shift;
+        var xShift = options.xshift;
         var ya = Axes.getFromId(gd, options.yref);
         var yRefType = Axes.getRefType(options.yref);
-        var yShift = options.y_shift;
+        var yShift = options.yshift;
         var x2p = helpers.getDataToPixel(gd, xa, xShift, false, xRefType);
         var y2p = helpers.getDataToPixel(gd, ya, yShift, true, yRefType);
         shapex0 = x2p(options.x0);
diff --git a/src/components/shapes/draw.js b/src/components/shapes/draw.js
@@ -225,10 +225,10 @@ function setupDragElement(gd, shapePath, shapeOptions, index, shapeLayer, editHe
     // setup conversion functions
     var xa = Axes.getFromId(gd, shapeOptions.xref);
     var xRefType = Axes.getRefType(shapeOptions.xref);
-    var xShift = shapeOptions.x_shift;
+    var xShift = shapeOptions.xshift;
     var ya = Axes.getFromId(gd, shapeOptions.yref);
     var yRefType = Axes.getRefType(shapeOptions.yref);
-    var yShift = shapeOptions.y_shift;
+    var yShift = shapeOptions.yshift;
     var x2p = helpers.getDataToPixel(gd, xa, xShift, false, xRefType);
     var y2p = helpers.getDataToPixel(gd, ya, yShift, true, yRefType);
     var p2x = helpers.getPixelToData(gd, xa, false, xRefType);
diff --git a/src/components/shapes/helpers.js b/src/components/shapes/helpers.js
@@ -226,20 +226,20 @@ exports.getPathString = function(gd, options) {
     }
     if(options.xsizemode === 'pixel') {
         var xAnchorPos = x2p(options.xanchor);
-        x0 = xAnchorPos + options.x0 + shiftUnitX * options.x_shift;
-        x1 = xAnchorPos + options.x1 + shiftUnitX * options.x_shift;
+        x0 = xAnchorPos + options.x0 + shiftUnitX * options.xshift;
+        x1 = xAnchorPos + options.x1 + shiftUnitX * options.xshift;
     } else {
-        x0 = x2p(options.x0) + shiftUnitX * options.x_shift;
-        x1 = x2p(options.x1) + shiftUnitX * options.x_shift;
+        x0 = x2p(options.x0) + shiftUnitX * options.xshift;
+        x1 = x2p(options.x1) + shiftUnitX * options.xshift;
     }
 
     if(options.ysizemode === 'pixel') {
         var yAnchorPos = y2p(options.yanchor);
-        y0 = yAnchorPos - options.y0 - shiftUnitY * options.y_shift;
-        y1 = yAnchorPos - options.y1 - shiftUnitY * options.y_shift;
+        y0 = yAnchorPos - options.y0 - shiftUnitY * options.yshift;
+        y1 = yAnchorPos - options.y1 - shiftUnitY * options.yshift;
     } else {
-        y0 = y2p(options.y0) - shiftUnitY * options.y_shift;
-        y1 = y2p(options.y1) - shiftUnitY * options.y_shift;
+        y0 = y2p(options.y0) - shiftUnitY * options.yshift;
+        y1 = y2p(options.y1) - shiftUnitY * options.yshift;
     }
 
     if(type === 'line') return 'M' + x0 + ',' + y0 + 'L' + x1 + ',' + y1;
diff --git a/test/image/mocks/zzz_shape_shift_horizontal.json b/test/image/mocks/zzz_shape_shift_horizontal.json
@@ -42,7 +42,7 @@
                 "y1": ["A", "D"],
                 "x0": 0,
                 "x1": 0.25,
-                "y_shift": 0.5,
+                "yshift": 0.5,
                 "xref": "paper"
             },
             {
@@ -79,7 +79,7 @@
                 "y1": ["B", "D"],
                 "x0": 0,
                 "x1": 0.25,
-                "y_shift": -0.5,
+                "yshift": -0.5,
                 "xref": "paper"
             }
         ]
diff --git a/test/image/mocks/zzz_shape_shift_vertical.json b/test/image/mocks/zzz_shape_shift_vertical.json
@@ -29,7 +29,7 @@
                 "x1": "A",
                 "y0": 0,
                 "y1": 0.5,
-                "x_shift": 0.5,
+                "xshift": 0.5,
                 "yref": "paper"
             },
             {
@@ -48,7 +48,7 @@
                 "x1": 3,
                 "y0": 0,
                 "y1": 0.5,
-                "x_shift": -0.25,
+                "xshift": -0.25,
                 "yref": "paper"
             }
         ],
@@ -58,7 +58,7 @@
                 "x1": 4,
                 "y0": 1,
                 "y1": 3,
-                "x_shift": -0.5
+                "xshift": -0.5
             }
         ]
     }
diff --git a/test/jasmine/tests/shapes_test.js b/test/jasmine/tests/shapes_test.js
@@ -1487,8 +1487,8 @@ describe('Test shapes', function() {
     function testShapeDrag(dx, dy, layoutShape, node) {
         var xa = Axes.getFromId(gd, layoutShape.xref);
         var ya = Axes.getFromId(gd, layoutShape.yref);
-        var x2p = helpers.getDataToPixel(gd, xa, layoutShape.x_shift);
-        var y2p = helpers.getDataToPixel(gd, ya, layoutShape.y_shift, true);
+        var x2p = helpers.getDataToPixel(gd, xa, layoutShape.xshift);
+        var y2p = helpers.getDataToPixel(gd, ya, layoutShape.yshift, true);
 
         var initialCoordinates = getShapeCoordinates(layoutShape, x2p, y2p);
 
@@ -1514,8 +1514,8 @@ describe('Test shapes', function() {
     function testPathDrag(dx, dy, layoutShape, node) {
         var xa = Axes.getFromId(gd, layoutShape.xref);
         var ya = Axes.getFromId(gd, layoutShape.yref);
-        var x2p = helpers.getDataToPixel(gd, xa, layoutShape.x_shift);
-        var y2p = helpers.getDataToPixel(gd, ya, layoutShape.y_shift, true);
+        var x2p = helpers.getDataToPixel(gd, xa, layoutShape.xshift);
+        var y2p = helpers.getDataToPixel(gd, ya, layoutShape.yshift, true);
 
         var initialPath = layoutShape.path;
         var initialCoordinates = getPathCoordinates(initialPath, x2p, y2p);
@@ -1546,8 +1546,8 @@ describe('Test shapes', function() {
     function testShapeResize(direction, dx, dy, layoutShape, node) {
         var xa = Axes.getFromId(gd, layoutShape.xref);
         var ya = Axes.getFromId(gd, layoutShape.yref);
-        var x2p = helpers.getDataToPixel(gd, xa, layoutShape.x_shift);
-        var y2p = helpers.getDataToPixel(gd, ya, layoutShape.y_shift, true);
+        var x2p = helpers.getDataToPixel(gd, xa, layoutShape.xshift);
+        var y2p = helpers.getDataToPixel(gd, ya, layoutShape.yshift, true);
 
         var initialCoordinates = getShapeCoordinates(layoutShape, x2p, y2p);
 
@@ -1590,8 +1590,8 @@ describe('Test shapes', function() {
 
         var xa = Axes.getFromId(gd, layoutShape.xref);
         var ya = Axes.getFromId(gd, layoutShape.yref);
-        var x2p = helpers.getDataToPixel(gd, xa, layoutShape.x_shift);
-        var y2p = helpers.getDataToPixel(gd, ya, layoutShape.y_shift, true);
+        var x2p = helpers.getDataToPixel(gd, xa, layoutShape.xshift);
+        var y2p = helpers.getDataToPixel(gd, ya, layoutShape.yshift, true);
 
         promise = promise.then(function() {
             var dragHandle = pointToMove === 'start' ?
diff --git a/test/plot-schema.json b/test/plot-schema.json
@@ -9550,14 +9550,6 @@
         "path"
        ]
       },
-      "x_shift": {
-       "description": "Only relevant if xref is a (multi-)category axes. Shifts x0 and x1 by a fraction of the reference unit.",
-       "dflt": 0,
-       "editType": "arraydraw",
-       "max": 0.5,
-       "min": -0.5,
-       "valType": "number"
-      },
       "x0": {
        "description": "Sets the selection's starting x position.",
        "editType": "arraydraw",
@@ -9577,8 +9569,8 @@
         "/^x([2-9]|[1-9][0-9]+)?( domain)?$/"
        ]
       },
-      "y_shift": {
-       "description": "Only relevant if yref is a (multi-)category axes. Shifts y0 and y1 by a fraction of the reference unit.",
+      "xshift": {
+       "description": "Only relevant if xref is a (multi-)category axes. Shifts x0 and x1 by a fraction of the reference unit.",
        "dflt": 0,
        "editType": "arraydraw",
        "max": 0.5,
@@ -9603,6 +9595,14 @@
         "paper",
         "/^y([2-9]|[1-9][0-9]+)?( domain)?$/"
        ]
+      },
+      "yshift": {
+       "description": "Only relevant if yref is a (multi-)category axes. Shifts y0 and y1 by a fraction of the reference unit.",
+       "dflt": 0,
+       "editType": "arraydraw",
+       "max": 0.5,
+       "min": -0.5,
+       "valType": "number"
       }
      }
     },
@@ -10016,14 +10016,6 @@
         "legendonly"
        ]
       },
-      "x_shift": {
-       "description": "Only relevant if xref is a (multi-)category axes. Shifts x0 and x1 by a fraction of the reference unit.",
-       "dflt": 0,
-       "editType": "calc",
-       "max": 0.5,
-       "min": -0.5,
-       "valType": "number"
-      },
       "x0": {
        "description": "Sets the shape's starting x position. See `type` and `xsizemode` for more info.",
        "editType": "calc+arraydraw",
@@ -10048,6 +10040,14 @@
         "/^x([2-9]|[1-9][0-9]+)?( domain)?$/"
        ]
       },
+      "xshift": {
+       "description": "Only relevant if xref is a (multi-)category axes. Shifts x0 and x1 by a fraction of the reference unit.",
+       "dflt": 0,
+       "editType": "calc",
+       "max": 0.5,
+       "min": -0.5,
+       "valType": "number"
+      },
       "xsizemode": {
        "description": "Sets the shapes's sizing mode along the x axis. If set to *scaled*, `x0`, `x1` and x coordinates within `path` refer to data values on the x axis or a fraction of the plot area's width (`xref` set to *paper*). If set to *pixel*, `xanchor` specifies the x position in terms of data or plot fraction but `x0`, `x1` and x coordinates within `path` are pixels relative to `xanchor`. This way, the shape can have a fixed width while maintaining a position relative to data or plot fraction.",
        "dflt": "scaled",
@@ -10058,14 +10058,6 @@
         "pixel"
        ]
       },
-      "y_shift": {
-       "description": "Only relevant if yref is a (multi-)category axes. Shifts y0 and y1 by a fraction of the reference unit.",
-       "dflt": 0,
-       "editType": "calc",
-       "max": 0.5,
-       "min": -0.5,
-       "valType": "number"
-      },
       "y0": {
        "description": "Sets the shape's starting y position. See `type` and `ysizemode` for more info.",
        "editType": "calc+arraydraw",
@@ -10090,6 +10082,14 @@
         "/^y([2-9]|[1-9][0-9]+)?( domain)?$/"
        ]
       },
+      "yshift": {
+       "description": "Only relevant if yref is a (multi-)category axes. Shifts y0 and y1 by a fraction of the reference unit.",
+       "dflt": 0,
+       "editType": "calc",
+       "max": 0.5,
+       "min": -0.5,
+       "valType": "number"
+      },
       "ysizemode": {
        "description": "Sets the shapes's sizing mode along the y axis. If set to *scaled*, `y0`, `y1` and y coordinates within `path` refer to data values on the y axis or a fraction of the plot area's height (`yref` set to *paper*). If set to *pixel*, `yanchor` specifies the y position in terms of data or plot fraction but `y0`, `y1` and y coordinates within `path` are pixels relative to `yanchor`. This way, the shape can have a fixed height while maintaining a position relative to data or plot fraction.",
        "dflt": "scaled",

Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@`
`42`	`42`	`"y1": ["A", "D"],`
`43`	`43`	`"x0": 0,`
`44`	`44`	`"x1": 0.25,`
`45`		`- "y_shift": 0.5,`
	`45`	`+ "yshift": 0.5,`
`46`	`46`	`"xref": "paper"`
`47`	`47`	`},`
`48`	`48`	`{`
`@@ -79,7 +79,7 @@`
`79`	`79`	`"y1": ["B", "D"],`
`80`	`80`	`"x0": 0,`
`81`	`81`	`"x1": 0.25,`
`82`		`- "y_shift": -0.5,`
	`82`	`+ "yshift": -0.5,`
`83`	`83`	`"xref": "paper"`
`84`	`84`	`}`
`85`	`85`	`]`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@`
`29`	`29`	`"x1": "A",`
`30`	`30`	`"y0": 0,`
`31`	`31`	`"y1": 0.5,`
`32`		`- "x_shift": 0.5,`
	`32`	`+ "xshift": 0.5,`
`33`	`33`	`"yref": "paper"`
`34`	`34`	`},`
`35`	`35`	`{`
`@@ -48,7 +48,7 @@`
`48`	`48`	`"x1": 3,`
`49`	`49`	`"y0": 0,`
`50`	`50`	`"y1": 0.5,`
`51`		`- "x_shift": -0.25,`
	`51`	`+ "xshift": -0.25,`
`52`	`52`	`"yref": "paper"`
`53`	`53`	`}`
`54`	`54`	`],`
`@@ -58,7 +58,7 @@`
`58`	`58`	`"x1": 4,`
`59`	`59`	`"y0": 1,`
`60`	`60`	`"y1": 3,`
`61`		`- "x_shift": -0.5`
	`61`	`+ "xshift": -0.5`
`62`	`62`	`}`
`63`	`63`	`]`
`64`	`64`	`}`