Merge pull request #5204 from plotly/list-all-export-formats

Mention the full-json option in the Plotly.toImage warning

Author: archmoj

src/lib/index.js

@@ -1244,3 +1244,20 @@ lib.ensureUniformFontSize = function(gd, baseFont) {
     );
     return out;
 };
+
+/**
+ * provide a human-readable list e.g. "A, B, C and D" with an ending separator
+ *
+ * @param {array} arr : the array to join
+ * @param {string} mainSeparator : main separator
+ * @param {string} lastSeparator : last separator
+ *
+ * @return {string} : joined list
+ */
+lib.join2 = function(arr, mainSeparator, lastSeparator) {
+    var len = arr.length;
+    if(len > 1) {
+        return arr.slice(0, -1).join(mainSeparator) + lastSeparator + arr[len - 1];
+    }
+    return arr.join(mainSeparator);
+};

src/plot_api/to_image.js

@@ -116,7 +116,7 @@ function toImage(gd, opts) {
     }
 
     if(!isImpliedOrValid('format')) {
-        throw new Error('Image format is not jpeg, png, svg or webp.');
+        throw new Error('Export format is not ' + Lib.join2(attrs.format.values, ', ', ' or ') + '.');
     }
 
     var fullOpts = {};

test/jasmine/tests/toimage_test.js

@@ -65,7 +65,7 @@ describe('Plotly.toImage', function() {
         Plotly.plot(gd, fig.data, fig.layout)
         .then(function(gd) {
             expect(function() { Plotly.toImage(gd, {format: 'x'}); })
-                .toThrow(new Error('Image format is not jpeg, png, svg or webp.'));
+                .toThrow(new Error('Export format is not png, jpeg, webp, svg or full-json.'));
         })
         .catch(failTest)
         .then(done);