texttemplate: do not coerce texttemplate when no text is displayed

antoinerg · antoinerg · commit 6780a3d6b8a8 · 2019-08-28T14:01:57.000-04:00
diff --git a/src/traces/bar/defaults.js b/src/traces/bar/defaults.js
@@ -36,7 +36,6 @@ function supplyDefaults(traceIn, traceOut, defaultColor, layout) {
     coerce('width');
 
     coerce('text');
-    coerce('texttemplate');
     coerce('hovertext');
     coerce('hovertemplate');
 
@@ -156,6 +155,8 @@ function handleText(traceIn, traceOut, layout, coerce, textposition, opts) {
         if(moduleHasConstrain) coerce('constraintext');
         if(moduleHasCliponaxis) coerce('cliponaxis');
         if(moduleHasTextangle) coerce('textangle');
+
+        coerce('texttemplate');
     }
 
     if(hasInside) {
diff --git a/src/traces/funnel/defaults.js b/src/traces/funnel/defaults.js
@@ -32,7 +32,6 @@ function supplyDefaults(traceIn, traceOut, defaultColor, layout) {
     coerce('width');
 
     var text = coerce('text');
-    coerce('texttemplate');
 
     coerce('hovertext');
     coerce('hovertemplate');
diff --git a/src/traces/scatter/defaults.js b/src/traces/scatter/defaults.js
@@ -37,7 +37,6 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
     var defaultMode = !stackGroupOpts && (len < constants.PTS_LINESONLY) ?
         'lines+markers' : 'lines';
     coerce('text');
-    coerce('texttemplate');
     coerce('hovertext');
     coerce('mode', defaultMode);
 
@@ -53,6 +52,7 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
     }
 
     if(subTypes.hasText(traceOut)) {
+        coerce('texttemplate');
         handleTextDefaults(traceIn, traceOut, layout, coerce);
     }
 
diff --git a/src/traces/scatter3d/defaults.js b/src/traces/scatter3d/defaults.js
@@ -31,7 +31,6 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
     }
 
     coerce('text');
-    coerce('texttemplate');
     coerce('hovertext');
     coerce('hovertemplate');
     coerce('mode');
@@ -46,6 +45,7 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
     }
 
     if(subTypes.hasText(traceOut)) {
+        coerce('texttemplate');
         handleTextDefaults(traceIn, traceOut, layout, coerce, {noSelect: true});
     }
 
diff --git a/src/traces/scatter3d/index.js b/src/traces/scatter3d/index.js
@@ -29,7 +29,7 @@ module.exports = {
     moduleType: 'trace',
     name: 'scatter3d',
     basePlotModule: require('../../plots/gl3d'),
-    categories: ['gl3d', 'symbols', 'showLegend'],
+    categories: ['gl3d', 'symbols', 'showLegend', 'scatter-like'],
     meta: {
         hrName: 'scatter_3d',
         description: [
diff --git a/src/traces/scattergeo/defaults.js b/src/traces/scattergeo/defaults.js
@@ -32,7 +32,6 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
     }
 
     coerce('text');
-    coerce('texttemplate');
     coerce('hovertext');
     coerce('hovertemplate');
     coerce('mode');
@@ -47,6 +46,7 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
     }
 
     if(subTypes.hasText(traceOut)) {
+        coerce('texttemplate');
         handleTextDefaults(traceIn, traceOut, layout, coerce);
     }
 
diff --git a/src/traces/scattergl/defaults.js b/src/traces/scattergl/defaults.js
@@ -36,7 +36,6 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
     var defaultMode = len < constants.PTS_LINESONLY ? 'lines+markers' : 'lines';
 
     coerce('text');
-    coerce('texttemplate');
     coerce('hovertext');
     coerce('hovertemplate');
     coerce('mode', defaultMode);
@@ -53,6 +52,7 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
     }
 
     if(subTypes.hasText(traceOut)) {
+        coerce('texttemplate');
         handleTextDefaults(traceIn, traceOut, layout, coerce);
     }
 
diff --git a/src/traces/scattermapbox/index.js b/src/traces/scattermapbox/index.js
@@ -28,7 +28,7 @@ module.exports = {
     moduleType: 'trace',
     name: 'scattermapbox',
     basePlotModule: require('../../plots/mapbox'),
-    categories: ['mapbox', 'gl', 'symbols', 'showLegend', 'scatterlike'],
+    categories: ['mapbox', 'gl', 'symbols', 'showLegend', 'scatter-like'],
     meta: {
         hrName: 'scatter_mapbox',
         description: [
diff --git a/src/traces/scatterpolar/defaults.js b/src/traces/scatterpolar/defaults.js
@@ -34,7 +34,6 @@ function supplyDefaults(traceIn, traceOut, defaultColor, layout) {
     coerce('thetaunit');
     coerce('mode', len < PTS_LINESONLY ? 'lines+markers' : 'lines');
     coerce('text');
-    coerce('texttemplate');
     coerce('hovertext');
     if(traceOut.hoveron !== 'fills') coerce('hovertemplate');
 
@@ -49,6 +48,7 @@ function supplyDefaults(traceIn, traceOut, defaultColor, layout) {
     }
 
     if(subTypes.hasText(traceOut)) {
+        coerce('texttemplate');
         handleTextDefaults(traceIn, traceOut, layout, coerce);
     }
 
diff --git a/src/traces/scatterpolargl/defaults.js b/src/traces/scatterpolargl/defaults.js
@@ -34,7 +34,6 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
     coerce('thetaunit');
     coerce('mode', len < PTS_LINESONLY ? 'lines+markers' : 'lines');
     coerce('text');
-    coerce('texttemplate');
     coerce('hovertext');
     if(traceOut.hoveron !== 'fills') coerce('hovertemplate');
 
@@ -48,6 +47,7 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
     }
 
     if(subTypes.hasText(traceOut)) {
+        coerce('texttemplate');
         handleTextDefaults(traceIn, traceOut, layout, coerce);
     }
 
diff --git a/test/jasmine/assets/check_texttemplate.js b/test/jasmine/assets/check_texttemplate.js
@@ -12,16 +12,39 @@ var supplyAllDefaults = require('../assets/supply_defaults');
 module.exports = function checkTextTemplate(mock, selector, tests) {
     var isGL = Registry.traceIs(mock[0].type, 'gl');
     var isPolar = Registry.traceIs(mock[0].type, 'polar');
+    var isScatterLike = Registry.traceIs(mock[0].type, 'scatter-like');
+    var isBarLike = Registry.traceIs(mock[0].type, 'bar-like');
 
-    it('should not coerce textinfo when texttemplate', function() {
+    it('should not coerce textinfo when texttemplate is defined', function() {
         var gd = {};
-        gd.data = Lib.extendDeep(mock, {});
+        gd.data = Lib.extendDeep([], mock);
         gd.data[0].textinfo = 'text';
-        gd.data[0].texttemplate = tests[0][0];
+        gd.data[0].texttemplate = 'texttemplate';
         supplyAllDefaults(gd);
         expect(gd._fullData[0].textinfo).toBe(undefined);
     });
 
+    if(isScatterLike) {
+        it('should not coerce texttemplate when mode has no `text` flag', function() {
+            var gd = {};
+            gd.data = Lib.extendDeep([], mock);
+            gd.data[0].mode = 'markers';
+            gd.data[0].texttemplate = 'texttemplate';
+            supplyAllDefaults(gd);
+            expect(gd._fullData[0].texttemplate).toBe(undefined);
+        });
+    }
+
+    if(isBarLike) {
+        it('should not coerce texttemplate when textposition is `none`', function() {
+            var gd = {};
+            gd.data = Lib.extendDeep([], mock);
+            gd.data[0].textposition = 'none';
+            gd.data[0].texttemplate = 'texttemplate';
+            supplyAllDefaults(gd);
+            expect(gd._fullData[0].texttemplate).toBe(undefined);
+        });
+    }
 
     var N = tests[0][1].length;
     var i;
@@ -46,7 +69,7 @@ module.exports = function checkTextTemplate(mock, selector, tests) {
         tests.forEach(function(test) {
             it('@gl should support texttemplate', function(done) {
                 var gd = createGraphDiv();
-                var mockCopy = Lib.extendDeep(mock, {});
+                var mockCopy = Lib.extendDeep([], mock);
                 mockCopy[0].texttemplate = test[0];
                 Plotly.newPlot(gd, mockCopy)
                     .then(function() {
@@ -78,7 +101,7 @@ module.exports = function checkTextTemplate(mock, selector, tests) {
         tests.forEach(function(test) {
             it('should support texttemplate', function(done) {
                 var gd = createGraphDiv();
-                var mockCopy = Lib.extendDeep(mock, {});
+                var mockCopy = Lib.extendDeep([], mock);
                 mockCopy[0].texttemplate = test[0];
                 Plotly.newPlot(gd, mockCopy)
                     .then(function() {

Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,6 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout`
`37`	`37`	`var defaultMode = !stackGroupOpts && (len < constants.PTS_LINESONLY) ?`
`38`	`38`	`'lines+markers' : 'lines';`
`39`	`39`	`coerce('text');`
`40`		`- coerce('texttemplate');`
`41`	`40`	`coerce('hovertext');`
`42`	`41`	`coerce('mode', defaultMode);`
`43`	`42`
`@@ -53,6 +52,7 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout`
`53`	`52`	`}`
`54`	`53`
`55`	`54`	`if(subTypes.hasText(traceOut)) {`
	`55`	`+ coerce('texttemplate');`
`56`	`56`	`handleTextDefaults(traceIn, traceOut, layout, coerce);`
`57`	`57`	`}`
`58`	`58`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,6 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout`
`31`	`31`	`}`
`32`	`32`
`33`	`33`	`coerce('text');`
`34`		`- coerce('texttemplate');`
`35`	`34`	`coerce('hovertext');`
`36`	`35`	`coerce('hovertemplate');`
`37`	`36`	`coerce('mode');`
`@@ -46,6 +45,7 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout`
`46`	`45`	`}`
`47`	`46`
`48`	`47`	`if(subTypes.hasText(traceOut)) {`
	`48`	`+ coerce('texttemplate');`
`49`	`49`	`handleTextDefaults(traceIn, traceOut, layout, coerce, {noSelect: true});`
`50`	`50`	`}`
`51`	`51`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,6 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`coerce('text');`
`35`		`- coerce('texttemplate');`
`36`	`35`	`coerce('hovertext');`
`37`	`36`	`coerce('hovertemplate');`
`38`	`37`	`coerce('mode');`
`@@ -47,6 +46,7 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout`
`47`	`46`	`}`
`48`	`47`
`49`	`48`	`if(subTypes.hasText(traceOut)) {`
	`49`	`+ coerce('texttemplate');`
`50`	`50`	`handleTextDefaults(traceIn, traceOut, layout, coerce);`
`51`	`51`	`}`
`52`	`52`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,6 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout`
`36`	`36`	`var defaultMode = len < constants.PTS_LINESONLY ? 'lines+markers' : 'lines';`
`37`	`37`
`38`	`38`	`coerce('text');`
`39`		`- coerce('texttemplate');`
`40`	`39`	`coerce('hovertext');`
`41`	`40`	`coerce('hovertemplate');`
`42`	`41`	`coerce('mode', defaultMode);`
`@@ -53,6 +52,7 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout`
`53`	`52`	`}`
`54`	`53`
`55`	`54`	`if(subTypes.hasText(traceOut)) {`
	`55`	`+ coerce('texttemplate');`
`56`	`56`	`handleTextDefaults(traceIn, traceOut, layout, coerce);`
`57`	`57`	`}`
`58`	`58`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,6 @@ function supplyDefaults(traceIn, traceOut, defaultColor, layout) {`
`34`	`34`	`coerce('thetaunit');`
`35`	`35`	`coerce('mode', len < PTS_LINESONLY ? 'lines+markers' : 'lines');`
`36`	`36`	`coerce('text');`
`37`		`- coerce('texttemplate');`
`38`	`37`	`coerce('hovertext');`
`39`	`38`	`if(traceOut.hoveron !== 'fills') coerce('hovertemplate');`
`40`	`39`
`@@ -49,6 +48,7 @@ function supplyDefaults(traceIn, traceOut, defaultColor, layout) {`
`49`	`48`	`}`
`50`	`49`
`51`	`50`	`if(subTypes.hasText(traceOut)) {`
	`51`	`+ coerce('texttemplate');`
`52`	`52`	`handleTextDefaults(traceIn, traceOut, layout, coerce);`
`53`	`53`	`}`
`54`	`54`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,6 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout`
`34`	`34`	`coerce('thetaunit');`
`35`	`35`	`coerce('mode', len < PTS_LINESONLY ? 'lines+markers' : 'lines');`
`36`	`36`	`coerce('text');`
`37`		`- coerce('texttemplate');`
`38`	`37`	`coerce('hovertext');`
`39`	`38`	`if(traceOut.hoveron !== 'fills') coerce('hovertemplate');`
`40`	`39`
`@@ -48,6 +47,7 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout`
`48`	`47`	`}`
`49`	`48`
`50`	`49`	`if(subTypes.hasText(traceOut)) {`
	`50`	`+ coerce('texttemplate');`
`51`	`51`	`handleTextDefaults(traceIn, traceOut, layout, coerce);`
`52`	`52`	`}`
`53`	`53`