add toImage *scale* tests and 📚

etpinard · etpinard · commit 971e3b5919f3 · 2017-08-31T19:11:14.000-04:00
diff --git a/src/plot_api/to_image.js b/src/plot_api/to_image.js
@@ -45,7 +45,10 @@ var attrs = {
         min: 0,
         dflt: 1,
         description: [
-            '...'
+            'Sets a scaling for the generated image.',
+            'If set, all features of a graphs (e.g. text, line width)',
+            'are scaled, unlike simply setting',
+            'a bigger *width* and *height*.'
         ].join(' ')
     },
     setBackground: {
@@ -137,7 +140,6 @@ function toImage(gd, opts) {
     // extend config for static plot
     var configImage = Lib.extendFlat({}, config, {
         staticPlot: true,
-        plotGlPixelRatio: config.plotGlPixelRatio || 2,
         setBackground: setBackground
     });
 
diff --git a/test/jasmine/tests/snapshot_test.js b/test/jasmine/tests/snapshot_test.js
@@ -301,5 +301,25 @@ describe('Plotly.Snapshot', function() {
             .catch(fail)
             .then(done);
         });
+
+        it('should adapt *viewBox* attribute under *scale* option', function(done) {
+            Plotly.plot(gd, [{
+                y: [1, 2, 1]
+            }], {
+                width: 300,
+                height: 400
+            })
+            .then(function() {
+                var str = Plotly.Snapshot.toSVG(gd, 'svg', 2.5);
+                var dom = parser.parseFromString(str, 'image/svg+xml');
+                var el = dom.getElementsByTagName('svg')[0];
+
+                expect(el.getAttribute('width')).toBe('750', 'width');
+                expect(el.getAttribute('height')).toBe('1000', 'height');
+                expect(el.getAttribute('viewBox')).toBe('0 0 300 400', 'viewbox');
+            })
+            .catch(fail)
+            .then(done);
+        });
     });
 });
diff --git a/test/jasmine/tests/toimage_test.js b/test/jasmine/tests/toimage_test.js
@@ -7,6 +7,8 @@ var fail = require('../assets/fail_test');
 var customMatchers = require('../assets/custom_matchers');
 var subplotMock = require('@mocks/multiple_subplots.json');
 
+var FORMATS = ['png', 'jpeg', 'webp', 'svg'];
+
 describe('Plotly.toImage', function() {
     'use strict';
 
@@ -31,6 +33,19 @@ describe('Plotly.toImage', function() {
         });
     }
 
+    function assertSize(url, width, height) {
+        return new Promise(function(resolve, reject) {
+            var img = new Image();
+            img.onload = function() {
+                expect(img.width).toBe(width, 'image width');
+                expect(img.height).toBe(height, 'image height');
+                resolve(url);
+            };
+            img.onerror = reject;
+            img.src = url;
+        });
+    }
+
     it('should be attached to Plotly', function() {
         expect(Plotly.toImage).toBeDefined();
     });
@@ -109,18 +124,22 @@ describe('Plotly.toImage', function() {
 
         Plotly.plot(gd, fig.data, fig.layout)
         .then(function() { return Plotly.toImage(gd, {format: 'png'}); })
+        .then(function(url) { return assertSize(url, 700, 450); })
         .then(function(url) {
             expect(url.split('png')[0]).toBe('data:image/');
         })
         .then(function() { return Plotly.toImage(gd, {format: 'jpeg'}); })
+        .then(function(url) { return assertSize(url, 700, 450); })
         .then(function(url) {
             expect(url.split('jpeg')[0]).toBe('data:image/');
         })
         .then(function() { return Plotly.toImage(gd, {format: 'svg'}); })
+        .then(function(url) { return assertSize(url, 700, 450); })
         .then(function(url) {
             expect(url.split('svg')[0]).toBe('data:image/');
         })
         .then(function() { return Plotly.toImage(gd, {format: 'webp'}); })
+        .then(function(url) { return assertSize(url, 700, 450); })
         .then(function(url) {
             expect(url.split('webp')[0]).toBe('data:image/');
         })
@@ -156,6 +175,20 @@ describe('Plotly.toImage', function() {
         .then(done);
     });
 
+    FORMATS.forEach(function(f) {
+        it('should respond to *scale* option ( format ' + f + ')', function(done) {
+            var fig = Lib.extendDeep({}, subplotMock);
+
+            Plotly.plot(gd, fig.data, fig.layout)
+            .then(function() { return Plotly.toImage(gd, {format: f, scale: 2}); })
+            .then(function(url) { return assertSize(url, 1400, 900); })
+            .then(function() { return Plotly.toImage(gd, {format: f, scale: 0.5}); })
+            .then(function(url) { return assertSize(url, 350, 225); })
+            .catch(fail)
+            .then(done);
+        });
+    });
+
     it('should accept data/layout/config figure object as input', function(done) {
         var fig = Lib.extendDeep({}, subplotMock);
 
