texttemplate: add customdata variable and 🔒 down with test

plotly · Jul 23, 2019 · e0bde45 · e0bde45
1 parent c3e9961
commit e0bde45
Show file tree

Hide file tree

Showing 6 changed files with 17 additions and 4 deletions.
diff --git a/src/components/drawing/index.js b/src/components/drawing/index.js
@@ -700,7 +700,7 @@ drawing.textPointStyle = function(s, trace, gd) {
         }
 
         if(template) {
-            text = Lib.texttemplateString(text, {}, gd._fullLayout._d3locale, d, trace._meta || {});
+            text = Lib.texttemplateString(text, {}, gd._fullLayout._d3locale, d, trace._meta || {}, {customdata: d.data});
         }
 
         var pos = d.tp || trace.textposition;

diff --git a/src/traces/bar/plot.js b/src/traces/bar/plot.js
@@ -591,6 +591,8 @@ function calcTexttemplate(fullLayout, calcTrace, index, xa, ya) {
         obj.percenTotalLabel = Lib.formatPercent(cdi.sumR);
     }
 
+    var customdata = Lib.castOption(trace, cdi.i, 'customdata');
+    if(customdata) obj.customdata = customdata;
     return Lib.texttemplateString(texttemplate, obj, fullLayout._d3locale, obj, trace._meta || {});
 }
 

diff --git a/src/traces/pie/plot.js b/src/traces/pie/plot.js
@@ -980,7 +980,8 @@ function formatSliceLabel(gd, pt, cd0) {
             percent: pt.v / cd0.vTotal,
             percentLabel: helpers.formatPiePercent(pt.v / cd0.vTotal, fullLayout.separators),
             color: pt.color,
-            text: pt.text
+            text: pt.text,
+            customdata: Lib.castOption(trace, pt.i, 'customdata')
         };
     }
 

diff --git a/src/traces/sunburst/plot.js b/src/traces/sunburst/plot.js
@@ -762,6 +762,7 @@ function formatSliceLabel(pt, trace, fullLayout) {
     }
     var ptTx = Lib.castOption(trace, cdi.i, 'text');
     if(Lib.isValidTextValue(ptTx)) obj.text = ptTx;
+    obj.customdata = Lib.castOption(trace, cdi.i, 'customdata');
     return Lib.texttemplateString(txt, obj, fullLayout._d3locale, obj, trace._meta || {});
 }
 

diff --git a/test/jasmine/assets/check_texttemplate.js b/test/jasmine/assets/check_texttemplate.js
@@ -17,8 +17,17 @@ module.exports = function checkTextTemplate(mock, selector, tests) {
         expect(gd._fullData[0].textinfo).toBe(undefined);
     });
 
+    // Generate customdata
+    var N = tests[0][1].length;
+    var customdata = [];
+    for(var i = 0; i < N; i++) {
+        customdata.push(Lib.randstr({}));
+    }
+    mock[0].customdata = customdata;
+    tests.push(['%{customdata}', customdata]);
+
     tests.forEach(function(test) {
-        it('should support textemplate', function(done) {
+        it('should support texttemplate', function(done) {
             var gd = createGraphDiv();
             var mockCopy = Lib.extendDeep(mock, {});
             mockCopy[0].texttemplate = test[0];

diff --git a/test/jasmine/tests/sunburst_test.js b/test/jasmine/tests/sunburst_test.js
@@ -1239,7 +1239,7 @@ describe('Test sunburst interactions edge cases', function() {
     });
 });
 
-describe('Test texttemplate:', function() {
+describe('Test sunburst texttemplate:', function() {
     checkTextTemplate([{
         type: 'sunburst',
         labels: ['Eve', 'Cain', 'Seth', 'Enos', 'Esther'],