PR feedback

Author: nicolaskruchten

src/components/modebar/buttons.js

@@ -60,15 +60,12 @@ modeBarButtons.toImage = {
             opts.format = 'svg';
         }
 
-        if(toImageButtonDefaults.width) {
-            opts.width = toImageButtonDefaults.width;
-        }
-        if(toImageButtonDefaults.height) {
-            opts.height = toImageButtonDefaults.height;
-        }
-        if(toImageButtonDefaults.filename) {
-            opts.filename = toImageButtonDefaults.filename;
-        }
+        ['filename', 'width', 'height', 'scale'].forEach(function(key) {
+            if(toImageButtonDefaults[key]) {
+                opts[key] = toImageButtonDefaults[key];
+            }
+        });
+
         Registry.call('downloadImage', gd, opts)
           .then(function(filename) {
               Lib.notifier(_(gd, 'Snapshot succeeded') + ' - ' + filename, 'long');

src/plot_api/plot_config.js

@@ -116,7 +116,8 @@ module.exports = {
     modeBarButtons: false,
 
     // statically override options for toImage modebar button
-    // allowed keys are format, filename, width, height
+    // allowed keys are format, filename, width, height, scale
+    // see ./components/modebar/buttons.js
     toImageButtonDefaults: {},
 
     // add the plotly logo on the end of the mode bar

test/jasmine/tests/modebar_test.js

@@ -5,6 +5,7 @@ var manageModeBar = require('@src/components/modebar/manage');
 
 var Plotly = require('@lib/index');
 var Plots = require('@src/plots/plots');
+var Registry = require('@src/registry');
 var createGraphDiv = require('../assets/create_graph_div');
 var destroyGraphDiv = require('../assets/destroy_graph_div');
 var selectButton = require('../assets/modebar_button');
@@ -767,6 +768,42 @@ describe('ModeBar', function() {
             }
         }
 
+        describe('toImage handlers', function() {
+            beforeEach(function() {
+                spyOn(Registry, 'call').and.callFake(function() {
+                    return Promise.resolve();
+                });
+                gd = createGraphDiv();
+            });
+
+            it('should use defaults', function(done) {
+                Plotly.plot(gd, {data: [], layout: {}})
+                .then(function() {
+                    selectButton(gd._fullLayout._modeBar, 'toImage').click();
+                    expect(Registry.call).toHaveBeenCalledWith('downloadImage', gd,
+                        {format: 'png'});
+                    done();
+                });
+            });
+
+            it('should accept overriding defaults', function(done) {
+                Plotly.plot(gd, {data: [], layout: {}, config: {
+                    toImageButtonDefaults: {
+                        format: 'svg',
+                        filename: 'x',
+                        unsupported: 'should not pass'
+                    }
+                } })
+                .then(function() {
+                    selectButton(gd._fullLayout._modeBar, 'toImage').click();
+                    expect(Registry.call).toHaveBeenCalledWith('downloadImage', gd,
+                        {format: 'svg', filename: 'x'});
+                    done();
+                });
+            });
+
+        });
+
         describe('cartesian handlers', function() {
 
             beforeEach(function(done) {