rename colorscales YIGnBu -> YlGnBu and YIOrRd -> YlOrRd :

- add backward compatible clean data step
- add cleanData tests

Author: etpinard

src/components/colorscale/scales.js

@@ -14,7 +14,7 @@ module.exports = {
         [0, 'rgb(0,0,0)'], [1, 'rgb(255,255,255)']
     ],
 
-    'YIGnBu': [
+    'YlGnBu': [
         [0, 'rgb(8, 29, 88)'], [0.125, 'rgb(37, 52, 148)'],
         [0.25, 'rgb(34, 94, 168)'], [0.375, 'rgb(29, 145, 192)'],
         [0.5, 'rgb(65, 182, 196)'], [0.625, 'rgb(127, 205, 187)'],
@@ -30,7 +30,7 @@ module.exports = {
         [1, 'rgb(247, 252, 245)']
     ],
 
-    'YIOrRd': [
+    'YlOrRd': [
         [0, 'rgb(128, 0, 38)'], [0.125, 'rgb(189, 0, 38)'],
         [0.25, 'rgb(227, 26, 28)'], [0.375, 'rgb(252, 78, 42)'],
         [0.5, 'rgb(253, 141, 60)'], [0.625, 'rgb(254, 178, 76)'],

src/plot_api/plot_api.js

@@ -670,6 +670,7 @@ function cleanData(data, existingData) {
 
     for(var tracei = 0; tracei < data.length; tracei++) {
         var trace = data[tracei];
+
         // assign uids to each trace and detect collisions.
         if(!('uid' in trace) || suids.indexOf(trace.uid) !== -1) {
             var newUid, i;
@@ -750,6 +751,17 @@ function cleanData(data, existingData) {
             }
         }
 
+        // fix typo in colorscale definition
+        if(Plots.traceIs(trace, '2dMap')) {
+            if(trace.colorscale === 'YIGnBu') trace.colorscale = 'YlGnBu';
+            if(trace.colorscale === 'YIOrRd') trace.colorscale = 'YlOrRd';
+        }
+        if(Plots.traceIs(trace, 'markerColorscale') && trace.marker) {
+            var cont = trace.marker;
+            if(cont.colorscale === 'YIGnBu') cont.colorscale = 'YlGnBu';
+            if(cont.colorscale === 'YIOrRd') cont.colorscale = 'YlOrRd';
+        }
+
         // prune empty containers made before the new nestedProperty
         if(emptyContainer(trace, 'line')) delete trace.line;
         if('marker' in trace) {

test/jasmine/tests/plot_api_test.js

@@ -7,6 +7,9 @@ var Bar = require('@src/traces/bar');
 var Legend = require('@src/components/legend');
 var pkg = require('../../../package.json');
 
+var createGraphDiv = require('../assets/create_graph_div');
+var destroyGraphDiv = require('../assets/destroy_graph_div');
+
 
 describe('Test plot api', function() {
     'use strict';
@@ -616,4 +619,54 @@ describe('Test plot api', function() {
             expect(gd.data).toEqual(cachedData);
         });
     });
+
+    describe('cleanData', function() {
+        var gd;
+
+        beforeEach(function() {
+            gd = createGraphDiv();
+        });
+
+        afterEach(destroyGraphDiv);
+
+        it('should rename \'YIGnBu\' colorscales YlGnBu (2dMap case)', function() {
+            var data = [{
+                type: 'heatmap',
+                colorscale: 'YIGnBu'
+            }];
+
+            Plotly.plot(gd, data);
+            expect(gd.data[0].colorscale).toBe('YlGnBu');
+        });
+
+        it('should rename \'YIGnBu\' colorscales YlGnBu (markerColorscale case)', function() {
+            var data = [{
+                type: 'scattergeo',
+                marker: { colorscale: 'YIGnBu' }
+            }];
+
+            Plotly.plot(gd, data);
+            expect(gd.data[0].marker.colorscale).toBe('YlGnBu');
+        });
+
+        it('should rename \'YIOrRd\' colorscales YlOrRd (2dMap case)', function() {
+            var data = [{
+                type: 'contour',
+                colorscale: 'YIOrRd'
+            }];
+
+            Plotly.plot(gd, data);
+            expect(gd.data[0].colorscale).toBe('YlOrRd');
+        });
+
+        it('should rename \'YIOrRd\' colorscales YlOrRd (markerColorscale case)', function() {
+            var data = [{
+                type: 'scattergeo',
+                marker: { colorscale: 'YIOrRd' }
+            }];
+
+            Plotly.plot(gd, data);
+            expect(gd.data[0].marker.colorscale).toBe('YlOrRd');
+        });
+    });
 });