flipping attrib representation to columnar

monfera · monfera · commit 426b50ddb76c · 2017-05-01T13:28:59.000+02:00
diff --git a/src/traces/sankey/attributes.js b/src/traces/sankey/attributes.js
@@ -108,43 +108,40 @@ module.exports = {
 
     textfont: fontAttrs,
 
-    nodes: {
-        _isLinkedToArray: 'node',
+    node: {
         label: {
-            valType: 'string',
+            valType: 'data_array',
             dflt: '',
             role: 'info',
             description: 'The shown name of the node.'
         },
-        visible: shapeAttrs.visible,
         color: extendFlat({}, shapeAttrs.fillcolor, {
+            arrayOk: true,
             dflt: 'rgb(0,255,0,0.5)'
         }),
         description: 'The nodes of the Sankey plot.'
     },
 
-    links: {
-        _isLinkedToArray: 'link',
+    link: {
         label: {
-            valType: 'string',
+            valType: 'data_array',
             dflt: '',
             role: 'info',
             description: 'The shown name of the link.'
         },
-        visible: shapeAttrs.visible,
-        color: extendFlat({}, shapeAttrs.fillcolor, {dflt: 'rgba(0,0,0,0.2)'}),
+        color: extendFlat({}, shapeAttrs.fillcolor, {arrayOk: true, dflt: 'rgba(0,0,0,0.2)'}),
         source: {
-            valType: 'number',
+            valType: 'data_array',
             role: 'info',
             description: 'An integer number `[0..nodes.length - 1]` that represents the source node.'
         },
         target: {
-            valType: 'number',
+            valType: 'data_array',
             role: 'info',
             description: 'An integer number `[0..nodes.length - 1]` that represents the target node.'
         },
         value: {
-            valType: 'number',
+            valType: 'data_array',
             dflt: 1,
             role: 'info',
             description: 'A numeric value representing the flow volume value.'
diff --git a/src/traces/sankey/defaults.js b/src/traces/sankey/defaults.js
@@ -14,111 +14,34 @@ var colors = require('../../components/color/attributes').defaults;
 var Color = require('../../components/color');
 var tinycolor = require('tinycolor2');
 
-function linksDefaults(traceIn, traceOut, layout) {
-    var linksIn = traceIn.links || [],
-        linksOut = traceOut.links = [];
-
-    var linkIn, linkOut, i;
-
-    function coerce(attr, dflt) {
-        return Lib.coerce(linkIn, linkOut, attributes.links, attr, dflt);
-    }
-
-    for(i = 0; i < linksIn.length; i++) {
-        linkIn = linksIn[i];
-        linkOut = {};
-
-        if(!Lib.isPlainObject(linkIn)) {
-            continue;
-        }
-
-        var visible = coerce('visible');
-
-        if(visible) {
-            coerce('label');
-            coerce('value');
-            coerce('source');
-            coerce('target');
-            if(tinycolor(layout.paper_bgcolor).getLuminance() < 0.333) {
-                coerce('color', 'rgba(255, 255, 255, 0.6)');
-            } else {
-                coerce('color', 'rgba(0, 0, 0, 0.2)');
-            }
-        }
-
-        linkOut._index = i;
-        linksOut.push(linkOut);
-    }
+function circularityPresent() {
+    return false;
 }
 
-function nodesDefaults(traceIn, traceOut) {
-    var nodesIn = traceIn.nodes || [],
-        nodesOut = traceOut.nodes = [];
-
-    var nodeIn, nodeOut, i, j, link, foundUse, visible,
-        usedNodeCount = 0,
-        indexMap = [];
-
-    var defaultPalette = function(i) {return colors[i % colors.length];};
+module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout) {
 
     function coerce(attr, dflt) {
-        return Lib.coerce(nodeIn, nodeOut, attributes.nodes, attr, dflt);
+        return Lib.coerce(traceIn, traceOut, attributes, attr, dflt);
     }
 
-    for(i = 0; i < nodesIn.length; i++) {
-        nodeIn = nodesIn[i];
-
-        foundUse = false;
-        for(j = 0; j < traceOut.links.length && !foundUse; j++) {
-            link = traceOut.links[j];
-            foundUse = link.source === i || link.target === i;
-        }
-
-        indexMap.push(foundUse ? usedNodeCount : null);
-
-        if(!foundUse) {
-            continue;
-        }
+    coerce('node.label');
 
-        if(!Lib.isPlainObject(nodeIn)) {
-            continue;
-        }
+    var defaultNodePalette = function(i) {return colors[i % colors.length];};
 
-        nodeOut = {};
+    coerce('node.color', traceIn.node.label.map(function(d, i) {
+        return Color.addOpacity(defaultNodePalette(i), 0.8);
+    }));
 
-        visible = coerce('visible');
+    coerce('link.label');
+    coerce('link.source');
+    coerce('link.target');
+    coerce('link.value');
 
-        if(visible) {
-            coerce('label');
-            if(nodeIn.color) {
-                coerce('color');
-            } else {
-                coerce('color', Color.addOpacity(defaultPalette(i), 0.8));
-            }
-        }
-
-        nodeOut._index = usedNodeCount;
-        nodesOut.push(nodeOut);
-        usedNodeCount++;
-    }
-
-    // since nodes were removed, update indices to nodes in links to reflect new reality
-    for(j = 0; j < traceOut.links.length; j++) {
-        link = traceOut.links[j];
-        link.source = indexMap[link.source];
-        link.target = indexMap[link.target];
-    }
-
-    return nodesOut;
-}
-
-module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout) {
-    function coerce(attr, dflt) {
-        return Lib.coerce(traceIn, traceOut, attributes, attr, dflt);
-    }
-
-    linksDefaults(traceIn, traceOut, layout);
-    nodesDefaults(traceIn, traceOut);
+    coerce('link.color', traceIn.link.value.map(function() {
+        return tinycolor(layout.paper_bgcolor).getLuminance() < 0.333 ?
+            'rgba(255, 255, 255, 0.6)' :
+            'rgba(0, 0, 0, 0.2)';
+    }));
 
     coerce('hoverinfo', layout._dataLength === 1 ? 'label+text+value+percent' : undefined);
 
@@ -131,7 +54,24 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
     coerce('valuesuffix');
     coerce('arrangement');
 
-    // Prefer Sankey-specific font spec e.g. with smaller default size
-    var sankeyFontSpec = Lib.coerceFont(coerce, 'textfont');
-    Lib.coerceFont(coerce, 'textfont', Lib.extendFlat({}, layout.font, sankeyFontSpec));
+    Lib.coerceFont(coerce, 'textfont', Lib.extendFlat({}, layout.font));
+
+    var missing = function(n, i) {
+        return traceIn.link.source.indexOf(i) === -1 &&
+            traceIn.link.target.indexOf(i) === -1;
+    };
+    if(traceIn.node.label.some(missing)) {
+        Lib.log('Some of the nodes are neither sources nor targets, please remove them.');
+    }
+
+    if(circularityPresent(traceIn.link.source, traceIn.link.target)) {
+        Lib.log('Circularity is present in the Sankey data. Removing all nodes and links.');
+        traceOut.link.label = [];
+        traceOut.link.source = [];
+        traceOut.link.target = [];
+        traceOut.link.value = [];
+        traceOut.link.color = [];
+        traceOut.node.label = [];
+        traceOut.node.color = [];
+    }
 };
diff --git a/src/traces/sankey/plot.js b/src/traces/sankey/plot.js
@@ -171,23 +171,11 @@ module.exports = function plot(gd, calcData) {
         Fx.click(gd, { target: true });
     };
 
-    var repositioned = function(d, nodes) {
-        var n, nOrig;
-        var names = gd.data[0].nodes.map(function(nn) {return nn.label;});
-        for(var i = 0; i < nodes.length; i++) {
-            n = nodes[i];
-            nOrig = gd.data[d.traceId].nodes[names.indexOf(n.label)];
-            nOrig.parallel = (n.x - n.dx / 2) / n.width;
-            nOrig.perpendicular = (n.y - n.dy / 2) / n.height;
-        }
-    };
-
     var nodeHover = function(element, d, sankey) {
         d3.select(element).call(nodeHoveredStyle, d, sankey);
         Fx.hover(gd, d.node, 'sankey');
     };
 
-
     var nodeHoverFollow = function(element, d) {
 
         var nodeRect = d3.select(element).select('.nodeRect');
@@ -252,8 +240,7 @@ module.exports = function plot(gd, calcData) {
                 hover: nodeHover,
                 follow: nodeHoverFollow,
                 unhover: nodeUnhover,
-                select: nodeSelect,
-                repositioned: repositioned
+                select: nodeSelect
             }
         }
     );
diff --git a/src/traces/sankey/render.js b/src/traces/sankey/render.js
@@ -15,13 +15,13 @@ var Color = require('../../components/color');
 var Drawing = require('../../components/drawing');
 var d3sankey = require('@monfera/d3-sankey').sankey;
 var d3Force = require('d3-force');
+var Lib = require('../../lib');
 
 // basic data utilities
 
 function keyFun(d) {return d.key;}
 function repeat(d) {return [d];} // d3 data binding convention
 function unwrap(d) {return d[0];} // plotly data structure convention
-// function visible(nodeOrLink) {return !('visible' in nodeOrLink) || nodeOrLink.visible;}
 
 function persistOriginalPlace(nodes) {
     var i, distinctLayerPositions = [];
@@ -68,8 +68,8 @@ function sankeyModel(layout, d, i) {
 
     var trace = unwrap(d).trace,
         domain = trace.domain,
-        nodes = trace.nodes,
-        links = trace.links,
+        nodeSpec = trace.node,
+        linkSpec = trace.link,
         arrangement = trace.arrangement,
         horizontal = trace.orientation === 'h',
         nodePad = trace.nodepad,
@@ -81,6 +81,23 @@ function sankeyModel(layout, d, i) {
     var width = layout.width * (domain.x[1] - domain.x[0]),
         height = layout.height * (domain.y[1] - domain.y[0]);
 
+    var nodes = nodeSpec.label.map(function(l, i) {
+        return {
+            label: l,
+            color: Lib.isArray(nodeSpec.color) ? nodeSpec.color[i] : nodeSpec.color
+        };
+    });
+
+    var links = linkSpec.value.map(function(d, i) {
+        return {
+            label: linkSpec.label[i],
+            color: Lib.isArray(linkSpec.color) ? linkSpec.color[i] : linkSpec.color,
+            source: linkSpec.source[i],
+            target: linkSpec.target[i],
+            value: d
+        };
+    });
+
     var sankey = d3sankey()
         .size(horizontal ? [width, height] : [height, width])
         .nodeWidth(nodeThickness)
@@ -266,8 +283,6 @@ function attachPointerEvents(selection, sankey, eventSet) {
 
 function attachDragHandler(sankeyNode, sankeyLink, callbacks) {
 
-    var repositionedCallback = callbacks.nodeEvents.repositioned;
-
     var dragBehavior = d3.behavior.drag()
 
         .origin(function(d) {return d.horizontal ? d.node : {x: d.node.y, y: d.node.x};})
@@ -286,7 +301,7 @@ function attachDragHandler(sankeyNode, sankeyLink, callbacks) {
                 if(d.forceLayouts[forceKey]) {
                     d.forceLayouts[forceKey].alpha(1);
                 } else { // make a forceLayout iff needed
-                    attachForce(sankeyNode, forceKey, repositionedCallback, d);
+                    attachForce(sankeyNode, forceKey, d);
                 }
                 startForce(sankeyNode, sankeyLink, d, forceKey);
             }
@@ -314,9 +329,6 @@ function attachDragHandler(sankeyNode, sankeyLink, callbacks) {
         })
 
         .on('dragend', function(d) {
-            if(d.arrangement !== 'snap') {
-                repositionedCallback(d, [d.node]);
-            }
             d.interactionState.dragInProgress = false;
         });
 
@@ -325,15 +337,15 @@ function attachDragHandler(sankeyNode, sankeyLink, callbacks) {
         .call(dragBehavior);
 }
 
-function attachForce(sankeyNode, forceKey, repositionedCallback, d) {
+function attachForce(sankeyNode, forceKey, d) {
     var nodes = d.sankey.nodes().filter(function(n) {return n.originalX === d.node.originalX;});
     d.forceLayouts[forceKey] = d3Force.forceSimulation(nodes)
         .alphaDecay(0)
         .force('collide', d3Force.forceCollide()
             .radius(function(n) {return n.dy / 2 + d.nodePad / 2;})
             .strength(1)
             .iterations(c.forceIterations))
-        .force('constrain', snappingForce(sankeyNode, forceKey, nodes, repositionedCallback, d))
+        .force('constrain', snappingForce(sankeyNode, forceKey, nodes, d))
         .stop();
 }
 
@@ -350,7 +362,7 @@ function startForce(sankeyNode, sankeyLink, d, forceKey) {
     });
 }
 
-function snappingForce(sankeyNode, forceKey, nodes, repositionedCallback, d) {
+function snappingForce(sankeyNode, forceKey, nodes, d) {
     return function _snappingForce() {
         var maxVelocity = 0;
         for(var i = 0; i < nodes.length; i++) {
@@ -368,7 +380,6 @@ function snappingForce(sankeyNode, forceKey, nodes, repositionedCallback, d) {
             d.forceLayouts[forceKey].alpha(0);
             window.setTimeout(function() {
                 sankeyNode.call(crispLinesOnEnd);
-                repositionedCallback(d, nodes);
             }, 30); // geome on move, crisp when static
         }
     };
@@ -416,7 +427,7 @@ module.exports = function(svg, styledData, layout, callbacks) {
         .data(function(d) {
             var uniqueKeys = {};
             return d.sankey.links()
-                .filter(function(l) {return l.visible && l.value;})
+                .filter(function(l) {return l.value;})
                 .map(linkModel.bind(null, uniqueKeys, d));
         }, keyFun);
 
@@ -464,7 +475,7 @@ module.exports = function(svg, styledData, layout, callbacks) {
             var uniqueKeys = {};
             persistOriginalPlace(nodes);
             return nodes
-                .filter(function(n) {return n.visible && n.value;})
+                .filter(function(n) {return n.value;})
                 .map(nodeModel.bind(null, uniqueKeys, d));
         }, keyFun);
 
diff --git a/test/image/mocks/energy.json b/test/image/mocks/energy.json
diff --git a/test/image/mocks/energy_dark.json b/test/image/mocks/energy_dark.json
