keep _fullLayout container arrays in sync with splices in layout

Author: alexcjohnson

src/plot_api/manage_arrays.js

@@ -103,7 +103,13 @@ exports.editContainerArray = function editContainerArray(gd, np, edits, flags) {
 
     var componentNums = Object.keys(edits).map(Number).sort(),
         componentArrayIn = np.get(),
-        componentArray = componentArrayIn || [];
+        componentArray = componentArrayIn || [],
+        // componentArrayFull is used just to keep splices in line between
+        // full and input arrays, so private keys can be copied over after
+        // redoing supplyDefaults
+        // TODO: this assumes componentArray is in gd.layout - which will not be
+        // true after we extend this to restyle
+        componentArrayFull = nestedProperty(fullLayout, componentType).get();
 
     var deletes = [],
         firstIndexChange = -1,
@@ -142,6 +148,7 @@ exports.editContainerArray = function editContainerArray(gd, np, edits, flags) {
             else if(adding) {
                 if(objVal === 'add') objVal = {};
                 componentArray.splice(componentNum, 0, objVal);
+                if(componentArrayFull) componentArrayFull.splice(componentNum, 0, {});
             }
             else {
                 Loggers.warn('Unrecognized full object edit value',
@@ -160,6 +167,9 @@ exports.editContainerArray = function editContainerArray(gd, np, edits, flags) {
     // now do deletes
     for(i = deletes.length - 1; i >= 0; i--) {
         componentArray.splice(deletes[i], 1);
+        // TODO: this drops private keys that had been stored in componentArrayFull
+        // does this have any ill effects?
+        if(componentArrayFull) componentArrayFull.splice(deletes[i], 1);
     }
 
     if(!componentArray.length) np.set(null);

test/jasmine/tests/annotations_test.js

@@ -255,6 +255,15 @@ describe('annotations relayout', function() {
             anno1 = Lib.extendFlat(annos[1]),
             anno3 = Lib.extendFlat(annos[3]);
 
+        // store some (unused) private keys and make sure they are copied over
+        // correctly during relayout
+        var fullAnnos = gd._fullLayout.annotations;
+        fullAnnos[0]._boo = 'hoo';
+        fullAnnos[1]._foo = 'bar';
+        fullAnnos[3]._cheese = ['gorgonzola', 'gouda', 'gloucester'];
+        // this one gets lost
+        fullAnnos[2]._splat = 'the cat';
+
         Plotly.relayout(gd, {
             'annotations[0].text': 'tortilla',
             'annotations[0].x': 3.45,
@@ -266,21 +275,35 @@ describe('annotations relayout', function() {
         .then(function() {
             expect(countAnnotations()).toEqual(len);
 
+            var fullAnnosAfter = gd._fullLayout.annotations,
+                fullStr = JSON.stringify(fullAnnosAfter);
+
             assertText(0, 'tortilla');
             anno0.text = 'tortilla';
             expect(annos[0]).toEqual(anno0);
+            expect(fullAnnosAfter[0]._boo).toBe('hoo');
+
 
             assertText(1, 'chips');
             expect(annos[1]).toEqual({text: 'chips', x: 1.1, y: 2.2});
+            expect(fullAnnosAfter[1]._foo).toBeUndefined();
 
             assertText(2, 'guacamole');
             anno1.text = 'guacamole';
             expect(annos[2]).toEqual(anno1);
+            expect(fullAnnosAfter[2]._foo).toBe('bar');
+            expect(fullAnnosAfter[2]._splat).toBeUndefined();
 
             assertText(3, 'lime');
             anno3.text = 'lime';
             expect(annos[3]).toEqual(anno3);
+            expect(fullAnnosAfter[3]._cheese).toEqual(['gorgonzola', 'gouda', 'gloucester']);
+
+            expect(fullStr.indexOf('_splat')).toBe(-1);
+            expect(fullStr.indexOf('the cat')).toBe(-1);
+
             expect(Loggers.warn).not.toHaveBeenCalled();
+
         })
         .catch(failTest)
         .then(done);