Rename "belowtraces" to "between"

Author: my-tien

draftlogs/6927_add.md

@@ -1 +1 @@
- - Add `belowtraces` shape layer [[#6927](https://github.com/plotly/plotly.js/pull/6927)]
+ - Add `between` shape layer [[#6927](https://github.com/plotly/plotly.js/pull/6927)]

src/components/shapes/attributes.js

@@ -110,10 +110,10 @@ module.exports = templatedArray('shape', {
 
     layer: {
         valType: 'enumerated',
-        values: ['below', 'above', 'belowtraces'],
+        values: ['below', 'above', 'between'],
         dflt: 'above',
         editType: 'arraydraw',
-        description: 'Specifies whether shapes are drawn below gridlines (*below*), between gridlines and traces (*belowtraces*) or above traces (*above*).'
+        description: 'Specifies whether shapes are drawn below gridlines (*below*), between gridlines and traces (*between*) or above traces (*above*).'
     },
 
     xref: extendFlat({}, annAttrs.xref, {

src/components/shapes/draw.js

@@ -95,8 +95,8 @@ function drawOne(gd, index) {
         drawShape(gd._fullLayout._shapeUpperLayer);
     } else if(options.xref === 'paper' || options.yref === 'paper') {
         drawShape(gd._fullLayout._shapeLowerLayer);
-    } else if(options.layer === 'belowtraces') {
-        drawShape(plotinfo.shapelayerBelowTraces);
+    } else if(options.layer === 'between') {
+        drawShape(plotinfo.shapelayerBetween);
     } else {
         if(plotinfo._hadPlotinfo) {
             var mainPlot = plotinfo.mainplotinfo || plotinfo;

src/plots/cartesian/index.js

@@ -465,9 +465,9 @@ function makeSubplotLayer(gd, plotinfo) {
             plotinfo.gridlayer = ensureSingle(plotgroup, 'g', 'gridlayer');
             plotinfo.zerolinelayer = ensureSingle(plotgroup, 'g', 'zerolinelayer');
 
-            var belowTracesLayer = ensureSingle(plotgroup, 'g', 'layer-below-traces');
-            plotinfo.shapelayerBelowTraces = ensureSingle(belowTracesLayer, 'g', 'shapelayer');
-            plotinfo.imagelayerBelowTraces = ensureSingle(belowTracesLayer, 'g', 'imagelayer');
+            var betweenLayer = ensureSingle(plotgroup, 'g', 'layer-between');
+            plotinfo.shapelayerBetween = ensureSingle(betweenLayer, 'g', 'shapelayer');
+            plotinfo.imagelayerBetween = ensureSingle(betweenLayer, 'g', 'imagelayer');
 
             ensureSingle(plotgroup, 'path', 'xlines-below');
             ensureSingle(plotgroup, 'path', 'ylines-below');

test/image/mocks/zz-shapes_layer_below_traces.json

@@ -73,7 +73,7 @@
       {
         "name": "blue rect",
         "fillcolor": "rgba(108,173,225,0.8)",
-        "layer": "belowtraces",
+        "layer": "between",
         "line": {
           "color": "rgba(108,173,225,0.8)"
         },
@@ -102,7 +102,7 @@
       {
         "name": "dashed rect",
         "fillcolor": "rgba(130,143,198,1)",
-        "layer": "belowtraces",
+        "layer": "between",
         "line": {
           "color": "rgba(0,0,0,1)",
           "dash": "dash",

test/plot-schema.json

@@ -7708,14 +7708,14 @@
        }
       },
       "layer": {
-       "description": "Specifies whether shapes are drawn below gridlines (*below*), between gridlines and traces (*belowtraces*) or above traces (*above*).",
+       "description": "Specifies whether shapes are drawn below gridlines (*below*), between gridlines and traces (*between*) or above traces (*above*).",
        "dflt": "above",
        "editType": "arraydraw",
        "valType": "enumerated",
        "values": [
         "below",
         "above",
-        "belowtraces"
+        "between"
        ]
       },
       "legend": {