rename zindex to zorder

archmoj · archmoj · commit efcd49fcac31 · 2024-04-09T13:48:35.000-04:00
diff --git a/draftlogs/6918_add.md b/draftlogs/6918_add.md
@@ -1 +1 @@
-- Add a new attribute `zindex` to SVG based Cartesian traces (not to WebGL traces). Traces with higher `zindex` values are drawn in front of traces with lower `zindex` values. This feature was anonymously sponsored: thank you to our sponsor!
+- Add a new attribute `zorder` to SVG based Cartesian traces (not to WebGL traces). Traces with higher `zorder` values are drawn in front of traces with lower `zorder` values. This feature was anonymously sponsored: thank you to our sponsor!
diff --git a/src/plots/cartesian/index.js b/src/plots/cartesian/index.js
@@ -195,25 +195,25 @@ function plotOne(gd, plotinfo, cdSubplot, transitionOpts, makeOnCompleteCallback
     var modules = fullLayout._modules;
     var _module, cdModuleAndOthers, cdModule;
 
-    // Separate traces by zindex and plot each zindex group separately
+    // Separate traces by zorder and plot each zorder group separately
     // TODO: Performance
-    var traceZindexGroups = {};
+    var traceZorderGroups = {};
     for(var t = 0; t < cdSubplot.length; t++) {
         var trace = cdSubplot[t][0].trace;
-        var zi = trace.zindex || 0;
-        if(!traceZindexGroups[zi]) traceZindexGroups[zi] = [];
-        traceZindexGroups[zi].push(cdSubplot[t]);
+        var zi = trace.zorder || 0;
+        if(!traceZorderGroups[zi]) traceZorderGroups[zi] = [];
+        traceZorderGroups[zi].push(cdSubplot[t]);
     }
 
     var layerData = [];
     var zoomScaleQueryParts = [];
 
-    // Plot each zindex group in ascending order
-    var zindices = Object.keys(traceZindexGroups)
+    // Plot each zorder group in ascending order
+    var zindices = Object.keys(traceZorderGroups)
         .map(Number)
         .sort(Lib.sorterAsc);
     for(var z = 0; z < zindices.length; z++) {
-        var zindex = zindices[z];
+        var zorder = zindices[z];
         // For each "module" (trace type)
         for(var i = 0; i < modules.length; i++) {
             _module = modules[i];
@@ -225,7 +225,7 @@ function plotOne(gd, plotinfo, cdSubplot, transitionOpts, makeOnCompleteCallback
                 var plotMethod = _module.plot;
 
                 // plot all visible traces of this type on this subplot at once
-                cdModuleAndOthers = getModuleCalcData(cdSubplot, plotMethod, zindex);
+                cdModuleAndOthers = getModuleCalcData(cdSubplot, plotMethod, zorder);
                 cdModule = cdModuleAndOthers[0];
                 // don't need to search the found traces again - in fact we need to NOT
                 // so that if two modules share the same plotter we don't double-plot
@@ -234,7 +234,7 @@ function plotOne(gd, plotinfo, cdSubplot, transitionOpts, makeOnCompleteCallback
                 if(cdModule.length) {
                     layerData.push({
                         i: traceLayerClasses.indexOf(className),
-                        zindex: z,
+                        zorder: z,
                         className: className,
                         plotMethod: plotMethod,
                         cdModule: cdModule
@@ -248,7 +248,7 @@ function plotOne(gd, plotinfo, cdSubplot, transitionOpts, makeOnCompleteCallback
         }
     }
     // Sort the layers primarily by z, then by i
-    layerData.sort(function(a, b) { return (a.zindex || 0) - (b.zindex || 0) || a.i - b.i; });
+    layerData.sort(function(a, b) { return (a.zorder || 0) - (b.zorder || 0) || a.i - b.i; });
 
     var layers = plotinfo.plot.selectAll('g.mlayer')
         .data(layerData, function(d) { return d.className; });
diff --git a/src/plots/get_data.js b/src/plots/get_data.js
@@ -39,7 +39,7 @@ exports.getSubplotCalcData = function(calcData, type, subplotId) {
  * @param {array} calcdata: as in gd.calcdata
  * @param {object|string|fn} arg1:
  *  the plotting module, or its name, or its plot method
- * @param {int} arg2: (optional) zindex to filter on
+ * @param {int} arg2: (optional) zorder to filter on
  * @return {array[array]} [foundCalcdata, remainingCalcdata]
  */
 exports.getModuleCalcData = function(calcdata, arg1, arg2) {
@@ -57,12 +57,12 @@ exports.getModuleCalcData = function(calcdata, arg1, arg2) {
     if(!plotMethod) {
         return [moduleCalcData, calcdata];
     }
-    var zindex = arg2;
+    var zorder = arg2;
 
     for(var i = 0; i < calcdata.length; i++) {
         var cd = calcdata[i];
         var trace = cd[0].trace;
-        var filterByZ = (trace.zindex !== undefined);
+        var filterByZ = (trace.zorder !== undefined);
         // N.B.
         // - 'legendonly' traces do not make it past here
         // - skip over 'visible' traces that got trimmed completely during calc transforms
@@ -72,7 +72,7 @@ exports.getModuleCalcData = function(calcdata, arg1, arg2) {
         // would suggest), but by 'module plot method' so that if some traces
         // share the same module plot method (e.g. bar and histogram), we
         // only call it one!
-        if(trace._module && trace._module.plot === plotMethod && (!filterByZ || trace.zindex === zindex)) {
+        if(trace._module && trace._module.plot === plotMethod && (!filterByZ || trace.zorder === zorder)) {
             moduleCalcData.push(cd);
         } else {
             remainingCalcData.push(cd);
diff --git a/src/traces/bar/attributes.js b/src/traces/bar/attributes.js
@@ -226,7 +226,7 @@ module.exports = {
         textfont: scatterAttrs.unselected.textfont,
         editType: 'style'
     },
-    zindex: scatterAttrs.zindex,
+    zorder: scatterAttrs.zorder,
 
     _deprecated: {
         bardir: {
diff --git a/src/traces/bar/defaults.js b/src/traces/bar/defaults.js
@@ -29,7 +29,7 @@ function supplyDefaults(traceIn, traceOut, defaultColor, layout) {
     coerce('xhoverformat');
     coerce('yhoverformat');
 
-    coerce('zindex');
+    coerce('zorder');
 
     coerce('orientation', (traceOut.x && !traceOut.y) ? 'h' : 'v');
     coerce('base');
diff --git a/src/traces/box/attributes.js b/src/traces/box/attributes.js
@@ -452,5 +452,5 @@ module.exports = {
             'or sample points or both?'
         ].join(' ')
     },
-    zindex: scatterAttrs.zindex
+    zorder: scatterAttrs.zorder
 };
diff --git a/src/traces/box/defaults.js b/src/traces/box/defaults.js
@@ -67,7 +67,7 @@ function supplyDefaults(traceIn, traceOut, defaultColor, layout) {
     if(notched) coerce('notchwidth');
 
     handlePointsDefaults(traceIn, traceOut, coerce, {prefix: 'box'});
-    coerce('zindex');
+    coerce('zorder');
 }
 
 function handleSampleDefaults(traceIn, traceOut, coerce, layout) {
diff --git a/src/traces/candlestick/attributes.js b/src/traces/candlestick/attributes.js
@@ -53,5 +53,5 @@ module.exports = {
     whiskerwidth: extendFlat({}, boxAttrs.whiskerwidth, { dflt: 0 }),
 
     hoverlabel: OHLCattrs.hoverlabel,
-    zindex: boxAttrs.zindex
+    zorder: boxAttrs.zorder
 };
diff --git a/src/traces/candlestick/defaults.js b/src/traces/candlestick/defaults.js
@@ -31,7 +31,7 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
     coerce('whiskerwidth');
 
     layout._requestRangeslider[traceOut.xaxis] = true;
-    coerce('zindex');
+    coerce('zorder');
 };
 
 function handleDirection(traceIn, traceOut, coerce, direction) {
diff --git a/src/traces/carpet/attributes.js b/src/traces/carpet/attributes.js
@@ -9,7 +9,7 @@ var carpetFont = fontAttrs({
     description: 'The default font used for axis & tick labels on this carpet'
 });
 
-var zindex = require('../scatter/attributes').zindex;
+var zorder = require('../scatter/attributes').zorder;
 
 // TODO: inherit from global font
 carpetFont.family.dflt = '"Open Sans", verdana, arial, sans-serif';
@@ -116,5 +116,5 @@ module.exports = {
         ].join(' ')
     },
     transforms: undefined,
-    zindex: zindex
+    zorder: zorder
 };
diff --git a/src/traces/carpet/defaults.js b/src/traces/carpet/defaults.js
@@ -45,5 +45,5 @@ module.exports = function supplyDefaults(traceIn, traceOut, dfltColor, fullLayou
     if(traceOut._cheater) {
         coerce('cheaterslope');
     }
-    coerce('zindex');
+    coerce('zorder');
 };
diff --git a/src/traces/contour/attributes.js b/src/traces/contour/attributes.js
@@ -266,7 +266,7 @@ module.exports = extendFlat({
         }),
         editType: 'plot'
     },
-    zindex: scatterAttrs.zindex
+    zorder: scatterAttrs.zorder
 },
     colorScaleAttrs('', {
         cLetter: 'z',
diff --git a/src/traces/contour/defaults.js b/src/traces/contour/defaults.js
@@ -51,5 +51,5 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
     ) {
         handleHeatmapLabelDefaults(coerce, layout);
     }
-    coerce('zindex');
+    coerce('zorder');
 };
diff --git a/src/traces/contourcarpet/attributes.js b/src/traces/contourcarpet/attributes.js
@@ -70,7 +70,7 @@ module.exports = extendFlat({
         editType: 'plot'
     },
 
-    zindex: contourAttrs.zindex,
+    zorder: contourAttrs.zorder,
     transforms: undefined
 },
 
diff --git a/src/traces/contourcarpet/defaults.js b/src/traces/contourcarpet/defaults.js
@@ -55,5 +55,5 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
         traceOut._defaultColor = defaultColor;
         traceOut._length = null;
     }
-    coerce('zindex');
+    coerce('zorder');
 };
diff --git a/src/traces/funnel/attributes.js b/src/traces/funnel/attributes.js
@@ -110,7 +110,7 @@ module.exports = {
 
     offsetgroup: barAttrs.offsetgroup,
     alignmentgroup: barAttrs.alignmentgroup,
-    zindex: barAttrs.zindex
+    zorder: barAttrs.zorder
 };
 
 function funnelMarker() {
diff --git a/src/traces/funnel/defaults.js b/src/traces/funnel/defaults.js
@@ -61,7 +61,7 @@ function supplyDefaults(traceIn, traceOut, defaultColor, layout) {
             coerce('connector.line.dash');
         }
     }
-    coerce('zindex');
+    coerce('zorder');
 }
 
 function defaultFillColor(markerColor) {
diff --git a/src/traces/heatmap/attributes.js b/src/traces/heatmap/attributes.js
@@ -133,7 +133,7 @@ module.exports = extendFlat({
     }),
 
     showlegend: extendFlat({}, baseAttrs.showlegend, {dflt: false}),
-    zindex: scatterAttrs.zindex
+    zorder: scatterAttrs.zorder
 }, {
     transforms: undefined
 },
diff --git a/src/traces/heatmap/defaults.js b/src/traces/heatmap/defaults.js
@@ -36,5 +36,5 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
     coerce('connectgaps', Lib.isArray1D(traceOut.z) && (traceOut.zsmooth !== false));
 
     colorscaleDefaults(traceIn, traceOut, layout, coerce, {prefix: '', cLetter: 'z'});
-    coerce('zindex');
+    coerce('zorder');
 };
diff --git a/src/traces/histogram/attributes.js b/src/traces/histogram/attributes.js
@@ -250,5 +250,5 @@ module.exports = {
         bardir: barAttrs._deprecated.bardir
     },
 
-    zindex: barAttrs.zindex
+    zorder: barAttrs.zorder
 };
diff --git a/src/traces/histogram/defaults.js b/src/traces/histogram/defaults.js
@@ -75,5 +75,5 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
     errorBarsSupplyDefaults(traceIn, traceOut, lineColor || Color.defaultLine, {axis: 'y'});
     errorBarsSupplyDefaults(traceIn, traceOut, lineColor || Color.defaultLine, {axis: 'x', inherit: 'y'});
 
-    coerce('zindex');
+    coerce('zorder');
 };
diff --git a/src/traces/image/attributes.js b/src/traces/image/attributes.js
@@ -1,7 +1,7 @@
 'use strict';
 
 var baseAttrs = require('../../plots/attributes');
-var zindex = require('../scatter/attributes').zindex;
+var zorder = require('../scatter/attributes').zorder;
 var hovertemplateAttrs = require('../../plots/template_attributes').hovertemplateAttrs;
 var extendFlat = require('../../lib/extend').extendFlat;
 var colormodel = require('./constants').colormodel;
@@ -134,6 +134,6 @@ module.exports = extendFlat({
         keys: ['z', 'color', 'colormodel']
     }),
 
-    zindex: zindex,
+    zorder: zorder,
     transforms: undefined
 });
diff --git a/src/traces/image/defaults.js b/src/traces/image/defaults.js
@@ -46,5 +46,5 @@ module.exports = function supplyDefaults(traceIn, traceOut) {
 
     traceOut._length = null;
 
-    coerce('zindex');
+    coerce('zorder');
 };
diff --git a/src/traces/ohlc/attributes.js b/src/traces/ohlc/attributes.js
@@ -134,5 +134,5 @@ module.exports = {
         }
     }),
 
-    zindex: scatterAttrs.zindex
+    zorder: scatterAttrs.zorder
 };
diff --git a/src/traces/ohlc/defaults.js b/src/traces/ohlc/defaults.js
@@ -32,7 +32,7 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
 
     layout._requestRangeslider[traceOut.xaxis] = true;
 
-    coerce('zindex');
+    coerce('zorder');
 };
 
 function handleDirection(traceIn, traceOut, coerce, direction) {
diff --git a/src/traces/scatter/attributes.js b/src/traces/scatter/attributes.js
@@ -686,14 +686,14 @@ module.exports = {
         arrayOk: true,
         description: 'Sets the text font.'
     }),
-    zindex: {
+    zorder: {
         valType: 'integer',
         dflt: 0,
         editType: 'plot',
         description: [
             'Sets the layer on which this trace is displayed, relative to',
-            'other SVG traces on the same subplot. SVG traces with higher `zindex`',
-            'appear in front of those with lower `zindex`.'
+            'other SVG traces on the same subplot. SVG traces with higher `zorder`',
+            'appear in front of those with lower `zorder`.'
         ].join(' ')
     }
 };
diff --git a/src/traces/scatter/defaults.js b/src/traces/scatter/defaults.js
@@ -30,7 +30,7 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
     coerce('xhoverformat');
     coerce('yhoverformat');
 
-    coerce('zindex');
+    coerce('zorder');
 
     var stackGroupOpts = handleStackDefaults(traceIn, traceOut, layout, coerce);
     if(
diff --git a/src/traces/scattercarpet/attributes.js b/src/traces/scattercarpet/attributes.js
@@ -119,5 +119,5 @@ module.exports = {
     }),
     hoveron: scatterAttrs.hoveron,
     hovertemplate: hovertemplateAttrs(),
-    zindex: scatterAttrs.zindex
+    zorder: scatterAttrs.zorder
 };
diff --git a/src/traces/scattercarpet/defaults.js b/src/traces/scattercarpet/defaults.js
@@ -75,6 +75,6 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
     var hoverOn = coerce('hoveron', dfltHoverOn.join('+') || 'points');
     if(hoverOn !== 'fills') coerce('hovertemplate');
 
-    coerce('zindex');
+    coerce('zorder');
     Lib.coerceSelectionMarkerOpacity(traceOut, coerce);
 };
diff --git a/src/traces/violin/attributes.js b/src/traces/violin/attributes.js
@@ -255,5 +255,5 @@ module.exports = {
             'or sample points or the kernel density estimate or any combination of them?'
         ].join(' ')
     },
-    zindex: boxAttrs.zindex
+    zorder: boxAttrs.zorder
 };
diff --git a/src/traces/violin/defaults.js b/src/traces/violin/defaults.js
@@ -50,5 +50,5 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
     if(!meanLineVisible) traceOut.meanline = {visible: false};
 
     coerce('quartilemethod');
-    coerce('zindex');
+    coerce('zorder');
 };
diff --git a/src/traces/waterfall/attributes.js b/src/traces/waterfall/attributes.js
@@ -152,5 +152,5 @@ module.exports = {
 
     offsetgroup: barAttrs.offsetgroup,
     alignmentgroup: barAttrs.alignmentgroup,
-    zindex: barAttrs.zindex
+    zorder: barAttrs.zorder
 };
diff --git a/src/traces/waterfall/defaults.js b/src/traces/waterfall/defaults.js
@@ -76,7 +76,7 @@ function supplyDefaults(traceIn, traceOut, defaultColor, layout) {
             coerce('connector.line.dash');
         }
     }
-    coerce('zindex');
+    coerce('zorder');
 }
 
 function crossTraceDefaults(fullData, fullLayout) {
diff --git a/test/image/baselines/zindex_funnel_carpet_waterfall.png b/test/image/baselines/zindex_funnel_carpet_waterfall.png
diff --git a/test/image/baselines/zindex_violin_box.png b/test/image/baselines/zindex_violin_box.png
diff --git a/test/image/baselines/zz-zorder-contour.png b/test/image/baselines/zz-zorder-contour.png
diff --git a/test/image/baselines/zz-zorder-heatmap.png b/test/image/baselines/zz-zorder-heatmap.png
diff --git a/test/image/baselines/zz-zorder-scatter-image.png b/test/image/baselines/zz-zorder-scatter-image.png
diff --git a/test/image/baselines/zz-zorder_basic.png b/test/image/baselines/zz-zorder_basic.png
diff --git a/test/image/baselines/zz-zorder_funnel_carpet_waterfall.png b/test/image/baselines/zz-zorder_funnel_carpet_waterfall.png
diff --git a/test/image/baselines/zz-zorder_violin_box.png b/test/image/baselines/zz-zorder_violin_box.png
diff --git a/test/image/mocks/funnel_axis_with_other_traces.json b/test/image/mocks/funnel_axis_with_other_traces.json
@@ -22,7 +22,7 @@
             "x": [
                 1, 1, 1, 2, 2, 3
             ],
-            "zindex": -10
+            "zorder": -10
         },
         {
             "type": "funnel",
@@ -42,7 +42,7 @@
             ],
             "xaxis": "x2",
             "yaxis": "y2",
-            "zindex": 10
+            "zorder": 10
         },
         {
             "type": "bar",
diff --git a/test/image/mocks/zz-zorder-contour.json b/test/image/mocks/zz-zorder-contour.json
@@ -5,15 +5,15 @@
         "name": "scatter",
         "y": [-1,0,1,2,3],
         "x": [-1,0,1,2,3],
-        "zindex": 1
+        "zorder": 1
     }, {
         "type": "contour",
         "z": [
             [1, 2, 3],
             [2, 0, 0],
             [3, 0, 3]
         ],
-        "zindex": 10
+        "zorder": 10
     }
 ],
     "layout": {
diff --git a/test/image/mocks/zz-zorder-heatmap.json b/test/image/mocks/zz-zorder-heatmap.json
diff --git a/test/image/mocks/zz-zorder-scatter-image.json b/test/image/mocks/zz-zorder-scatter-image.json
diff --git a/test/image/mocks/zz-zorder_basic.json b/test/image/mocks/zz-zorder_basic.json
diff --git a/test/image/mocks/zz-zorder_funnel_carpet_waterfall.json b/test/image/mocks/zz-zorder_funnel_carpet_waterfall.json
diff --git a/test/image/mocks/zz-zorder_violin_box.json b/test/image/mocks/zz-zorder_violin_box.json
diff --git a/test/jasmine/tests/cartesian_interact_test.js b/test/jasmine/tests/cartesian_interact_test.js
diff --git a/test/jasmine/tests/select_test.js b/test/jasmine/tests/select_test.js
diff --git a/test/plot-schema.json b/test/plot-schema.json

Original file line number	Diff line number	Diff line change
`@@ -67,7 +67,7 @@ function supplyDefaults(traceIn, traceOut, defaultColor, layout) {`
`67`	`67`	`if(notched) coerce('notchwidth');`
`68`	`68`
`69`	`69`	`handlePointsDefaults(traceIn, traceOut, coerce, {prefix: 'box'});`
`70`		`- coerce('zindex');`
	`70`	`+ coerce('zorder');`
`71`	`71`	`}`
`72`	`72`
`73`	`73`	`function handleSampleDefaults(traceIn, traceOut, coerce, layout) {`