hook in uirevision for sunburst click handler

Author: etpinard

src/plot_api/plot_api.js

@@ -2524,6 +2524,7 @@ var traceUIControlPatterns = [
     // "visible" includes trace.transforms[i].styles[j].value.visible
     {pattern: /(^|value\.)visible$/, attr: 'legend.uirevision'},
     {pattern: /^dimensions\[\d+\]\.constraintrange/},
+    {pattern: /^level$/},
 
     // below this you must be in editable: true mode
     // TODO: I still put name and title with `trace.uirevision`

src/traces/sunburst/attributes.js

@@ -64,7 +64,6 @@ module.exports = {
         valType: 'any',
         editType: 'plot',
         role: 'info',
-        dflt: '',
         description: [
             'Sets the level from which this sunburst trace hierarchy is rendered.',
             'Set `level` to `\'\'` to start the sunburst from the root node in the hierarchy.',

src/traces/sunburst/plot.js

@@ -712,6 +712,10 @@ function attachFxHandlers(sliceTop, gd, cd) {
         // we could remove this check later
         if(gd._transitioning) return;
 
+        // store 'old' level in guiEdit stash, so that subsequent Plotly.react
+        // calls with the same uirevision can start from the same entry
+        Registry.call('_storeDirectGUIEdit', traceNow, fullLayoutNow._tracePreGUI[traceNow.uid], {level: traceNow.level});
+
         var hierarchy = cd0.hierarchy;
         var id = getPtId(pt);
         var nextEntry = isEntry(pt) ?
@@ -738,8 +742,6 @@ function attachFxHandlers(sliceTop, gd, cd) {
 
         Fx.loneUnhover(fullLayoutNow._hoverlayer.node());
         Registry.call('animate', gd, frame, animOpts);
-
-        // TODO hook in uirevision
     });
 }
 

test/jasmine/tests/plot_api_react_test.js

@@ -1864,6 +1864,42 @@ describe('Plotly.react and uirevision attributes', function() {
 
         _run(fig, editComponents, checkInitial, checkEdited).then(done);
     });
+
+    it('preserves sunburst level changes', function(done) {
+        function assertLevel(msg, exp) {
+            expect(gd._fullData[0].level).toBe(exp, msg);
+        }
+
+        Plotly.react(gd, [{
+            type: 'sunburst',
+            labels: ['Eve', 'Cain', 'Seth', 'Enos', 'Noam', 'Abel', 'Awan', 'Enoch', 'Azura'],
+            parents: ['', 'Eve', 'Eve', 'Seth', 'Seth', 'Eve', 'Eve', 'Awan', 'Eve'],
+            uirevision: 1
+        }])
+        .then(function() {
+            assertLevel('no set level at start', undefined);
+        })
+        .then(function() {
+            var nodeSeth = d3.select('.slice:nth-child(2)').node();
+            mouseEvent('click', 0, 0, {element: nodeSeth});
+        })
+        .then(function() {
+            assertLevel('after clicking on Seth sector', 'Seth');
+        })
+        .then(function() {
+            return Plotly.react(gd, [{
+                type: 'sunburst',
+                labels: ['Eve', 'Cain', 'Seth', 'Enos', 'Noam', 'Abel', 'Awan', 'Enoch', 'Azura', 'Joe'],
+                parents: ['', 'Eve', 'Eve', 'Seth', 'Seth', 'Eve', 'Eve', 'Awan', 'Eve', 'Seth'],
+                uirevision: 1
+            }]);
+        })
+        .then(function() {
+            assertLevel('after reacting with new data, but with same uirevision', 'Seth');
+        })
+        .catch(failTest)
+        .then(done);
+    });
 });
 
 describe('Test Plotly.react + interactions under uirevision:', function() {