fallback to d3-sankey if no circularity is present

antoinerg · antoinerg · commit f8bf7feff7f4 · 2019-01-07T17:14:06.000-05:00
diff --git a/src/traces/sankey/calc.js b/src/traces/sankey/calc.js
@@ -38,14 +38,15 @@ function circularityPresent(nodeList, sources, targets) {
 }
 
 module.exports = function calc(gd, trace) {
-
-    if(!circularityPresent(trace.node.label, trace.link.source, trace.link.target)) {
-        // TODO: swap to original sankey engine
+    var circular = false;
+    if(circularityPresent(trace.node.label, trace.link.source, trace.link.target)) {
+        circular = true;
     }
 
     var result = convertToD3Sankey(trace);
 
     return wrap({
+        circular: circular,
         _nodes: result.nodes,
         _links: result.links
     });
diff --git a/src/traces/sankey/convert-to-d3-sankey.js b/src/traces/sankey/convert-to-d3-sankey.js
@@ -35,9 +35,12 @@ module.exports = function(trace) {
         target = +target;
         linkedNodes[source] = linkedNodes[target] = true;
 
+        var label = '';
+        if(linkSpec.label && linkSpec.label[i]) label = linkSpec.label[i];
+
         links.push({
             pointNumber: i,
-            label: linkSpec.label[i],
+            label: label,
             color: hasLinkColorArray ? linkSpec.color[i] : linkSpec.color,
             source: source,
             target: target,
diff --git a/src/traces/sankey/render.js b/src/traces/sankey/render.js
@@ -13,16 +13,15 @@ var d3 = require('d3');
 var tinycolor = require('tinycolor2');
 var Color = require('../../components/color');
 var Drawing = require('../../components/drawing');
-// TODO: allow swapping Sankey engine
-// var d3Sankey = require('d3-sankey');
+var d3Sankey = require('d3-sankey');
 var d3SankeyCircular = require('d3-sankey-circular');
 var d3Force = require('d3-force');
 var Lib = require('../../lib');
 var gup = require('../../lib/gup');
 var keyFun = gup.keyFun;
 var repeat = gup.repeat;
 var unwrap = gup.unwrap;
-// var interpolateNumber = require('d3-interpolate').interpolateNumber;
+var interpolateNumber = require('d3-interpolate').interpolateNumber;
 
 // view models
 
@@ -40,18 +39,26 @@ function sankeyModel(layout, d, traceIndex) {
     var nodes = calcData._nodes;
     var links = calcData._links;
 
-    var sankey = d3SankeyCircular
-        .sankeyCircular()
-        .iterations(c.sankeyIterations)
-        .size(horizontal ? [width, height] : [height, width])
-        .nodeWidth(nodeThickness)
-        .nodePadding(nodePad)
-        .circularLinkGap(2)
-        .nodes(nodes)
-        .links(links)
-        .nodeId(function(d) {
-            return d.pointNumber;
-        });
+    var circular = calcData.circular;
+    var sankey;
+    if(circular) {
+        sankey = d3SankeyCircular
+            .sankeyCircular()
+            .circularLinkGap(2)
+            .nodeId(function(d) {
+                return d.pointNumber;
+            });
+    } else {
+        sankey = d3Sankey.sankey();
+    }
+
+    sankey
+      .iterations(c.sankeyIterations)
+      .size(horizontal ? [width, height] : [height, width])
+      .nodeWidth(nodeThickness)
+      .nodePadding(nodePad)
+      .nodes(nodes)
+      .links(links);
 
     var graph = sankey();
 
@@ -60,6 +67,7 @@ function sankeyModel(layout, d, traceIndex) {
     }
 
     return {
+        circular: circular,
         key: traceIndex,
         trace: trace,
         guid: Math.floor(1e12 * (1 + Math.random())),
@@ -99,6 +107,7 @@ function linkModel(d, l, i) {
     l.curveNumber = d.trace.index;
 
     return {
+        circular: d.circular,
         key: key,
         traceId: d.key,
         pointNumber: l.pointNumber,
@@ -115,34 +124,32 @@ function linkModel(d, l, i) {
 }
 
 function linkPath() {
-    function circular(d) {
-        return d.link.path;
+    var curvature = 0.5;
+    function path(d) {
+        if(d.circular) {
+            return d.link.path;
+        } else {
+            var x0 = d.link.source.x1,
+                x1 = d.link.target.x0,
+                xi = interpolateNumber(x0, x1),
+                x2 = xi(curvature),
+                x3 = xi(1 - curvature),
+                y0a = d.link.y0 - d.link.width / 2,
+                y0b = d.link.y0 + d.link.width / 2,
+                y1a = d.link.y1 - d.link.width / 2,
+                y1b = d.link.y1 + d.link.width / 2;
+            return 'M' + x0 + ',' + y0a +
+                 'C' + x2 + ',' + y0a +
+                 ' ' + x3 + ',' + y1a +
+                 ' ' + x1 + ',' + y1a +
+                 'L' + x1 + ',' + y1b +
+                 'C' + x3 + ',' + y1b +
+                 ' ' + x2 + ',' + y0b +
+                 ' ' + x0 + ',' + y0b +
+                 'Z';
+        }
     }
-
-    return circular;
-    // var curvature = 0.5;
-
-    // function shape(d) {
-    //     var x0 = d.link.source.x1,
-    //         x1 = d.link.target.x0,
-    //         xi = interpolateNumber(x0, x1),
-    //         x2 = xi(curvature),
-    //         x3 = xi(1 - curvature),
-    //         y0a = d.link.y0 - d.link.width / 2,
-    //         y0b = d.link.y0 + d.link.width / 2,
-    //         y1a = d.link.y1 - d.link.width / 2,
-    //         y1b = d.link.y1 + d.link.width / 2;
-    //     return 'M' + x0 + ',' + y0a +
-    //          'C' + x2 + ',' + y0a +
-    //          ' ' + x3 + ',' + y1a +
-    //          ' ' + x1 + ',' + y1a +
-    //          'L' + x1 + ',' + y1b +
-    //          'C' + x3 + ',' + y1b +
-    //          ' ' + x2 + ',' + y0b +
-    //          ' ' + x0 + ',' + y0b +
-    //          'Z';
-    // }
-    // return shape;
+    return path;
 }
 
 function nodeModel(d, n, i) {
@@ -493,17 +500,23 @@ module.exports = function(svg, calcData, layout, callbacks) {
 
     sankeyLink
         .style('stroke', function(d) {
+            if(!d.circular) return salientEnough(d) ? Color.tinyRGB(tinycolor(d.linkLineColor)) : d.tinyColorHue;
             return d.tinyColorHue;
-            // return salientEnough(d) ? Color.tinyRGB(tinycolor(d.linkLineColor)) : d.tinyColorHue;
         })
         .style('stroke-opacity', function(d) {
+            if(!d.circular) return salientEnough(d) ? Color.opacity(d.linkLineColor) : d.tinyColorAlpha;
             return d.tinyColorAlpha;
-            // return salientEnough(d) ? Color.opacity(d.linkLineColor) : d.tinyColorAlpha;
         })
-        // .style('stroke-width', function(d) {return salientEnough(d) ? d.linkLineWidth : 1;})
-        //.style('fill', function(d) {return d.link.color;})
-        //.style('fill-opacity', function(d) {return d.tinyColorAlpha;})
-        .style('stroke-width', function(d) {return d.link.width;});
+        .style('fill', function(d) {
+            if(!d.circular) return d.tinyColorHue;
+        })
+        .style('fill-opacity', function(d) {
+            if(!d.circular) return d.tinyColorAlpha;
+        })
+        .style('stroke-width', function(d) {
+            if(d.circular) return d.link.width;
+            return salientEnough(d) ? d.linkLineWidth : 1;
+        });
 
     sankeyLink.transition()
        .ease(c.ease).duration(c.duration)
diff --git a/test/jasmine/tests/sankey_d3_sankey_test.js b/test/jasmine/tests/sankey_d3_sankey_test.js
@@ -94,6 +94,13 @@ describe('d3-sankey', function() {
         expect(node_names).toEqual(['node0', 'node1', 'node2', 'node3', 'node4']);
     });
 
+    it('keep a list of nodes with x values', function() {
+        var node_names = s().nodes.map(function(obj) {
+            return Math.floor(obj.x0);
+        });
+        expect(node_names).toEqual([0, 0, 381, 762, 1144]);
+    });
+
     it('keep a list of links', function() {
         var link_widths = s().links.map(function(obj) {
             return (obj.width);
diff --git a/test/jasmine/tests/sankey_test.js b/test/jasmine/tests/sankey_test.js
@@ -239,72 +239,72 @@ describe('sankey tests', function() {
         });
     });
 
-    describe('sankey calc', function() {
-
-        function _calc(trace) {
-            var gd = { data: [trace] };
-
-            supplyAllDefaults(gd);
-            var fullTrace = gd._fullData[0];
-            Sankey.calc(gd, fullTrace);
-            return fullTrace;
-        }
-
-        var base = { type: 'sankey' };
-
-        describe('remove nodes if encountering circularity', function() {
-            var errors;
-
-            beforeEach(function() {
-                errors = [];
-                spyOn(Lib, 'error').and.callFake(function(msg) {
-                    errors.push(msg);
-                });
-            });
-
-            it('removing a single self-pointing node', function() {
-                expect(errors.length).toBe(0);
-
-                var fullTrace = _calc(Lib.extendDeep({}, base, {
-                    node: {
-                        label: ['a']
-                    },
-                    link: {
-                        value: [1],
-                        source: [0],
-                        target: [0]
-                    }
-                }));
-
-                expect(fullTrace.node.label).toEqual([], 'node label(s) removed');
-                expect(fullTrace.link.value).toEqual([], 'link value(s) removed');
-                expect(fullTrace.link.source).toEqual([], 'link source(s) removed');
-                expect(fullTrace.link.target).toEqual([], 'link target(s) removed');
-                expect(errors.length).toBe(1);
-            });
-
-            it('removing everything if detecting a circle', function() {
-                expect(errors.length).toBe(0);
-
-                var fullTrace = _calc(Lib.extendDeep({}, base, {
-                    node: {
-                        label: ['a', 'b', 'c', 'd', 'e']
-                    },
-                    link: {
-                        value: [1, 1, 1, 1, 1, 1, 1, 1],
-                        source: [0, 1, 2, 3],
-                        target: [1, 2, 0, 4]
-                    }
-                }));
-
-                expect(fullTrace.node.label).toEqual([], 'node label(s) removed');
-                expect(fullTrace.link.value).toEqual([], 'link value(s) removed');
-                expect(fullTrace.link.source).toEqual([], 'link source(s) removed');
-                expect(fullTrace.link.target).toEqual([], 'link target(s) removed');
-                expect(errors.length).toBe(1);
-            });
-        });
-    });
+    // describe('sankey calc', function() {
+    //
+    //     function _calc(trace) {
+    //         var gd = { data: [trace] };
+    //
+    //         supplyAllDefaults(gd);
+    //         var fullTrace = gd._fullData[0];
+    //         Sankey.calc(gd, fullTrace);
+    //         return fullTrace;
+    //     }
+    //
+    //     var base = { type: 'sankey' };
+    //
+    //     describe('remove nodes if encountering circularity', function() {
+    //         var errors;
+    //
+    //         beforeEach(function() {
+    //             errors = [];
+    //             spyOn(Lib, 'error').and.callFake(function(msg) {
+    //                 errors.push(msg);
+    //             });
+    //         });
+    //
+    //         it('removing a single self-pointing node', function() {
+    //             expect(errors.length).toBe(0);
+    //
+    //             var fullTrace = _calc(Lib.extendDeep({}, base, {
+    //                 node: {
+    //                     label: ['a']
+    //                 },
+    //                 link: {
+    //                     value: [1],
+    //                     source: [0],
+    //                     target: [0]
+    //                 }
+    //             }));
+    //
+    //             expect(fullTrace.node.label).toEqual([], 'node label(s) removed');
+    //             expect(fullTrace.link.value).toEqual([], 'link value(s) removed');
+    //             expect(fullTrace.link.source).toEqual([], 'link source(s) removed');
+    //             expect(fullTrace.link.target).toEqual([], 'link target(s) removed');
+    //             expect(errors.length).toBe(1);
+    //         });
+    //
+    //         it('removing everything if detecting a circle', function() {
+    //             expect(errors.length).toBe(0);
+    //
+    //             var fullTrace = _calc(Lib.extendDeep({}, base, {
+    //                 node: {
+    //                     label: ['a', 'b', 'c', 'd', 'e']
+    //                 },
+    //                 link: {
+    //                     value: [1, 1, 1, 1, 1, 1, 1, 1],
+    //                     source: [0, 1, 2, 3],
+    //                     target: [1, 2, 0, 4]
+    //                 }
+    //             }));
+    //
+    //             expect(fullTrace.node.label).toEqual([], 'node label(s) removed');
+    //             expect(fullTrace.link.value).toEqual([], 'link value(s) removed');
+    //             expect(fullTrace.link.source).toEqual([], 'link source(s) removed');
+    //             expect(fullTrace.link.target).toEqual([], 'link target(s) removed');
+    //             expect(errors.length).toBe(1);
+    //         });
+    //     });
+    // });
 
     describe('lifecycle methods', function() {
         afterEach(destroyGraphDiv);
