ignore tex titles for filename

Author: emilykl

src/lib/svg_text_utils.js

@@ -13,6 +13,20 @@ var LINE_SPACING = require('../constants/alignment').LINE_SPACING;
 
 var FIND_TEX = /([^$]*)([$]+[^$]*[$]+)([^$]*)/;
 
+/**
+* Checks whether the given string contains LaTeX markup
+* (delimited by a pair of $ signs) and returns the match array if so.
+*
+* @param {string} str: the string to check for tex
+* @return {?Array} the regex match array (truthy) if the string contains tex,
+*   otherwise null (for an empty/missing string or when no tex delimiters are found).
+*/
+function matchTex(str) {
+    if (!str) return null;
+    return str.match(FIND_TEX);
+};
+exports.matchTex = matchTex;
+
 exports.convertToTspans = function(_context, gd, _callback) {
     var str = _context.text();
 
@@ -21,7 +35,7 @@ exports.convertToTspans = function(_context, gd, _callback) {
     var tex = (!_context.attr('data-notex')) &&
         gd && gd._context.typesetMath &&
         (typeof MathJax !== 'undefined') &&
-        str.match(FIND_TEX);
+        matchTex(str);
 
     var parent = d3.select(_context.node().parentNode);
     if(parent.empty()) return;

src/snapshot/download.js

@@ -1,6 +1,7 @@
 'use strict';
 
 var Lib = require('../lib');
+var svgTextUtils = require('../lib/svg_text_utils');
 
 var toImage = require('../plot_api/to_image');
 
@@ -37,7 +38,12 @@ function downloadImage(gd, opts) {
 
         var potentialFilename = opts.filename || gd.fn;
         if (!potentialFilename) {
-            potentialFilename = Lib.slugify(helpers.getPlotTitle(gd), 40);
+            const plotTitle = helpers.getPlotTitle(gd);
+            // Trying to slugify a LaTeX string can result in weird ugly filenames,
+            // so ignore the title entirely if it contains LaTeX markup
+            if (!svgTextUtils.matchTex(plotTitle)) {
+                potentialFilename = Lib.slugify(plotTitle, 40);
+            }
         }
 
         var filename = potentialFilename || 'plot-image';

test/jasmine/tests/download_test.js

@@ -146,6 +146,14 @@ describe('Plotly.downloadImage', function() {
             })
             .then(done, done.fail);
         }, LONG_TIMEOUT_INTERVAL);
+
+        it('ignores title if it contains LaTeX markup', function(done) {
+            downloadDefault({title: {text: '$\\alpha$ + $\\beta$'}})
+            .then(function(filename) {
+                expect(filename).toBe('plot-image.png');
+            })
+            .then(done, done.fail);
+        }, LONG_TIMEOUT_INTERVAL);
     });
 });