add 'divergence' hoverinfo flag

Author: etpinard

src/plots/gl3d/scene.js

@@ -89,23 +89,26 @@ function render(scene) {
         var tx;
 
         if(trace.type === 'cone' || trace.type === 'streamtube') {
-            var coneTx = [];
+            var vectorTx = [];
             if(isHoverinfoAll || hoverinfoParts.indexOf('u') !== -1) {
-                coneTx.push('u: ' + formatter('xaxis', selection.traceCoordinate[3]));
+                vectorTx.push('u: ' + formatter('xaxis', selection.traceCoordinate[3]));
             }
             if(isHoverinfoAll || hoverinfoParts.indexOf('v') !== -1) {
-                coneTx.push('v: ' + formatter('yaxis', selection.traceCoordinate[4]));
+                vectorTx.push('v: ' + formatter('yaxis', selection.traceCoordinate[4]));
             }
             if(isHoverinfoAll || hoverinfoParts.indexOf('w') !== -1) {
-                coneTx.push('w: ' + formatter('zaxis', selection.traceCoordinate[5]));
+                vectorTx.push('w: ' + formatter('zaxis', selection.traceCoordinate[5]));
             }
             if(isHoverinfoAll || hoverinfoParts.indexOf('norm') !== -1) {
-                coneTx.push('norm: ' + selection.traceCoordinate[6].toPrecision(3));
+                vectorTx.push('norm: ' + selection.traceCoordinate[6].toPrecision(3));
+            }
+            if(isHoverinfoAll || hoverinfoParts.indexOf('divergence') !== -1) {
+                vectorTx.push('divergence: ' + selection.traceCoordinate[7].toPrecision(3));
             }
             if(selection.textLabel) {
-                coneTx.push(selection.textLabel);
+                vectorTx.push(selection.textLabel);
             }
-            tx = coneTx.join('<br>');
+            tx = vectorTx.join('<br>');
         } else {
             tx = selection.textLabel;
         }

src/traces/streamtube/attributes.js

@@ -114,10 +114,9 @@ fromMesh3d.forEach(function(k) {
     attrs[k] = mesh3dAttrs[k];
 });
 
-// TODO maybe add divergence field?
 attrs.hoverinfo = extendFlat({}, baseAttrs.hoverinfo, {
     editType: 'calc',
-    flags: ['x', 'y', 'z', 'u', 'v', 'w', 'norm', 'text', 'name'],
+    flags: ['x', 'y', 'z', 'u', 'v', 'w', 'norm', 'divergence', 'text', 'name'],
     dflt: 'x+y+z+norm+text+name'
 });
 

src/traces/streamtube/convert.js

@@ -51,6 +51,8 @@ proto.handlePick = function(selection) {
 
             // u/v/w norm
             selection.data.intensity * this.data._normMax,
+            // divergence
+            selection.data.divergence
         ];
 
         return true;

test/jasmine/tests/streamtube_test.js

@@ -268,6 +268,12 @@ describe('@gl Test streamtube hover', function() {
                     'w: 0.1693927'
                 ].join('\n')
             });
+            return Plotly.restyle(gd, 'hoverinfo', 'divergence');
+        })
+        .then(delay(20))
+        .then(_hover)
+        .then(function() {
+            assertHoverLabelContent({nums: 'divergence: 0.465'});
         })
         .catch(failTest)
         .then(done);