fix more percentage edge cases - handle branchvalues remainder

Author: archmoj

src/traces/sunburst/plot.js

@@ -488,12 +488,9 @@ exports.formatSliceLabel = function(pt, entry, trace, cd, fullLayout) {
     var cdi = pt.data.data;
     var hierarchy = cd0.hierarchy;
     var ref;
-    var calcPercent = function() {
-        var refData = ref.data ? ref.data.data : ref;
 
-        return cdi.hasOwnProperty('v') ?
-            cdi.v / refData.v :
-            cdi.value / refData.value;
+    var calcPercent = function() {
+        return (trace.branchvalues ? cdi.v : cdi.value) / (ref.value || ref.v);
     };
 
     if(trace.type === 'treemap' && helpers.isHeader(pt, trace)) {
@@ -549,15 +546,15 @@ exports.formatSliceLabel = function(pt, entry, trace, cd, fullLayout) {
                     addPercent(key);
                 };
 
-                if(hasFlag('percent parent') && parent) {
+                if(hasFlag('percent parent')) {
                     ref = parent;
                     makePercent('parent');
                 }
-                if(hasFlag('percent entry') && parent) {
+                if(hasFlag('percent entry')) {
                     ref = entry;
                     makePercent('entry');
                 }
-                if(hasFlag('percent root') && (parent || helpers.isLeaf(pt))) {
+                if(hasFlag('percent root')) {
                     ref = hierarchy;
                     makePercent('root');
                 }

test/image/baselines/sunburst_values.png

@@ -74,7 +74,7 @@
             "type": "treemap",
             "textinfo": "label+value+percent parent+percent entry+percent root+text+current path",
             "hoverinfo": "all",
-            "name": "with values",
+            "name": "with total values",
             "level": "Oscar",
             "labels": [
                 "Alpha",
@@ -221,7 +221,7 @@
             "type": "treemap",
             "textinfo": "label+value+percent parent+percent entry+percent root+text+current path",
             "hoverinfo": "all",
-            "name": "with values",
+            "name": "with remainder values",
             "level": "Oscar",
             "labels": [
                 "Alpha",

test/image/baselines/treemap_level-depth.png

@@ -1375,9 +1375,10 @@ describe('Test sunburst texttemplate without `values` should work:', function()
     ]);
 });
 
-describe('Test sunburst texttemplate with `values` should work:', function() {
+describe('Test sunburst texttemplate with *total* `values` should work:', function() {
     checkTextTemplate([{
         type: 'sunburst',
+        branchvalues: 'total',
         labels: ['Eve', 'Cain', 'Seth', 'Enos', 'Noam', 'Abel', 'Awan', 'Enoch', 'Azura'],
         parents: ['', 'Eve', 'Eve', 'Seth', 'Seth', 'Eve', 'Eve', 'Awan', 'Eve' ],
         values: [65, 14, 12, 10, 2, 6, 6, 1, 4],
@@ -1391,7 +1392,7 @@ describe('Test sunburst texttemplate with `values` should work:', function() {
         ['%{percentEntry} of %{entry}', ['100% of Eve', '22% of Eve', '18% of Eve', '9% of Eve', '9% of Eve', '6% of Eve', '15% of Eve', '3% of Eve', '2% of Eve']],
         ['%{percentParent} of %{parent}', [
             '%{percentParent} of %{parent}', // TODO: what should be printed for the parent of root?
-            '83% of Seth', '22% of Eve', '18% of Eve', '9% of Eve', '9% of Eve', '6% of Eve', '17% of Seth', '17% of Awan'
+            '22% of Eve', '18% of Eve', '9% of Eve', '9% of Eve', '6% of Eve', '83% of Seth', '17% of Seth', '17% of Awan'
         ]],
         [
             [
@@ -1419,3 +1420,49 @@ describe('Test sunburst texttemplate with `values` should work:', function() {
         ]
     ]);
 });
+
+describe('Test sunburst texttemplate with *remainder* `values` should work:', function() {
+    checkTextTemplate([{
+        type: 'sunburst',
+        branchvalues: 'remainder',
+        labels: ['Eve', 'Cain', 'Seth', 'Enos', 'Noam', 'Abel', 'Awan', 'Enoch', 'Azura'],
+        parents: ['', 'Eve', 'Eve', 'Seth', 'Seth', 'Eve', 'Eve', 'Awan', 'Eve' ],
+        values: [65, 14, 12, 10, 2, 6, 6, 1, 4],
+        text: ['sixty-five', 'fourteen', 'twelve', 'ten', 'two', 'six', 'six', 'one', 'four']
+    }], 'g.slicetext', [
+        ['color: %{color}', ['color: rgba(0,0,0,0)', 'color: #1f77b4', 'color: #ff7f0e', 'color: #2ca02c', 'color: #d62728', 'color: #9467bd', 'color: #ff7f0e', 'color: #ff7f0e', 'color: #d62728']],
+        ['label: %{label}', ['label: Eve', 'label: Cain', 'label: Seth', 'label: Enos', 'label: Noam', 'label: Abel', 'label: Awan', 'label: Enoch', 'label: Azura']],
+        ['value: %{value}', ['value: 65', 'value: 14', 'value: 12', 'value: 10', 'value: 2', 'value: 6', 'value: 6', 'value: 1', 'value: 4']],
+        ['text: %{text}', ['text: sixty-five', 'text: fourteen', 'text: twelve', 'text: ten', 'text: two', 'text: six', 'text: six', 'text: one', 'text: four']],
+        ['%{percentRoot} of %{root}', ['54% of Eve', '10% of Eve', '12% of Eve', '5% of Eve', '5% of Eve', '3% of Eve', '8% of Eve', '2% of Eve', '1% of Eve']],
+        ['%{percentEntry} of %{entry}', ['54% of Eve', '10% of Eve', '12% of Eve', '5% of Eve', '5% of Eve', '3% of Eve', '8% of Eve', '2% of Eve', '1% of Eve']],
+        ['%{percentParent} of %{parent}', [
+            '%{percentParent} of %{parent}', // TODO: what should be printed for the parent of root?
+            '10% of Eve', '12% of Eve', '5% of Eve', '5% of Eve', '3% of Eve', '42% of Seth', '8% of Seth', '14% of Awan'
+        ]],
+        [
+            [
+                'label: %{label}',
+                'text: %{text}',
+                'value: %{value}',
+                '%{percentRoot} of %{root}',
+                '%{percentEntry} of %{entry}',
+                '%{percentParent} of %{parent}',
+                '%{percentParent} of %{parent}',
+                '%{percentParent} of %{parent}',
+                'color: %{color}'
+            ],
+            [
+                'label: Eve',
+                'text: fourteen',
+                'value: 12',
+                '5% of Eve',
+                '5% of Eve',
+                '8% of Eve',
+                '2% of Eve',
+                '14% of Awan',
+                'color: #9467bd'
+            ]
+        ]
+    ]);
+});