Fix 'reverse' -> 'reversed' everywhere, extend tests slightly

Author: wfr

src/traces/sankey/plot.js

@@ -194,13 +194,13 @@ module.exports = function plot(gd, calcData) {
                 hoverCenterY = (link.y0 + link.y1) / 2;
             }
             var vertical = link.trace.orientation === 'v';
-            var reverse = link.trace.direction === 'reverse';
+            var reversed = link.trace.direction === 'reversed';
             var center = [hoverCenterX, hoverCenterY];
             // Vertical orientation transposes x/y to match the group transform.
             if(vertical) center.reverse();
-            // reverse direction additionally mirrors the flow axis (matching the translate).
-            if(vertical && reverse) center[1] = d.parent.height - center[1];
-            if(!vertical && reverse) center[0] = d.parent.width - center[0];
+            // reversed direction additionally mirrors the flow axis (matching the translate).
+            if(vertical && reversed) center[1] = d.parent.height - center[1];
+            if(!vertical && reversed) center[0] = d.parent.width - center[0];
             center[0] += d.parent.translateX;
             center[1] += d.parent.translateY;
             return center;

src/traces/sankey/select.js

@@ -8,7 +8,7 @@ module.exports = function selectPoints(searchInfo, selectionTester) {
     var model = fullData._sankey;
     var nodes = model.graph.nodes;
     var vertical = fullData.orientation === 'v';
-    var reverse = fullData.direction === 'reverse';
+    var reversed = fullData.direction === 'reversed';
 
     for(var i = 0; i < nodes.length; i++) {
         var node = nodes[i];
@@ -20,14 +20,14 @@ module.exports = function selectPoints(searchInfo, selectionTester) {
 
         // Mirror/swap to match the group transform applied in render.js (sankeyTransform):
         //   h + forward:  (cx, cy)
-        //   h + reverse:  (width - cx, cy)     -> matrix(-1  0 0 1) + translate(width, 0)
+        //   h + reversed: (width - cx, cy)     -> matrix(-1  0 0 1) + translate(width, 0)
         //   v + forward:  (cy, cx)             -> matrix( 0  1 1 0)  (swap x/y)
-        //   v + reverse:  (cy, height - cx)    -> matrix( 0 -1 1 0) + translate(0, height)
+        //   v + reversed: (cy, height - cx)    -> matrix( 0 -1 1 0) + translate(0, height)
         var pos;
         if(vertical) {
-            pos = [cy, reverse ? model.height - cx : cx];
+            pos = [cy, reversed ? model.height - cx : cx];
         } else {
-            pos = [reverse ? model.width - cx : cx, cy];
+            pos = [reversed ? model.width - cx : cx, cy];
         }
 
         if(selectionTester && selectionTester.contains(pos, false, i, searchInfo)) {

test/jasmine/tests/sankey_test.js

@@ -979,10 +979,12 @@ describe('sankey tests', function () {
                 })
                 .then(done, done.fail);
         });
-
+        
         it('@noCI should position hover labels correctly - horizontal, reversed', function (done) {
             var gd = createGraphDiv();
             var forwardOffsetX;
+            var forwardPosY;
+            var forwardLinkLeft;
 
             function plotWith(direction) {
                 var fig = Lib.extendDeep({}, mock);
@@ -1001,6 +1003,8 @@ describe('sankey tests', function () {
                     var linkRect = rectForLink('Thermal generation', 'Losses');
                     var pos = d3Select('.hovertext').node().getBoundingClientRect();
                     forwardOffsetX = pos.x - (linkRect.left + linkRect.width / 2);
+                    forwardPosY = pos.y;
+                    forwardLinkLeft = linkRect.left;
 
                     return plotWith('reversed');
                 })
@@ -1029,13 +1033,29 @@ describe('sankey tests', function () {
                         -1.5,
                         'label offset from its link is direction-independent'
                     );
+
+                    // matrix(-1 0 0 1 0 0) mirrors along x only.
+                    expect(pos.y).toBeCloseTo(
+                        forwardPosY,
+                        -1.5,
+                        'y position is unaffected by direction'
+                    );
+
+                    // Guard against a vacuously passing test: the offset above is
+                    // only meaningful if the link actually moved.
+                    expect(Math.abs(linkRect.left - forwardLinkLeft)).toBeGreaterThan(
+                        50,
+                        'link is actually mirrored along x'
+                    );
                 })
                 .then(done, done.fail);
         });
 
         it('@noCI should position hover labels correctly - vertical, reversed', function (done) {
             var gd = createGraphDiv();
             var forwardOffsetY;
+            var forwardPosX;
+            var forwardLinkTop;
 
             function plotWith(direction) {
                 var fig = Lib.extendDeep({}, mock);
@@ -1050,6 +1070,8 @@ describe('sankey tests', function () {
                     var linkRect = rectForLink('Thermal generation', 'Losses');
                     var pos = d3Select('.hovertext').node().getBoundingClientRect();
                     forwardOffsetY = pos.y - (linkRect.top + linkRect.height / 2);
+                    forwardPosX = pos.x;
+                    forwardLinkTop = linkRect.top;
 
                     return plotWith('reversed');
                 })
@@ -1070,6 +1092,19 @@ describe('sankey tests', function () {
                         -1.5,
                         'label offset from its link is direction-independent'
                     );
+
+                    // matrix(0 -1 1 0 0 0) maps data y to screen x (unmirrored)
+                    // and mirrors along screen y only.
+                    expect(pos.x).toBeCloseTo(
+                        forwardPosX,
+                        -1.5,
+                        'x position is unaffected by direction'
+                    );
+
+                    expect(Math.abs(linkRect.top - forwardLinkTop)).toBeGreaterThan(
+                        50,
+                        'link is actually mirrored along y'
+                    );
                 })
                 .then(done, done.fail);
         });