plotly.js 1.58.3 → 1.58.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "plotly.js",
-  "version": "1.58.3",
+  "version": "1.58.4",
   "description": "The open source javascript graphing library that powers plotly",
   "license": "MIT",
   "main": "./lib/index.js",

package/src/components/colorscale/index.js

@@ -25,7 +25,7 @@ module.exports = {
     calc: require('./calc'),
 
     // ./scales.js is required in lib/coerce.js ;
-    // it needs to be a seperate module to avoid circular a dependency
+    // it needs to be a separate module to avoid circular a dependency
     scales: scales.scales,
     defaultScale: scales.defaultScale,
     getScale: scales.get,

package/src/components/errorbars/attributes.js

@@ -32,7 +32,7 @@ module.exports = {
             'If *percent*, the bar lengths correspond to a percentage of',
             'underlying data. Set this percentage in `value`.',
 
-            'If *sqrt*, the bar lengths correspond to the sqaure of the',
+            'If *sqrt*, the bar lengths correspond to the square of the',
             'underlying data.',
 
             'If *data*, the bar lengths are set with data set `array`.'

package/src/components/fx/hover.js

@@ -1306,7 +1306,7 @@ function getHoverLabelText(d, showCommonLabel, hovermode, fullLayout, t0, g) {
 
 // Make groups of touching points, and within each group
 // move each point so that no labels overlap, but the average
-// label position is the same as it was before moving. Indicentally,
+// label position is the same as it was before moving. Incidentally,
 // this is equivalent to saying all the labels are on equal linear
 // springs about their initial position. Initially, each point is
 // its own group, but as we find overlaps we will clump the points.

package/src/components/sliders/draw.js

@@ -571,7 +571,7 @@ function setGripPosition(sliderGroup, sliderOpts, doTransition) {
             .ease(sliderOpts.transition.easing);
     }
 
-    // Drawing.setTranslate doesn't work here becasue of the transition duck-typing.
+    // Drawing.setTranslate doesn't work here because of the transition duck-typing.
     // It's also not necessary because there are no other transitions to preserve.
     el.attr('transform', strTranslate(x - constants.gripWidth * 0.5, sliderOpts._dims.currentValueTotalHeight));
 }

package/src/lib/index.js

@@ -154,6 +154,7 @@ lib.getElementAndAncestors = domModule.getElementAndAncestors;
 lib.equalDomRects = domModule.equalDomRects;
 
 lib.clearResponsive = require('./clear_responsive');
+lib.preserveDrawingBuffer = require('./preserve_drawing_buffer');
 
 lib.makeTraceGroups = require('./make_trace_groups');
 
@@ -864,7 +865,7 @@ lib.objectFromPath = function(path, value) {
  *   lib.expandObjectPaths({'foo[1].bar': 10, 'foo[0].bar': 20});
  *     => { foo: [{bar: 10}, {bar: 20}] }
  *
- * It does NOT, however, merge mulitple mutliply-nested arrays::
+ * It does NOT, however, merge multiple multiply-nested arrays::
  *
  *   lib.expandObjectPaths({'marker[1].range[1]': 5, 'marker[1].range[0]': 4})
  *     => { marker: [null, {range: 4}] }

package/src/lib/preserve_drawing_buffer.js

@@ -0,0 +1,68 @@
+/**
+* Copyright 2012-2020, Plotly, Inc.
+* All rights reserved.
+*
+* This source code is licensed under the MIT license found in the
+* LICENSE file in the root directory of this source tree.
+*/
+
+'use strict';
+
+var isNumeric = require('fast-isnumeric');
+var isMobileOrTablet = require('is-mobile');
+
+module.exports = function preserveDrawingBuffer(opts) {
+    var ua;
+
+    if(opts && opts.hasOwnProperty('userAgent')) {
+        ua = opts.userAgent;
+    } else {
+        ua = getUserAgent();
+    }
+
+    if(typeof ua !== 'string') return true;
+
+    var enable = isMobileOrTablet({
+        ua: { headers: {'user-agent': ua }},
+        tablet: true,
+        featureDetect: false
+    });
+
+    if(!enable) {
+        var allParts = ua.split(' ');
+        for(var i = 1; i < allParts.length; i++) {
+            var part = allParts[i];
+            if(part.indexOf('Safari') !== -1) {
+                // find Safari version
+                for(var k = i - 1; k > -1; k--) {
+                    var prevPart = allParts[k];
+                    if(prevPart.substr(0, 8) === 'Version/') {
+                        var v = prevPart.substr(8).split('.')[0];
+                        if(isNumeric(v)) v = +v;
+                        if(v >= 13) return true;
+                    }
+                }
+            }
+        }
+    }
+
+    return enable;
+};
+
+function getUserAgent() {
+    // similar to https://github.com/juliangruber/is-mobile/blob/91ca39ccdd4cfc5edfb5391e2515b923a730fbea/index.js#L14-L17
+    var ua;
+    if(typeof navigator !== 'undefined') {
+        ua = navigator.userAgent;
+    }
+
+    if(
+        ua &&
+        ua.headers &&
+        typeof ua.headers['user-agent'] === 'string'
+    ) {
+        ua = ua.headers['user-agent'];
+    }
+
+    return ua;
+}

package/src/plot_api/plot_api.js

@@ -3231,7 +3231,7 @@ function animate(gd, frameOrGroupNameOrFrameList, animationOpts) {
     }
 
     // Execute a callback after the wrapper function has been called n times.
-    // This is used to defer the resolution until a transition has resovled *and*
+    // This is used to defer the resolution until a transition has resolved *and*
     // the frame has completed. If it's not done this way, then we get a race
     // condition in which the animation might resolve before a transition is complete
     // or vice versa.

package/src/plots/gl3d/scene.js

@@ -18,6 +18,7 @@ var passiveSupported = require('has-passive-events');
 
 var Registry = require('../../registry');
 var Lib = require('../../lib');
+var preserveDrawingBuffer = Lib.preserveDrawingBuffer();
 
 var Axes = require('../../plots/cartesian/axes');
 var Fx = require('../../components/fx');
@@ -30,9 +31,6 @@ var createAxesOptions = require('./layout/convert');
 var createSpikeOptions = require('./layout/spikes');
 var computeTickMarks = require('./layout/tick_marks');
 
-var isMobile = require('is-mobile')({ tablet: true, featureDetect: true });
-
-
 var STATIC_CANVAS, STATIC_CONTEXT;
 
 function Scene(options, fullLayout) {
@@ -98,7 +96,7 @@ proto.prepareOptions = function() {
         canvas: scene.canvas,
         gl: scene.gl,
         glOptions: {
-            preserveDrawingBuffer: isMobile,
+            preserveDrawingBuffer: preserveDrawingBuffer,
             premultipliedAlpha: true,
             antialias: true
         },
@@ -148,26 +146,26 @@ proto.tryCreatePlot = function() {
     try {
         scene.glplot = createPlot(opts);
     } catch(e) {
-        if(scene.staticMode || !firstInit) {
+        if(scene.staticMode || !firstInit || preserveDrawingBuffer) {
             success = false;
         } else { // try second time
+            // enable preserveDrawingBuffer setup
+            // in case is-mobile not detecting the right device
+            Lib.warn([
+                'webgl setup failed possibly due to',
+                'false preserveDrawingBuffer config.',
+                'The mobile/tablet device may not be detected by is-mobile module.',
+                'Enabling preserveDrawingBuffer in second attempt to create webgl scene...'
+            ].join(' '));
+
             try {
-                // invert preserveDrawingBuffer setup which could be resulted from is-mobile not detecting the right device
-                Lib.warn([
-                    'webgl setup failed possibly due to',
-                    isMobile ? 'disabling' : 'enabling',
-                    'preserveDrawingBuffer config.',
-                    'The device may not be supported by is-mobile module!',
-                    'Inverting preserveDrawingBuffer option in second attempt to create webgl scene.'
-                ].join(' '));
-
-                // invert is-mobile
-                isMobile = opts.glOptions.preserveDrawingBuffer = !opts.glOptions.preserveDrawingBuffer;
+                // invert preserveDrawingBuffer
+                preserveDrawingBuffer = opts.glOptions.preserveDrawingBuffer = true;
 
                 scene.glplot = createPlot(opts);
             } catch(e) {
-                // revert changes to is-mobile
-                isMobile = opts.glOptions.preserveDrawingBuffer = !opts.glOptions.preserveDrawingBuffer;
+                // revert changes to preserveDrawingBuffer
+                preserveDrawingBuffer = opts.glOptions.preserveDrawingBuffer = false;
 
                 success = false;
             }

package/src/traces/carpet/attributes.js

@@ -37,7 +37,7 @@ module.exports = {
         editType: 'calc+clearAxisTypes',
         description: [
             'A two dimensional array of x coordinates at each carpet point.',
-            'If ommitted, the plot is a cheater plot and the xaxis is hidden',
+            'If omitted, the plot is a cheater plot and the xaxis is hidden',
             'by default.'
         ].join(' ')
     },
@@ -109,7 +109,7 @@ module.exports = {
         editType: 'calc',
         description: [
             'The shift applied to each successive row of data in creating a cheater plot.',
-            'Only used if `x` is been ommitted.'
+            'Only used if `x` is been omitted.'
         ].join(' ')
     },
     aaxis: axisAttrs,

package/src/traces/carpet/create_i_derivative_evaluator.js

@@ -19,7 +19,7 @@
  * Also note that the discontinuity of the derivative is in magnitude only. The direction *is*
  * continuous across cell boundaries.
  *
- * For example, to compute the derivative of the xcoordinate halfway betwen the 7 and 8th i-gridpoints
+ * For example, to compute the derivative of the xcoordinate halfway between the 7 and 8th i-gridpoints
  * and the 10th and 11th j-gridpoints given bicubic smoothing in both dimensions, you'd write:
  *
  *     var deriv = createIDerivativeEvaluator([x], 1, 1);

package/src/traces/carpet/plot.js

@@ -45,7 +45,7 @@ module.exports = function plot(gd, plotinfo, cdcarpet, carpetLayer) {
         drawGridLines(xa, ya, minorLayer, aax, 'a', aax._minorgridlines, true);
         drawGridLines(xa, ya, minorLayer, bax, 'b', bax._minorgridlines, true);
 
-        // NB: These are not ommitted if the lines are not active. The joins must be executed
+        // NB: These are not omitted if the lines are not active. The joins must be executed
         // in order for them to get cleaned up without a full redraw
         drawGridLines(xa, ya, boundaryLayer, aax, 'a-boundary', aax._boundarylines);
         drawGridLines(xa, ya, boundaryLayer, bax, 'b-boundary', bax._boundarylines);

package/src/traces/carpet/set_convert.js

@@ -215,7 +215,7 @@ module.exports = function setConvert(trace) {
 
         var i0 = Math.max(0, Math.min(a.length - 2, i));
 
-        // The step (demoninator) is implicitly 1 since that's the grid spacing.
+        // The step (denominator) is implicitly 1 since that's the grid spacing.
         return a[i0 + 1] - a[i0];
     };
 
@@ -223,7 +223,7 @@ module.exports = function setConvert(trace) {
         // See above caveats for dadi which also apply here
         var j0 = Math.max(0, Math.min(b.length - 2, j));
 
-        // The step (demoninator) is implicitly 1 since that's the grid spacing.
+        // The step (denominator) is implicitly 1 since that's the grid spacing.
         return b[j0 + 1] - b[j0];
     };
 

package/src/traces/carpet/smooth_fill_2d_array.js

@@ -200,7 +200,7 @@ module.exports = function smoothFill2dArray(data, a, b) {
             overrelaxation = boundaryCnt ? 0 : 0.85;
 
             // If there are four non-null neighbors, then we want a simple average without
-            // overrelaxation. If all the surrouding points are null, then we want the full
+            // overrelaxation. If all the surrounding points are null, then we want the full
             // overrelaxation
             //
             // Based on experiments, this actually seems to slow down convergence just a bit.

package/src/traces/parcats/attributes.js

@@ -75,7 +75,7 @@ module.exports = {
         ],
         description: [
             'This value here applies when hovering over dimensions.',
-            'Note tath `*categorycount`, *colorcount* and *bandcolorcount*',
+            'Note that `*categorycount`, *colorcount* and *bandcolorcount*',
             'are only available when `hoveron` contains the *color* flag'
         ].join(' ')
     }),

package/src/traces/scatter/plot.js

@@ -491,7 +491,7 @@ function plotOne(gd, idx, plotinfo, cdscatter, cdscatterAll, element, transition
         join.selectAll('text')
             .call(Drawing.textPointStyle, trace, gd)
             .each(function(d) {
-                // This just *has* to be totally custom becuase of SVG text positioning :(
+                // This just *has* to be totally custom because of SVG text positioning :(
                 // It's obviously copied from translatePoint; we just can't use that
                 var x = xa.c2p(d.x);
                 var y = ya.c2p(d.y);

package/src/traces/scattercarpet/plot.js

@@ -30,7 +30,7 @@ module.exports = function plot(gd, plotinfoproxy, data, layer) {
         trace = data[i][0].trace;
 
         // Note: .select is adequate but seems to mutate the node data,
-        // which is at least a bit suprising and causes problems elsewhere
+        // which is at least a bit surprising and causes problems elsewhere
         node = layer.selectAll('g.trace' + trace.uid + ' .js-line');
 
         // Note: it would be more efficient if this didn't need to be applied

package/src/version.js

@@ -9,4 +9,4 @@
 'use strict';
 
 // package version injected by `npm run preprocess`
-exports.version = '1.58.3';
+exports.version = '1.58.4';