override toImage modebar button opts via config

nicolaskruchten · nicolaskruchten · commit e4c6c5c5ab09 · 2018-05-02T23:25:08.000-04:00
diff --git a/src/components/modebar/buttons.js b/src/components/modebar/buttons.js
@@ -47,19 +47,29 @@ var modeBarButtons = module.exports = {};
 
 modeBarButtons.toImage = {
     name: 'toImage',
-    title: function(gd) { return _(gd, 'Download plot as a png'); },
+    title: function(gd) { return _(gd, 'Download plot'); },
     icon: Icons.camera,
     click: function(gd) {
-        var format = 'png';
+        var toImageButtonDefaults = gd._context.toImageButtonDefaults;
+        var opts = {format: toImageButtonDefaults.format || 'png'};
 
         Lib.notifier(_(gd, 'Taking snapshot - this may take a few seconds'), 'long');
 
         if(Lib.isIE()) {
             Lib.notifier(_(gd, 'IE only supports svg.  Changing format to svg.'), 'long');
-            format = 'svg';
+            opts.format = 'svg';
         }
 
-        Registry.call('downloadImage', gd, {'format': format})
+        if(toImageButtonDefaults.width) {
+            opts.width = toImageButtonDefaults.width;
+        }
+        if(toImageButtonDefaults.height) {
+            opts.height = toImageButtonDefaults.height;
+        }
+        if(toImageButtonDefaults.filename) {
+            opts.filename = toImageButtonDefaults.filename;
+        }
+        Registry.call('downloadImage', gd, opts)
           .then(function(filename) {
               Lib.notifier(_(gd, 'Snapshot succeeded') + ' - ' + filename, 'long');
           })
diff --git a/src/plot_api/plot_config.js b/src/plot_api/plot_config.js
@@ -115,6 +115,10 @@ module.exports = {
      */
     modeBarButtons: false,
 
+    // statically override options for toImage modebar button
+    // allowed keys are format, filename, width, height
+    toImageButtonDefaults: {},
+
     // add the plotly logo on the end of the mode bar
     displaylogo: true,
 
