Remove shift properties from selection for now

plotly · archmoj · Jul 16, 2024 · May 27, 2024 · May 27, 2024 · May 27, 2024
commit b00d4d806fc2f1a531db414c53365032f537317a
diff --git a/draftlogs/7005_add.md b/draftlogs/7005_add.md
@@ -1 +1 @@
- - Add property x0shift, x1shift, y0shift, y1shift for shapes/selections referencing (multi-)category axes [[#7005](https://github.com/plotly/plotly.js/pull/7005)]
+ - Add property x0shift, x1shift, y0shift, y1shift for shapes referencing (multi-)category axes, with thanks to @my-tien for the contribution! [[#7005](https://github.com/plotly/plotly.js/pull/7005)]
diff --git a/src/components/selections/attributes.js b/src/components/selections/attributes.js
@@ -54,51 +54,6 @@ module.exports = overrideAll(templatedArray('selection', {
        description: 'Sets the selection\'s end y position.'
    },

-    x0shift: {
-        valType: 'number',
-        dflt: 0,
-        min: -1,
-        max: 1,
-        editType: 'calc',
-        description: [
-            'Only relevant if `xref` is a (multi-)category axes. Shifts `x0` by a fraction of the',
-            'reference unit. E.g. -0.5 corresponds to the start of the category and 0.5 corresponds to the end of the category.'
-        ].join(' ')
-    },
-    x1shift: {
-        valType: 'number',
-        dflt: 0,
-        min: -1,
-        max: 1,
-        editType: 'calc',
-        description: [
-            'Only relevant if `xref` is a (multi-)category axes. Shifts `x1` by a fraction of the',
-            'reference unit. E.g. -0.5 corresponds to the start of the category and 0.5 corresponds to the end of the category.'
-        ].join(' ')
-    },
-    y0shift: {
-        valType: 'number',
-        dflt: 0,
-        min: -1,
-        max: 1,
-        editType: 'calc',
-        description: [
-            'Only relevant if `yref` is a (multi-)category axes. Shifts `y0` by a fraction of the',
-            'reference unit. E.g. -0.5 corresponds to the start of the category and 0.5 corresponds to the end of the category.'
-        ].join(' ')
-    },
-    y1shift: {
-        valType: 'number',
-        dflt: 0,
-        min: -1,
-        max: 1,
-        editType: 'calc',
-        description: [
-            'Only relevant if `yref` is a (multi-)category axes. Shifts `y1` by a fraction of the',
-            'reference unit. E.g. -0.5 corresponds to the start of the category and 0.5 corresponds to the end of the category.'
-        ].join(' ')
-    },
-
    path: {
        valType: 'string',
        editType: 'arraydraw',

diff --git a/src/components/selections/defaults.js b/src/components/selections/defaults.js
@@ -70,11 +70,6 @@ function handleSelectionDefaults(selectionIn, selectionOut, fullLayout) {

        // Coerce x0, x1, y0, y1
        if(noPath) {
-            if(ax.type === 'category' || ax.type === 'multicategory') {
-                coerce(axLetter + '0shift');
-                coerce(axLetter + '1shift');
-            }
-
            // 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

diff --git a/src/components/shapes/helpers.js b/src/components/shapes/helpers.js
@@ -287,7 +287,7 @@ function convertPath(options, x2p, y2p) {
 function getPixelShift(axis, shift) {
    shift = shift || 0;
    var shiftPixels = 0;
-    if(axis) {
+    if(axis && shift) {
        var isVertical = axis._id.charAt(0) === 'y';
        if(axis.type === 'category' || axis.type === 'multicategory') {
            if(isVertical) {

diff --git a/test/image/mocks/zzz_shape_shift_vertical.json b/test/image/mocks/zzz_shape_shift_vertical.json
@@ -62,16 +62,6 @@
                "x1shift": -0.25,
                "yref": "paper"
            }
-        ],
-        "selections": [
-            {
-                "x0": 0,
-                "x1": 3,
-                "y0": 1,
-                "y1": 3,
-                "x0shift": -0.5,
-                "x1shift": 0.5
-            }
        ]
    }
 }
diff --git a/test/plot-schema.json b/test/plot-schema.json
@@ -9555,27 +9555,11 @@
       "editType": "arraydraw",
       "valType": "any"
      },
-      "x0shift": {
-       "description": "Only relevant if `xref` is a (multi-)category axes. Shifts `x0` by a fraction of the reference unit. E.g. -0.5 corresponds to the start of the category and 0.5 corresponds to the end of the category.",
-       "dflt": 0,
-       "editType": "arraydraw",
-       "max": 1,
-       "min": -1,
-       "valType": "number"
-      },
      "x1": {
       "description": "Sets the selection's end x position.",
       "editType": "arraydraw",
       "valType": "any"
      },
-      "x1shift": {
-       "description": "Only relevant if `xref` is a (multi-)category axes. Shifts `x1` by a fraction of the reference unit. E.g. -0.5 corresponds to the start of the category and 0.5 corresponds to the end of the category.",
-       "dflt": 0,
-       "editType": "arraydraw",
-       "max": 1,
-       "min": -1,
-       "valType": "number"
-      },
      "xref": {
       "description": "Sets the selection's x coordinate axis. If set to a x axis id (e.g. *x* or *x2*), the `x` position refers to a x coordinate. If set to *paper*, the `x` position refers to the distance from the left of the plotting area in normalized coordinates where *0* (*1*) corresponds to the left (right). If set to a x axis ID followed by *domain* (separated by a space), the position behaves like for *paper*, but refers to the distance in fractions of the domain length from the left of the domain of that axis: e.g., *x2 domain* refers to the domain of the second x  axis and a x position of 0.5 refers to the point between the left and the right of the domain of the second x axis.",
       "editType": "arraydraw",
@@ -9590,27 +9574,11 @@
       "editType": "arraydraw",
       "valType": "any"
      },
-      "y0shift": {
-       "description": "Only relevant if `yref` is a (multi-)category axes. Shifts `y0` by a fraction of the reference unit. E.g. -0.5 corresponds to the start of the category and 0.5 corresponds to the end of the category.",
-       "dflt": 0,
-       "editType": "arraydraw",
-       "max": 1,
-       "min": -1,
-       "valType": "number"
-      },
      "y1": {
       "description": "Sets the selection's end y position.",
       "editType": "arraydraw",
       "valType": "any"
      },
-      "y1shift": {
-       "description": "Only relevant if `yref` is a (multi-)category axes. Shifts `y1` by a fraction of the reference unit. E.g. -0.5 corresponds to the start of the category and 0.5 corresponds to the end of the category.",
-       "dflt": 0,
-       "editType": "arraydraw",
-       "max": 1,
-       "min": -1,
-       "valType": "number"
-      },
      "yref": {
       "description": "Sets the selection's x coordinate axis. If set to a y axis id (e.g. *y* or *y2*), the `y` position refers to a y coordinate. If set to *paper*, the `y` position refers to the distance from the bottom of the plotting area in normalized coordinates where *0* (*1*) corresponds to the bottom (top). If set to a y axis ID followed by *domain* (separated by a space), the position behaves like for *paper*, but refers to the distance in fractions of the domain length from the bottom of the domain of that axis: e.g., *y2 domain* refers to the domain of the second y  axis and a y position of 0.5 refers to the point between the bottom and the top of the domain of the second y axis.",
       "editType": "arraydraw",
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		- Add property x0shift, x1shift, y0shift, y1shift for shapes/selections referencing (multi-)category axes [[#7005](https://github.com/plotly/plotly.js/pull/7005)]
		- Add property x0shift, x1shift, y0shift, y1shift for shapes referencing (multi-)category axes, with thanks to @my-tien for the contribution! [[#7005](https://github.com/plotly/plotly.js/pull/7005)]
-Original file line number
+Diff line change
@@ -62,16 +62,6 @@
                     "x1shift": -0.25,
                     "yref": "paper"
                 }
             Copy link

  
      
    
  

  
      

  
    Contributor


      

  

  
    
      

      
            archmoj
  

      

      

      


        May 31, 2024


      
    

  


        
      
  
  
  
    

    There was a problem hiding this comment.


  

 
  
    

    Choose a reason for hiding this comment

    
      The reason will be displayed to describe this comment to others. Learn more.
    

    
      
      


  


  
    
      Is this also working for a path?
    
  
  


    

        
      
  
  
    
  
  
  
    
    Sorry, something went wrong.
  

  
    
  
    
      

              Uh oh!

              
There was an error while loading. Please reload this page.


  
  


          
      
  
    
    
      
        
            
    All reactions
  


          
          
        
      
    

    



  
        
  
    
        
    
  


      
          
  
      
            Copy link

  
      
    
  

  
      

  
    Contributor


      

  Author


  

  
    
      

      
            my-tien
  

      

      

      


        Jun 10, 2024


      
    

  


        
      
  
  
  
    

    There was a problem hiding this comment.


  

 
  
    

    Choose a reason for hiding this comment

    
      The reason will be displayed to describe this comment to others. Learn more.
    

    
      
      


  


  
    
      No, this should only do something when using x0, x1, y0, y1
    
  
  


    

        
      
  
  
    
  
  
  
    
    Sorry, something went wrong.
  

  
    
  
    
      

              Uh oh!

              
There was an error while loading. Please reload this page.


  
  


          
      
  
    
    
      
        
            
    All reactions
-            ],
-            "selections": [
-                {
-                    "x0": 0,
-                    "x1": 3,
-                    "y0": 1,
-                    "y1": 3,
-                    "x0shift": -0.5,
-                    "x1shift": 0.5
-                }
             ]
         }
     }