Plotly.toImage: format "full-json" now contains config and version key

Author: antoinerg

src/plot_api/to_image.js

@@ -17,6 +17,7 @@ var Lib = require('../lib');
 var helpers = require('../snapshot/helpers');
 var toSVG = require('../snapshot/tosvg');
 var svgToImg = require('../snapshot/svgtoimg');
+var version = require('../core').version;
 
 var attrs = {
     format: {
@@ -171,17 +172,24 @@ function toImage(gd, opts) {
             var width = clonedGd._fullLayout.width;
             var height = clonedGd._fullLayout.height;
 
+            function cleanup() {
+                plotApi.purge(clonedGd);
+                document.body.removeChild(clonedGd);
+            }
+
             if(format === 'full-json') {
-                var json = plots.graphJson(clonedGd, false, 'keepdata', false, true);
+                var json = plots.graphJson(clonedGd, false, 'keepdata', 'object', true, true);
+                json.version = version;
+                json = JSON.stringify(json);
+                cleanup();
                 if(imageDataOnly) {
                     return resolve(json);
                 } else {
                     return resolve(helpers.encodeJSON(json));
                 }
             }
 
-            plotApi.purge(clonedGd);
-            document.body.removeChild(clonedGd);
+            cleanup();
 
             if(format === 'svg') {
                 if(imageDataOnly) {

src/plots/plots.js

@@ -2037,9 +2037,10 @@ plots.didMarginChange = function(margin0, margin1) {
  *      keepall: keep data and src
  * @param {String} output If you specify 'object', the result will not be stringified
  * @param {Boolean} useDefaults If truthy, use _fullLayout and _fullData
+ * @param {Boolean} includeConfig If truthy, include _context
  * @returns {Object|String}
  */
-plots.graphJson = function(gd, dataonly, mode, output, useDefaults) {
+plots.graphJson = function(gd, dataonly, mode, output, useDefaults, includeConfig) {
     // if the defaults aren't supplied yet, we need to do that...
     if((useDefaults && dataonly && !gd._fullData) ||
             (useDefaults && !dataonly && !gd._fullLayout)) {
@@ -2050,18 +2051,21 @@ plots.graphJson = function(gd, dataonly, mode, output, useDefaults) {
     var layout = (useDefaults) ? gd._fullLayout : gd.layout;
     var frames = (gd._transitionData || {})._frames;
 
-    function stripObj(d) {
+    function stripObj(d, keepFunction) {
         if(typeof d === 'function') {
-            return null;
+            return keepFunction ? '_function_' : null;
         }
         if(Lib.isPlainObject(d)) {
             var o = {};
             var v, src;
             for(v in d) {
                 // remove private elements and functions
                 // _ is for private, [ is a mistake ie [object Object]
-                if(typeof d[v] === 'function' ||
-                        ['_', '['].indexOf(v.charAt(0)) !== -1) {
+                if(['_', '['].indexOf(v.charAt(0)) !== -1) continue;
+
+                // if a function, add if necessary then move on
+                if(typeof d[v] === 'function') {
+                    if(keepFunction) o[v] = '_function';
                     continue;
                 }
 
@@ -2091,13 +2095,13 @@ plots.graphJson = function(gd, dataonly, mode, output, useDefaults) {
                 }
 
                 // OK, we're including this... recurse into it
-                o[v] = stripObj(d[v]);
+                o[v] = stripObj(d[v], keepFunction);
             }
             return o;
         }
 
         if(Array.isArray(d)) {
-            return d.map(stripObj);
+            return d.map(function(x) {return stripObj(x, keepFunction);});
         }
 
         if(Lib.isTypedArray(d)) {
@@ -2126,6 +2130,8 @@ plots.graphJson = function(gd, dataonly, mode, output, useDefaults) {
 
     if(frames) obj.frames = stripObj(frames);
 
+    if(includeConfig) obj.config = stripObj(gd._context, true);
+
     return (output === 'object') ? obj : JSON.stringify(obj);
 };
 

test/jasmine/tests/toimage_test.js

@@ -266,12 +266,23 @@ describe('Plotly.toImage', function() {
 
     describe('with format `full-json`', function() {
         var imgOpts = {format: 'full-json', imageDataOnly: true};
+        var gd;
+
+        beforeEach(function() {
+            gd = createGraphDiv();
+        });
+        afterEach(destroyGraphDiv);
+
         it('export a graph div', function(done) {
             Plotly.plot(gd, [{y: [1, 2, 3]}])
-            .then(function() { return Plotly.toImage('graph', imgOpts);})
+            .then(function(gd) { return Plotly.toImage(gd, imgOpts);})
             .then(function(fig) {
                 fig = JSON.parse(fig);
+                ['data', 'layout', 'config'].forEach(function(key) {
+                    expect(fig.hasOwnProperty(key)).toBeTruthy('is missing key: ' + key);
+                });
                 expect(fig.data[0].mode).toBe('lines+markers', 'contain default mode');
+                expect(fig.version).toBe(Plotly.version, 'contains Plotly version');
             })
             .catch(failTest)
             .then(done);
@@ -281,7 +292,11 @@ describe('Plotly.toImage', function() {
             Plotly.toImage({data: [{y: [1, 2, 3]}]}, imgOpts)
             .then(function(fig) {
                 fig = JSON.parse(fig);
+                ['data', 'layout', 'config'].forEach(function(key) {
+                    expect(fig.hasOwnProperty(key)).toBeTruthy('is missing key: ' + key);
+                });
                 expect(fig.data[0].mode).toBe('lines+markers', 'contain default mode');
+                expect(fig.version).toBe(Plotly.version, 'contains Plotly version');
             })
             .catch(failTest)
             .then(done);