Merge pull request #7870 from wf-r/Add_bottom-up_and_right-left_orientation_for_Sankey

Add directions attribute for Sankey diagrams

Author: camdecoster

draftlogs/7870_add.md

@@ -0,0 +1,3 @@
+- Add `direction` attribute to the Sankey trace, controlling the flow direction along the `orientation` axis [[#7870](https://github.com/plotly/plotly.js/pull/7870)], with thanks to @wf-r for the contribution!
+  - `forward` keeps sources on the left (horizontal) or top (vertical)
+  - `reversed` moves them to the right or bottom

src/traces/sankey/attributes.js

@@ -33,7 +33,23 @@ var attrs = (module.exports = overrideAll(
             valType: 'enumerated',
             values: ['v', 'h'],
             dflt: 'h',
-            description: 'Sets the orientation of the Sankey diagram.'
+            description: [
+                'Sets the orientation of the Sankey diagram.',
+                'With `h` (the default), the flow runs horizontally.',
+                'With `v`, the flow runs vertically.',
+                'Use `direction` to control which side the sources are placed on.'
+            ].join(' ')
+        },
+
+        direction: {
+            valType: 'enumerated',
+            values: ['forward', 'reversed'],
+            dflt: 'forward',
+            description: [
+                'Sets the direction of the flow along the `orientation` axis.',
+                'With `forward` (the default), sources are on the left (horizontal) or top (vertical).',
+                'With `reversed`, sources are on the right (horizontal) or bottom (vertical).',
+            ].join(' ')
         },
 
         valueformat: {

src/traces/sankey/defaults.js

@@ -101,6 +101,7 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
     handleDomainDefaults(traceOut, layout, coerce);
 
     coerce('orientation');
+    coerce('direction');
     coerce('valueformat');
     coerce('valuesuffix');
 

src/traces/sankey/plot.js

@@ -193,8 +193,14 @@ module.exports = function plot(gd, calcData) {
                 hoverCenterX = (link.source.x1 + link.target.x0) / 2;
                 hoverCenterY = (link.y0 + link.y1) / 2;
             }
+            var vertical = link.trace.orientation === 'v';
+            var reversed = link.trace.direction === 'reversed';
             var center = [hoverCenterX, hoverCenterY];
-            if(link.trace.orientation === 'v') center.reverse();
+            // Vertical orientation transposes x/y to match the group transform.
+            if(vertical) center.reverse();
+            // 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/render.js

@@ -32,6 +32,9 @@ function sankeyModel(layout, d, traceIndex) {
     var trace = calcData.trace;
     var domain = trace.domain;
     var horizontal = trace.orientation === 'h';
+    // reversed flips the source side along the flow axis: horizontal -> sources on the
+    // right (flow leftward), vertical -> sources at the bottom (flow upward).
+    var reversed = trace.direction === 'reversed';
     var nodePad = trace.node.pad;
     var nodeThickness = trace.node.thickness;
     var nodeAlign = {
@@ -285,6 +288,7 @@ function sankeyModel(layout, d, traceIndex) {
         trace: trace,
         guid: Lib.randstr(),
         horizontal: horizontal,
+        reversed: reversed,
         width: width,
         height: height,
         nodePad: trace.node.pad,
@@ -588,6 +592,7 @@ function nodeModel(d, n) {
         sizeAcross: d.width,
         forceLayouts: d.forceLayouts,
         horizontal: d.horizontal,
+        reversed: d.reversed,
         darkBackground: Color.color(n.color).isDark(),
         rgb: Color.rgb(n.color),
         alpha: Color.color(n.color).alpha(),
@@ -629,8 +634,21 @@ function sizeNode(rect) {
 function salientEnough(d) {return (d.link.width > 1 || d.linkLineWidth > 0);}
 
 function sankeyTransform(d) {
-    var offset = strTranslate(d.translateX, d.translateY);
-    return offset + (d.horizontal ? 'matrix(1 0 0 1 0 0)' : 'matrix(0 1 1 0 0 0)');
+    if(d.horizontal) {
+        if(d.reversed) {
+            // horizontal + reversed: sources on the right, flow leftward; a mirror of forward.
+            return strTranslate(d.translateX + d.width, d.translateY) + 'matrix(-1 0 0 1 0 0)';
+        }
+        // horizontal + forward: sources on the left, flow rightward.
+        return strTranslate(d.translateX, d.translateY) + 'matrix(1 0 0 1 0 0)';
+    }
+    if(d.reversed) {
+        // vertical + reversed: sources at the bottom, flow upward; a mirror of forward.
+        // Pure 90deg rotation (det +1) keeps the cross axis intact.
+        return strTranslate(d.translateX, d.translateY + d.height) + 'matrix(0 -1 1 0 0 0)';
+    }
+    // vertical + forward: reflection about y=x, sources at the top, flow downward.
+    return strTranslate(d.translateX, d.translateY) + 'matrix(0 1 1 0 0 0)';
 }
 
 // event handling
@@ -1049,7 +1067,10 @@ module.exports = function(gd, svg, calcData, layout, callbacks) {
             svgTextUtils.convertToTspans(e, gd);
         })
         .attr('text-anchor', function(d) {
-            return (d.horizontal && d.left) ? 'end' : 'start';
+            // horizontal: aligned to the outer edge (reversed flips which side is outer).
+            // vertical: inside-node placement, anchored at 'start'.
+            if(!d.horizontal) return 'start';
+            return (d.left !== d.reversed) ? 'end' : 'start';
         })
         .attr('transform', function(d) {
             var e = d3.select(this);
@@ -1059,27 +1080,35 @@ module.exports = function(gd, svg, calcData, layout, callbacks) {
                 (nLines - 1) * LINE_SPACING - CAP_SHIFT
             );
 
-            var posX = d.nodeLineWidth / 2 + TEXTPAD;
-            var posY = ((d.horizontal ? d.visibleHeight : d.visibleWidth) - blockHeight) / 2;
-            if(d.horizontal) {
-                if(d.left) {
-                    posX = -posX;
-                } else {
-                    posX += d.visibleWidth;
-                }
+            var pad = d.nodeLineWidth / 2 + TEXTPAD;
+
+            if(!d.horizontal) {
+                // vertical: label sits inside the node, centered along its length. 
+                // forward's local flip (scale(-1,1) + rotate(90)) is a reflection, 
+                // reversed's (rotate(90) alone) a pure rotation; the group
+                // matrix has the same opposing handedness. That flips the sign with which
+                // the CAP_SHIFT baseline correction (baked into blockHeight) lands on
+                // screen, so it must be applied with the opposite sign for reversed -
+                // otherwise the label renders about half a line height too high.
+                var posY = d.reversed
+                    ? (d.visibleWidth + blockHeight) / 2
+                    : (d.visibleWidth - blockHeight) / 2;
+                var flipV = d.reversed ? strRotate(90) : ('scale(-1,1)' + strRotate(90));
+                return strTranslate(posY, pad) + flipV;
             }
 
-            var flipText = d.horizontal ? '' : (
-                'scale(-1,1)' + strRotate(90)
-            );
-
-            return strTranslate(
-                d.horizontal ? posX : posY,
-                d.horizontal ? posY : posX
-            ) + flipText;
+            // horizontal: center along the node length, place just past the thickness edge.
+            var posX = pad;
+            var posY = (d.visibleHeight - blockHeight) / 2;
+            if(d.left) {
+                posX = -posX;
+            } else {
+                posX += d.visibleWidth;
+            }
+            return strTranslate(posX, posY) + (d.reversed ? 'scale(-1,1)' : '');
         });
 
     nodeLabel
         .transition()
         .ease(c.ease).duration(c.duration);
-};
+};

src/traces/sankey/select.js

@@ -5,17 +5,30 @@ module.exports = function selectPoints(searchInfo, selectionTester) {
     var selection = [];
     var fullData = cd[0].trace;
 
-    var nodes = fullData._sankey.graph.nodes;
+    var model = fullData._sankey;
+    var nodes = model.graph.nodes;
+    var vertical = fullData.orientation === 'v';
+    var reversed = fullData.direction === 'reversed';
 
     for(var i = 0; i < nodes.length; i++) {
         var node = nodes[i];
         if(node.partOfGroup) continue; // Those are invisible
 
-        // Position of node's centroid
-        var pos = [(node.x0 + node.x1) / 2, (node.y0 + node.y1) / 2];
+        // Position of node's centroid in the layout frame
+        var cx = (node.x0 + node.x1) / 2;
+        var cy = (node.y0 + node.y1) / 2;
 
-        // Swap x and y if trace is vertical
-        if(fullData.orientation === 'v') pos.reverse();
+        // Mirror/swap to match the group transform applied in render.js (sankeyTransform):
+        //   h + forward:  (cx, cy)
+        //   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 + reversed: (cy, height - cx)    -> matrix( 0 -1 1 0) + translate(0, height)
+        var pos;
+        if(vertical) {
+            pos = [cy, reversed ? model.height - cx : cx];
+        } else {
+            pos = [reversed ? model.width - cx : cx, cy];
+        }
 
         if(selectionTester && selectionTester.contains(pos, false, i, searchInfo)) {
             selection.push({

src/types/generated/schema.d.ts

@@ -6901,6 +6901,11 @@ export interface SankeyData {
     arrangement?: 'snap' | 'perpendicular' | 'freeform' | 'fixed';
     /** Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, *scatter* traces also appends customdata items in the markers DOM elements */
     customdata?: Datum[] | Datum[][] | TypedArray;
+    /**
+     * Sets the direction of the flow along the `orientation` axis. With `forward` (the default), sources are on the left (horizontal) or top (vertical). With `reversed`, sources are on the right (horizontal) or bottom (vertical).
+     * @default 'forward'
+     */
+    direction?: 'forward' | 'reversed';
     domain?: Domain;
     /**
      * Determines what trace information appears on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired. Note that this attribute is superseded by `node.hoverinfo` and `node.hoverinfo` for nodes and links respectively.
@@ -7073,7 +7078,7 @@ export interface SankeyData {
         y?: Datum[] | Datum[][] | TypedArray;
     };
     /**
-     * Sets the orientation of the Sankey diagram.
+     * Sets the orientation of the Sankey diagram. With `h` (the default), the flow runs horizontally. With `v`, the flow runs vertically. Use `direction` to control which side the sources are placed on.
      * @default 'h'
      */
     orientation?: 'v' | 'h';