add curveNumber and original event ref to sankey event data

Author: etpinard

src/traces/sankey/plot.js

@@ -115,24 +115,26 @@ function castHoverOption(trace, attr) {
 }
 
 module.exports = function plot(gd, calcData) {
-
     var fullLayout = gd._fullLayout;
     var svg = fullLayout._paper;
     var size = fullLayout._size;
 
     var linkSelect = function(element, d) {
-        gd._hoverdata = [d.link];
-        gd._hoverdata.trace = calcData.trace;
+        var evt = d.link;
+        evt.originalEvent = d3.event;
+        gd._hoverdata = [evt];
         Fx.click(gd, { target: true });
     };
 
     var linkHover = function(element, d, sankey) {
+        var evt = d.link;
+        evt.originalEvent = d3.event;
         d3.select(element).call(linkHoveredStyle.bind(0, d, sankey, true));
-        Fx.hover(gd, d.link, 'sankey');
+        Fx.hover(gd, evt, 'sankey');
     };
 
     var linkHoverFollow = function(element, d) {
-        var trace = gd._fullData[d.traceId];
+        var trace = d.link.trace;
         var rootBBox = gd.getBoundingClientRect();
         var boundingBox = element.getBoundingClientRect();
         var hoverCenterX = boundingBox.left + boundingBox.width / 2;
@@ -166,26 +168,30 @@ module.exports = function plot(gd, calcData) {
     var linkUnhover = function(element, d, sankey) {
         d3.select(element).call(linkNonHoveredStyle.bind(0, d, sankey, true));
         gd.emit('plotly_unhover', {
+            event: d3.event,
             points: [d.link]
         });
 
         Fx.loneUnhover(fullLayout._hoverlayer.node());
     };
 
     var nodeSelect = function(element, d, sankey) {
-        gd._hoverdata = [d.node];
-        gd._hoverdata.trace = calcData.trace;
+        var evt = d.node;
+        evt.originalEvent = d3.event;
+        gd._hoverdata = [evt];
         d3.select(element).call(nodeNonHoveredStyle, d, sankey);
         Fx.click(gd, { target: true });
     };
 
     var nodeHover = function(element, d, sankey) {
+        var evt = d.node;
+        evt.originalEvent = d3.event;
         d3.select(element).call(nodeHoveredStyle, d, sankey);
-        Fx.hover(gd, d.node, 'sankey');
+        Fx.hover(gd, evt, 'sankey');
     };
 
     var nodeHoverFollow = function(element, d) {
-        var trace = gd._fullData[d.traceId];
+        var trace = d.node.trace;
         var nodeRect = d3.select(element).select('.nodeRect');
         var rootBBox = gd.getBoundingClientRect();
         var boundingBox = nodeRect.node().getBoundingClientRect();
@@ -220,9 +226,9 @@ module.exports = function plot(gd, calcData) {
     };
 
     var nodeUnhover = function(element, d, sankey) {
-
         d3.select(element).call(nodeNonHoveredStyle, d, sankey);
         gd.emit('plotly_unhover', {
+            event: d3.event,
             points: [d.node]
         });
 

src/traces/sankey/render.js

@@ -65,7 +65,6 @@ function switchToSankeyFormat(nodes) {
 // view models
 
 function sankeyModel(layout, d, i) {
-
     var trace = unwrap(d).trace,
         domain = trace.domain,
         nodeSpec = trace.node,
@@ -121,6 +120,7 @@ function sankeyModel(layout, d, i) {
 
     return {
         key: i,
+        trace: trace,
         guid: Math.floor(1e12 * (1 + Math.random())),
         horizontal: horizontal,
         width: width,
@@ -150,13 +150,17 @@ function sankeyModel(layout, d, i) {
 }
 
 function linkModel(uniqueKeys, d, l) {
-
     var tc = tinycolor(l.color);
     var basicKey = l.source.label + '|' + l.target.label;
     var foundKey = uniqueKeys[basicKey];
     uniqueKeys[basicKey] = (foundKey === void(0) ? foundKey : 0) + 1;
     var key = basicKey + (foundKey === void(0) ? '' : '__' + foundKey);
 
+    // for event data
+    l.trace = d.trace;
+    l.curveNumber = d.trace.index;
+    l.pointNumber = 'TODO';
+
     return {
         key: key,
         traceId: d.key,
@@ -173,7 +177,6 @@ function linkModel(uniqueKeys, d, l) {
 }
 
 function nodeModel(uniqueKeys, d, n) {
-
     var tc = tinycolor(n.color),
         zoneThicknessPad = c.nodePadAcross,
         zoneLengthPad = d.nodePad / 2,
@@ -185,6 +188,11 @@ function nodeModel(uniqueKeys, d, n) {
     uniqueKeys[basicKey] = (foundKey === void(0) ? foundKey : 0) + 1;
     var key = basicKey + (foundKey === void(0) ? '' : '__' + foundKey);
 
+    // for event data
+    n.trace = d.trace;
+    n.curveNumber = d.trace.index;
+    n.pointNumber = 'TODO';
+
     return {
         key: key,
         traceId: d.key,

test/jasmine/tests/sankey_test.js

@@ -410,4 +410,101 @@ describe('sankey tests', function() {
             .then(done);
         });
     });
+
+    describe('Test hover/click event data:', function() {
+        var gd;
+
+        beforeEach(function() {
+            gd = createGraphDiv();
+        });
+
+        afterEach(destroyGraphDiv);
+
+        function _makeWrapper(eventType, mouseFn) {
+            var posByElementType = {
+                node: [400, 300],
+                link: [450, 300]
+            };
+
+            return function(elType) {
+                return new Promise(function(resolve, reject) {
+                    gd.once(eventType, function(d) {
+                        delete gd._lastHoverTime;
+                        resolve(d);
+                    });
+
+                    mouseFn(posByElementType[elType]);
+                    setTimeout(function() {
+                        reject(eventType + ' did not get called!');
+                    }, 100);
+                });
+            };
+        }
+
+        var _hover = _makeWrapper('plotly_hover', function(pos) {
+            mouseEvent('mouseover', pos[0], pos[1]);
+        });
+
+        var _click = _makeWrapper('plotly_click', function(pos) {
+            mouseEvent('click', pos[0], pos[1]);
+        });
+
+        var _unhover = _makeWrapper('plotly_unhover', function(pos) {
+            mouseEvent('mouseover', pos[0], pos[1]);
+            mouseEvent('mouseout', pos[0], pos[1]);
+        });
+
+        it('should output correct hover/click/unhover event data', function(done) {
+            var fig = Lib.extendDeep({}, mock);
+
+            function _assert(d, expectedPtData) {
+                expect(d.event).toBeDefined('original event reference');
+
+                var ptData = d.points[0];
+                Object.keys(expectedPtData).forEach(function(k) {
+                    expect(ptData[k]).toBe(expectedPtData[k], 'point data for ' + k);
+                });
+            }
+
+            Plotly.plot(gd, fig)
+            .then(function() { return _hover('node'); })
+            .then(function(d) {
+                _assert(d, {
+                    curveNumber: 0
+                });
+            })
+            .then(function() { return _hover('link'); })
+            .then(function(d) {
+                _assert(d, {
+                    curveNumber: 0
+                });
+            })
+            .then(function() { return _click('node'); })
+            .then(function(d) {
+                _assert(d, {
+                    curveNumber: 0
+                });
+            })
+            .then(function() { return _click('link'); })
+            .then(function(d) {
+                _assert(d, {
+                    curveNumber: 0
+                });
+            })
+            .then(function() { return _unhover('node'); })
+            .then(function(d) {
+                _assert(d, {
+                    curveNumber: 0
+                });
+            })
+            .then(function() { return _unhover('link'); })
+            .then(function(d) {
+                _assert(d, {
+                    curveNumber: 0
+                });
+            })
+            .catch(fail)
+            .then(done);
+        });
+    });
 });