tweak and test cleanData for finance traces

removing direction names & showlegend, and picking a composite name

Author: alexcjohnson

src/plot_api/helpers.js

@@ -332,15 +332,21 @@ exports.cleanData = function(data, existingData) {
 
         // fixes from converting finance from transforms to real trace types
         if(trace.type === 'candlestick' || trace.type === 'ohlc') {
+            var increasingShowlegend = (trace.increasing || {}).showlegend !== false;
+            var decreasingShowlegend = (trace.decreasing || {}).showlegend !== false;
             var increasingName = cleanFinanceDir(trace.increasing);
             var decreasingName = cleanFinanceDir(trace.decreasing);
 
             // now figure out something smart to do with the separate direction
             // names we removed
-            if(increasingName && decreasingName) {
+            if((increasingName !== false) && (decreasingName !== false)) {
                 // both sub-names existed: base name previously had no effect
                 // so ignore it and try to find a shared part of the sub-names
-                var newName = commonPrefix(increasingName, decreasingName);
+
+                var newName = commonPrefix(
+                    increasingName, decreasingName,
+                    increasingShowlegend, decreasingShowlegend
+                );
                 // if no common part, leave whatever name was (or wasn't) there
                 if(newName) trace.name = newName;
             }
@@ -409,17 +415,24 @@ exports.cleanData = function(data, existingData) {
 };
 
 function cleanFinanceDir(dirContainer) {
-    if(!Lib.isPlainObject(dirContainer)) return '';
+    if(!Lib.isPlainObject(dirContainer)) return false;
 
-    var dirName = (dirContainer.showlegend === false) ? '' : dirContainer.name;
+    var dirName = dirContainer.name;
 
     delete dirContainer.name;
     delete dirContainer.showlegend;
 
-    return dirName;
+    return (typeof dirName === 'string' || typeof dirName === 'number') && String(dirName);
 }
 
-function commonPrefix(name1, name2) {
+function commonPrefix(name1, name2, show1, show2) {
+    // if only one is shown in the legend, use that
+    if(show1 && !show2) return name1;
+    if(show2 && !show1) return name2;
+
+    // if both or neither are in the legend, check if one is blank (or whitespace)
+    // and use the other one
+    // note that hover labels can still use the name even if the legend doesn't
     if(!name1.trim()) return name2;
     if(!name2.trim()) return name1;
 

test/jasmine/tests/plot_api_test.js

@@ -2276,6 +2276,90 @@ describe('Test plot api', function() {
             expect(gd.layout.shapes[2].yref).toEqual('y');
 
         });
+
+        it('removes direction names and showlegend from finance traces', function() {
+            var data = [{
+                type: 'ohlc', open: [1], high: [3], low: [0], close: [2],
+                increasing: {
+                    showlegend: true,
+                    name: 'Yeti goes up'
+                },
+                decreasing: {
+                    showlegend: 'legendonly',
+                    name: 'Yeti goes down'
+                },
+                name: 'Snowman'
+            }, {
+                type: 'candlestick', open: [1], high: [3], low: [0], close: [2],
+                increasing: {
+                    name: 'Bigfoot'
+                },
+                decreasing: {
+                    showlegend: false,
+                    name: 'Biggerfoot'
+                },
+                name: 'Nobody'
+            }, {
+                type: 'ohlc', open: [1], high: [3], low: [0], close: [2],
+                increasing: {
+                    name: 'Batman'
+                },
+                decreasing: {
+                    showlegend: true
+                },
+                name: 'Robin'
+            }, {
+                type: 'candlestick', open: [1], high: [3], low: [0], close: [2],
+                increasing: {
+                    showlegend: false,
+                },
+                decreasing: {
+                    name: 'Fred'
+                }
+            }, {
+                type: 'ohlc', open: [1], high: [3], low: [0], close: [2],
+                increasing: {
+                    showlegend: false,
+                    name: 'Gruyere heating up'
+                },
+                decreasing: {
+                    showlegend: false,
+                    name: 'Gruyere cooling off'
+                },
+                name: 'Emmenthaler'
+            }];
+
+            Plotly.plot(gd, data);
+
+            // Even if both showlegends are false, leave trace.showlegend out
+            // My rationale for this is that legends are sufficiently different
+            // now that it's worthwhile resetting their existence to default
+            gd.data.forEach(function(trace) {
+                expect(trace.increasing.name).toBeUndefined();
+                expect(trace.increasing.showlegend).toBeUndefined();
+                expect(trace.decreasing.name).toBeUndefined();
+                expect(trace.decreasing.showlegend).toBeUndefined();
+            });
+
+            // Both directions have names: ignore trace.name, as it
+            // had no effect on the output previously
+            // Ideally 'Yeti goes' would be smart enough to truncate
+            // at 'Yeti' but I don't see how to do that...
+            expect(gd.data[0].name).toBe('Yeti goes');
+            // One direction has empty or hidden name so use the other
+            // Note that even '' in both names would render trace.name impact-less
+            expect(gd.data[1].name).toBe('Bigfoot');
+
+            // One direction has a name but trace.name is there too:
+            // just use trace.name
+            expect(gd.data[2].name).toBe('Robin');
+
+            // No trace.name, only one direction name: use the direction name
+            expect(gd.data[3].name).toBe('Fred');
+
+            // both names exist but hidden from the legend: still look for common prefix
+            expect(gd.data[4].name).toBe('Gruyere');
+        });
     });
 
     describe('Plotly.newPlot', function() {