Add x_shift/y_shift for selections as well, add selection example to mock

Author: my-tien

draftlogs/7005_add.md

@@ -1 +1 @@
- - Add property shape.x_shift/shape.y_shift for shapes referencing (multi-)category axes [[#7005](https://github.com/plotly/plotly.js/pull/7005)]
+ - Add property x_shift/y_shift for shapes/selections referencing (multi-)category axes [[#7005](https://github.com/plotly/plotly.js/pull/7005)]

src/components/selections/attributes.js

@@ -53,7 +53,28 @@ module.exports = overrideAll(templatedArray('selection', {
         valType: 'any',
         description: 'Sets the selection\'s end y position.'
     },
-
+    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: {
+        valType: 'number',
+        dflt: 0,
+        min: -0.5,
+        max: 0.5,
+        editType: 'calc',
+        description: [
+            'Only relevant if yref is a (multi-)category axes. Shifts y0 and y1 by a fraction of',
+            'the reference unit.'
+        ].join(' ')
+    },
     path: {
         valType: 'string',
         editType: 'arraydraw',

src/components/selections/defaults.js

@@ -49,6 +49,8 @@ function handleSelectionDefaults(selectionIn, selectionOut, fullLayout) {
     coerce('line.color');
     coerce('line.width');
     coerce('line.dash');
+    coerce('x_shift');
+    coerce('y_shift');
 
     // positioning
     var axLetters = ['x', 'y'];

test/image/mocks/zzz_shape_shift_vertical.json

@@ -51,6 +51,15 @@
                 "x_shift": -0.25,
                 "yref": "paper"
             }
+        ],
+        "selections": [
+            {
+                "x0": 0,
+                "x1": 4,
+                "y0": 1,
+                "y1": 3,
+                "x_shift": -0.5
+            }
         ]
     }
 }

test/plot-schema.json

@@ -9550,6 +9550,14 @@
         "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",
@@ -9569,6 +9577,14 @@
         "/^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.",
+       "dflt": 0,
+       "editType": "arraydraw",
+       "max": 0.5,
+       "min": -0.5,
+       "valType": "number"
+      },
       "y0": {
        "description": "Sets the selection's starting y position.",
        "editType": "arraydraw",