texttemplate: add support for scatterpolargl

Author: antoinerg

src/lib/index.js

@@ -1067,7 +1067,7 @@ function templateFormatString(string, labels, d3locale) {
 
         if(format) {
             var fmt;
-            if(d3locale) {
+            if(d3locale && d3locale.numberFormat) {
                 fmt = d3locale.numberFormat;
             } else {
                 fmt = d3.format;

src/traces/scattergl/convert.js

@@ -124,7 +124,7 @@ function convertTextStyle(trace) {
                 optsOut.text.push(Lib.texttemplateString(texttemplate[i], pt, function() {}, pt));
             }
         } else {
-            for(i = 0; i < trace.x.length; i++) {
+            for(i = 0; i < count; i++) {
                 pt = {};
                 appendArrayPointValue(pt, trace, i);
                 optsOut.text.push(Lib.texttemplateString(texttemplate, pt, function() {}, pt));

src/traces/scatterpolargl/attributes.js

@@ -10,6 +10,7 @@
 
 var scatterPolarAttrs = require('../scatterpolar/attributes');
 var scatterGlAttrs = require('../scattergl/attributes');
+var texttemplateAttrs = require('../../plots/texttemplate_attributes');
 
 module.exports = {
     mode: scatterPolarAttrs.mode,
@@ -22,6 +23,9 @@ module.exports = {
     thetaunit: scatterPolarAttrs.thetaunit,
 
     text: scatterPolarAttrs.text,
+    texttemplate: texttemplateAttrs({editType: 'plot'}, {
+        keys: ['r', 'theta', 'text']
+    }),
     hovertext: scatterPolarAttrs.hovertext,
     hovertemplate: scatterPolarAttrs.hovertemplate,
 

src/traces/scatterpolargl/defaults.js

@@ -34,6 +34,7 @@ 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');
 

test/jasmine/assets/check_texttemplate.js

@@ -11,6 +11,7 @@ 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');
 
     it('should not coerce textinfo when texttemplate', function() {
         var gd = {};
@@ -38,7 +39,12 @@ module.exports = function checkTextTemplate(mock, selector, tests) {
             Plotly.newPlot(gd, mockCopy)
                 .then(function() {
                     if(isGL) {
-                        var glText = gd._fullLayout._plots.xy._scene.glText;
+                        var glText;
+                        if(isPolar) {
+                            glText = gd._fullLayout.polar._subplot._scene.glText;
+                        } else {
+                            glText = gd._fullLayout._plots.xy._scene.glText;
+                        }
                         expect(glText.length).toEqual(1);
                         expect(glText[0].textOffsets.length).toEqual(test[1].length);
                         for(var i = 0; i < glText[0].textOffsets.length - 1; i++) {
@@ -57,7 +63,10 @@ module.exports = function checkTextTemplate(mock, selector, tests) {
                     }
                 })
                 .catch(failTest)
-                .finally(destroyGraphDiv)
+                .finally(function() {
+                    Plotly.purge(gd);
+                    destroyGraphDiv();
+                })
                 .then(done);
         });
     });

test/jasmine/tests/scatterpolargl_test.js

@@ -11,6 +11,7 @@ var readPixel = require('../assets/read_pixel');
 
 var customAssertions = require('../assets/custom_assertions');
 var assertHoverLabelContent = customAssertions.assertHoverLabelContent;
+var checkTextTemplate = require('../assets/check_texttemplate');
 
 describe('Test scatterpolargl hover:', function() {
     var gd;
@@ -377,3 +378,17 @@ describe('Test scatterpolargl autorange:', function() {
         });
     });
 });
+
+describe('Test scatterpolargl texttemplate:', function() {
+    checkTextTemplate([{
+        'type': 'scatterpolargl',
+        'mode': 'markers+text',
+        'text': ['A', 'B', 'C'],
+        'textposition': 'top center',
+        'r': [1, 0.5, 1],
+        'theta': [0, 90, 180],
+    }], 'g.textpoint', [
+        ['%{text}: (%{r:0.2f}, %{theta:0.1f})', ['A: (1.00, 0.0)', 'B: (0.50, 90.0)', 'C: (1.00, 180.0)']],
+        [['', 'b%{theta:0.2f}', '%{theta:0.2f}'], ['', 'b90.00', '180.00']]
+    ]);
+});