plotly.js 2.9.0 → 2.11.0

package/.circleci/config.yml

@@ -89,7 +89,7 @@ jobs:
     environment:
       # Alaska time (arbitrary timezone to test date logic)
       TZ: "America/Anchorage"
-    parallelism: 8
+    parallelism: 12
     working_directory: ~/plotly.js
     steps:
       - browser-tools/install-browser-tools: &browser-versions
@@ -216,6 +216,24 @@ jobs:
           name: Test MathJax on firefox-latest
           command: .circleci/test.sh mathjax-firefox82+
 
+  make-baselines-mathjax3:
+    docker:
+      - image: circleci/python:3.8.9
+    working_directory: ~/plotly.js
+    steps:
+      - attach_workspace:
+          at: ~/
+      - run:
+          name: Install kaleido, plotly.io and required fonts
+          command: .circleci/env_image.sh
+      - run:
+          name: Create mathjax v3 png files
+          command: .circleci/test.sh make-baselines-mathjax3
+      - persist_to_workspace:
+          root: ~/
+          paths:
+            - plotly.js
+
   make-baselines:
     parallelism: 4
     docker:
@@ -249,6 +267,20 @@ jobs:
           path: build
           destination: /
 
+  test-baselines-mathjax3:
+    docker:
+      - image: circleci/node:16.8.0
+    working_directory: ~/plotly.js
+    steps:
+      - attach_workspace:
+          at: ~/
+      - run:
+          name: Compare pixels of mathjax v3 baselines
+          command: .circleci/test.sh test-image-mathjax3
+      - store_artifacts:
+          path: build
+          destination: /
+
   make-exports:
     docker:
       - image: circleci/python:3.8.9
@@ -413,6 +445,12 @@ workflows:
       - flaky-no-gl-jasmine:
           requires:
             - install-and-cibuild
+      - make-baselines-mathjax3:
+          requires:
+            - install-and-cibuild
+      - test-baselines-mathjax3:
+          requires:
+            - make-baselines-mathjax3
       - make-baselines:
           requires:
             - install-and-cibuild

package/.circleci/test.sh

@@ -75,7 +75,15 @@ case $1 in
         ;;
 
     mathjax-firefox82+)
-        ./node_modules/karma/bin/karma start test/jasmine/karma.conf.js --FF --skip-tags=noFF82 --bundleTest=mathjax --nowatch || EXIT_STATE=$?
+        ./node_modules/karma/bin/karma start test/jasmine/karma.conf.js --FF --bundleTest=mathjax --skip-tags=noFF82 --nowatch &&
+        ./node_modules/karma/bin/karma start test/jasmine/karma.conf.js --FF --bundleTest=mathjax --mathjax3 --skip-tags=noFF82 --nowatch &&
+        ./node_modules/karma/bin/karma start test/jasmine/karma.conf.js --FF --bundleTest=mathjax_config --mathjax3 --nowatch &&
+        ./node_modules/karma/bin/karma start test/jasmine/karma.conf.js --FF --bundleTest=mathjax_config --nowatch || EXIT_STATE=$?
+        exit $EXIT_STATE
+        ;;
+
+    make-baselines-mathjax3)
+        python3 test/image/make_baseline.py mathjax3    legend_mathjax_title_and_items mathjax parcats_grid_subplots table_latex_multitrace_scatter table_plain_birds table_wrapped_birds ternary-mathjax || EXIT_STATE=$?
         exit $EXIT_STATE
         ;;
 
@@ -90,6 +98,11 @@ case $1 in
         exit $EXIT_STATE
         ;;
 
+    test-image-mathjax3)
+        node test/image/compare_pixels_test.js mathjax3 || { tar -cvf build/baselines.tar build/test_images/*.png ; exit 1 ; } || EXIT_STATE=$?
+        exit $EXIT_STATE
+        ;;
+
     source-syntax)
         npm run lint        || EXIT_STATE=$?
         npm run test-syntax || EXIT_STATE=$?

package/CHANGELOG.md

@@ -9,10 +9,33 @@ To see all merged commits on the master branch that will be part of the next plo
 
 where X.Y.Z is the semver of most recent plotly.js release.
 
+## [2.11.0] -- 2022-03-11
+
+### Added
+ - Add a CSP complaint variation of regl-based traces i.e. `parcoords`, `splom`, `scattergl`, `scatterpolargl` to the "strict" bundle [[#6083](https://github.com/plotly/plotly.js/pull/6083)]
+ - Add `scattersmith` trace to the "strict" bundle [[#6135](https://github.com/plotly/plotly.js/pull/6135)]
+
+
+## [2.10.1] -- 2022-03-08
+
+### Fixed
+ - Fix `mesh3d` generation when `alphahull` is a positive number (regression introduced in 2.5.1) [[#6133](https://github.com/plotly/plotly.js/pull/6133)]
+
+
+## [2.10.0] -- 2022-03-04
+
+### Added
+ - Add support to use version 3 of MathJax and add `typesetMath` attribute to config [[#6073](https://github.com/plotly/plotly.js/pull/6073)],
+   with thanks to [Equinor](https://www.equinor.com) for sponsoring the related development!
+ - Add `fillpattern` options to `scatter` trace [[#6101](https://github.com/plotly/plotly.js/pull/6101)],
+   with thanks to @s417-lama for the contribution!
+
+
 ## [2.9.0] -- 2022-02-04
 
 ### Added
- - Implement `ticklabelstep` to reduce labels on 2D axes and colorbars [[#6088](https://github.com/plotly/plotly.js/pull/6088)]
+ - Implement `ticklabelstep` to reduce labels on 2D axes and colorbars [[#6088](https://github.com/plotly/plotly.js/pull/6088)],
+   this feature was anonymously sponsored: thank you to our sponsor!
 
 ### Changed
  - Display the version of plotly.js when hovering over the modebar [[#6077](https://github.com/plotly/plotly.js/pull/6077)]

package/CONTRIBUTING.md

@@ -118,7 +118,7 @@ npm start
 
 This command bundles up the source files with source maps using
 [browserify](https://github.com/substack/node-browserify), starts a
-[watchify](https://github.com/substack/watchify) file watcher (making the your
+[watchify](https://github.com/substack/watchify) file watcher (making your
 dev plotly.js bundle update every time a source file is saved) and opens up a
 tab in your browser.
 
@@ -162,6 +162,23 @@ npm run schema
 
 **IMPORTANT:** please do not change and commit any files in the "dist" folder
 
+#### Step 9: REGL - Review & commit potential changes to precompiled regl shaders
+
+If you are implementing a new feature that involves regl shaders, or if you are
+making changes that affect the usage of regl shaders, you would need to run
+
+```bash
+npm run regl-codegen
+```
+
+to regenerate the regl code. This opens a browser window, runs through all
+traces with 'regl' in the tags, and stores the captured code into 
+[src/generated/regl-codegen](https://github.com/plotly/plotly.js/blob/master/src/generated/regl-codegen). If no updates are necessary, it would be a no-op, but
+if there are changes, you would need to commit them.
+
+This is needed because regl performs codegen in runtime which breaks CSP
+compliance, and so for strict builds we pre-generate regl shader code here.
+
 #### Other npm scripts that may be of interest in development
 
 - `npm run preprocess`: pre-processes the css and svg source file in js. This

package/README.md

@@ -55,7 +55,7 @@ You may also consider using [`plotly.js-dist`](https://www.npmjs.com/package/plo
 
 ```html
 <head>
-    <script src="https://cdn.plot.ly/plotly-2.9.0.min.js"></script>
+    <script src="https://cdn.plot.ly/plotly-2.11.0.min.js"></script>
 </head>
 <body>
     <div id="gd"></div>
@@ -72,7 +72,7 @@ You may also consider using [`plotly.js-dist`](https://www.npmjs.com/package/plo
 Alternatively you may consider using [native ES6 import](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules) in the script tag.
 ```html
 <script type="module">
-    import "https://cdn.plot.ly/plotly-2.9.0.min.js"
+    import "https://cdn.plot.ly/plotly-2.11.0.min.js"
     Plotly.newPlot("gd", [{ y: [1, 2, 3] }])
 </script>
 ```
@@ -82,16 +82,24 @@ Fastly supports Plotly.js with free CDN service. Read more at <https://www.fastl
 ### Un-minified versions are also available on CDN
 While non-minified source files may contain characters outside UTF-8, it is recommended that you specify the `charset` when loading those bundles.
 ```html
-<script src="https://cdn.plot.ly/plotly-2.9.0.js" charset="utf-8"></script>
+<script src="https://cdn.plot.ly/plotly-2.11.0.js" charset="utf-8"></script>
 ```
 
 > Please note that as of v2 the "plotly-latest" outputs (e.g. https://cdn.plot.ly/plotly-latest.min.js) will no longer be updated on the CDN, and will stay at the last v1 patch v1.58.5. Therefore, to use the CDN with plotly.js v2 and higher, you must specify an exact plotly.js version.
 
-To support MathJax, you need to load version two of MathJax e.g. `v2.7.5` files from CDN or npm.
+To support MathJax, you could load either version two or version three of MathJax files, for example:
 ```html
 <script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js?config=TeX-AMS-MML_SVG.js"></script>
 ```
 
+```html
+<script src="https://cdn.jsdelivr.net/npm/mathjax@3.2.0/es5/tex-svg.js"></script>
+```
+
+> When using MathJax version 3, it is also possible to use `chtml` output on the other parts of the page in addition to `svg` output for the plotly graph.
+Please refer to `devtools/test_dashboard/index-mathjax3chtml.html` to see an example.
+
+
 ## Bundles
 There are two kinds of plotly.js bundles:
 1. Complete and partial official bundles that are distributed to `npm` and the `CDN`, described in [the dist README](https://github.com/plotly/plotly.js/blob/master/dist/README.md).

package/dist/README.md

@@ -46,9 +46,9 @@ The main plotly.js bundles weight in at:
 | 8.3 MB | 3.5 MB | 1 MB | 8.6 MB |
 
 #### CDN links
-> https://cdn.plot.ly/plotly-2.9.0.js
+> https://cdn.plot.ly/plotly-2.11.0.js
 
-> https://cdn.plot.ly/plotly-2.9.0.min.js
+> https://cdn.plot.ly/plotly-2.11.0.min.js
 
 
 #### npm packages
@@ -79,7 +79,7 @@ plotly.js also ships with several _partial_ bundles:
 
 > The minified version of each partial bundle is also published to npm in a separate "dist-min" package.
 
-> The strict partial bundle includes everything except the traces that require function constructors. Over time we hope to include more of the remaining trace types here, after which we intend to work on other strict CSP issues such as inline CSS that we may not be able to include in the main bundle.
+> The strict bundle now includes all traces, but the regl-based traces are built differently to avoid function constructors. This results in about a 10% larger bundle size, which is why this method is not used by default. Over time we intend to use the strict bundle to work on other strict CSP issues such as inline CSS.
 
 ---
 
@@ -91,12 +91,12 @@ The `basic` partial bundle contains trace modules `bar`, `pie` and `scatter`.
 
 | Raw size | Minified size | Minified + gzip size |
 |------|-----------------|------------------------|
-| 2.7 MB | 977.2 kB | 318.3 kB |
+| 2.7 MB | 977.9 kB | 318.5 kB |
 
 #### CDN links
-> https://cdn.plot.ly/plotly-basic-2.9.0.js
+> https://cdn.plot.ly/plotly-basic-2.11.0.js
 
-> https://cdn.plot.ly/plotly-basic-2.9.0.min.js
+> https://cdn.plot.ly/plotly-basic-2.11.0.min.js
 
 
 #### npm packages
@@ -114,12 +114,12 @@ The `cartesian` partial bundle contains trace modules `bar`, `box`, `contour`, `
 
 | Raw size | Minified size | Minified + gzip size |
 |------|-----------------|------------------------|
-| 3.3 MB | 1.2 MB | 391.3 kB |
+| 3.3 MB | 1.2 MB | 391.5 kB |
 
 #### CDN links
-> https://cdn.plot.ly/plotly-cartesian-2.9.0.js
+> https://cdn.plot.ly/plotly-cartesian-2.11.0.js
 
-> https://cdn.plot.ly/plotly-cartesian-2.9.0.min.js
+> https://cdn.plot.ly/plotly-cartesian-2.11.0.min.js
 
 
 #### npm packages
@@ -137,12 +137,12 @@ The `geo` partial bundle contains trace modules `choropleth`, `scatter` and `sca
 
 | Raw size | Minified size | Minified + gzip size |
 |------|-----------------|------------------------|
-| 3 MB | 1.1 MB | 360.9 kB |
+| 3.1 MB | 1.1 MB | 361.2 kB |
 
 #### CDN links
-> https://cdn.plot.ly/plotly-geo-2.9.0.js
+> https://cdn.plot.ly/plotly-geo-2.11.0.js
 
-> https://cdn.plot.ly/plotly-geo-2.9.0.min.js
+> https://cdn.plot.ly/plotly-geo-2.11.0.min.js
 
 
 #### npm packages
@@ -160,12 +160,12 @@ The `gl3d` partial bundle contains trace modules `cone`, `isosurface`, `mesh3d`,
 
 | Raw size | Minified size | Minified + gzip size |
 |------|-----------------|------------------------|
-| 3.9 MB | 1.5 MB | 481.1 kB |
+| 3.9 MB | 1.5 MB | 482.2 kB |
 
 #### CDN links
-> https://cdn.plot.ly/plotly-gl3d-2.9.0.js
+> https://cdn.plot.ly/plotly-gl3d-2.11.0.js
 
-> https://cdn.plot.ly/plotly-gl3d-2.9.0.min.js
+> https://cdn.plot.ly/plotly-gl3d-2.11.0.min.js
 
 
 #### npm packages
@@ -183,12 +183,12 @@ The `gl2d` partial bundle contains trace modules `heatmapgl`, `parcoords`, `poin
 
 | Raw size | Minified size | Minified + gzip size |
 |------|-----------------|------------------------|
-| 4.4 MB | 1.8 MB | 571.7 kB |
+| 4.4 MB | 1.8 MB | 574.4 kB |
 
 #### CDN links
-> https://cdn.plot.ly/plotly-gl2d-2.9.0.js
+> https://cdn.plot.ly/plotly-gl2d-2.11.0.js
 
-> https://cdn.plot.ly/plotly-gl2d-2.9.0.min.js
+> https://cdn.plot.ly/plotly-gl2d-2.11.0.min.js
 
 
 #### npm packages
@@ -206,12 +206,12 @@ The `mapbox` partial bundle contains trace modules `choroplethmapbox`, `densitym
 
 | Raw size | Minified size | Minified + gzip size |
 |------|-----------------|------------------------|
-| 4.3 MB | 1.7 MB | 515.1 kB |
+| 4.3 MB | 1.7 MB | 515.4 kB |
 
 #### CDN links
-> https://cdn.plot.ly/plotly-mapbox-2.9.0.js
+> https://cdn.plot.ly/plotly-mapbox-2.11.0.js
 
-> https://cdn.plot.ly/plotly-mapbox-2.9.0.min.js
+> https://cdn.plot.ly/plotly-mapbox-2.11.0.min.js
 
 
 #### npm packages
@@ -229,12 +229,12 @@ The `finance` partial bundle contains trace modules `bar`, `candlestick`, `funne
 
 | Raw size | Minified size | Minified + gzip size |
 |------|-----------------|------------------------|
-| 2.9 MB | 1.1 MB | 351 kB |
+| 2.9 MB | 1.1 MB | 351.2 kB |
 
 #### CDN links
-> https://cdn.plot.ly/plotly-finance-2.9.0.js
+> https://cdn.plot.ly/plotly-finance-2.11.0.js
 
-> https://cdn.plot.ly/plotly-finance-2.9.0.min.js
+> https://cdn.plot.ly/plotly-finance-2.11.0.min.js
 
 
 #### npm packages
@@ -246,18 +246,18 @@ The `finance` partial bundle contains trace modules `bar`, `candlestick`, `funne
 
 ### plotly.js strict
 
-The `strict` partial bundle contains trace modules `bar`, `barpolar`, `box`, `candlestick`, `carpet`, `choropleth`, `choroplethmapbox`, `cone`, `contour`, `contourcarpet`, `densitymapbox`, `funnel`, `funnelarea`, `heatmap`, `heatmapgl`, `histogram`, `histogram2d`, `histogram2dcontour`, `icicle`, `image`, `indicator`, `isosurface`, `mesh3d`, `ohlc`, `parcats`, `pie`, `pointcloud`, `sankey`, `scatter`, `scatter`, `scatter3d`, `scattercarpet`, `scattergeo`, `scattermapbox`, `scatterpolar`, `scatterternary`, `streamtube`, `sunburst`, `surface`, `table`, `treemap`, `violin`, `volume` and `waterfall`.
+The `strict` partial bundle contains trace modules `bar`, `barpolar`, `box`, `candlestick`, `carpet`, `choropleth`, `choroplethmapbox`, `cone`, `contour`, `contourcarpet`, `densitymapbox`, `funnel`, `funnelarea`, `heatmap`, `heatmapgl`, `histogram`, `histogram2d`, `histogram2dcontour`, `icicle`, `image`, `indicator`, `isosurface`, `mesh3d`, `ohlc`, `parcats`, `parcoords`, `pie`, `pointcloud`, `sankey`, `scatter`, `scattergl`, `scatter3d`, `scattercarpet`, `scattergeo`, `scattermapbox`, `scatterpolar`, `scatterpolargl`, `scattersmith`, `scatterternary`, `splom`, `streamtube`, `sunburst`, `surface`, `table`, `treemap`, `violin`, `volume` and `waterfall`.
 
 #### Stats
 
 | Raw size | Minified size | Minified + gzip size |
 |------|-----------------|------------------------|
-| 7.7 MB | 3.2 MB | 958.9 kB |
+| 8.8 MB | 3.9 MB | 1.1 MB |
 
 #### CDN links
-> https://cdn.plot.ly/plotly-strict-2.9.0.js
+> https://cdn.plot.ly/plotly-strict-2.11.0.js
 
-> https://cdn.plot.ly/plotly-strict-2.9.0.min.js
+> https://cdn.plot.ly/plotly-strict-2.11.0.min.js
 
 
 #### npm packages

package/dist/plot-schema.json

@@ -365,6 +365,11 @@
    "noBlank": true,
    "valType": "string"
   },
+  "typesetMath": {
+   "description": "Determines whether math should be typeset or not, when MathJax (either v2 or v3) is present on the page.",
+   "dflt": true,
+   "valType": "boolean"
+  },
   "watermark": {
    "description": "watermark the images with the company's logo",
    "dflt": false,
@@ -42269,6 +42274,99 @@
      "editType": "style",
      "valType": "color"
     },
+    "fillpattern": {
+     "bgcolor": {
+      "arrayOk": true,
+      "description": "When there is no colorscale sets the color of background pattern fill. Defaults to a `marker.color` background when `fillmode` is *overlay*. Otherwise, defaults to a transparent background.",
+      "editType": "style",
+      "valType": "color"
+     },
+     "bgcolorsrc": {
+      "description": "Sets the source reference on Chart Studio Cloud for `bgcolor`.",
+      "editType": "none",
+      "valType": "string"
+     },
+     "description": "Sets the pattern within the marker.",
+     "editType": "style",
+     "fgcolor": {
+      "arrayOk": true,
+      "description": "When there is no colorscale sets the color of foreground pattern fill. Defaults to a `marker.color` background when `fillmode` is *replace*. Otherwise, defaults to dark grey or white to increase contrast with the `bgcolor`.",
+      "editType": "style",
+      "valType": "color"
+     },
+     "fgcolorsrc": {
+      "description": "Sets the source reference on Chart Studio Cloud for `fgcolor`.",
+      "editType": "none",
+      "valType": "string"
+     },
+     "fgopacity": {
+      "description": "Sets the opacity of the foreground pattern fill. Defaults to a 0.5 when `fillmode` is *overlay*. Otherwise, defaults to 1.",
+      "editType": "style",
+      "max": 1,
+      "min": 0,
+      "valType": "number"
+     },
+     "fillmode": {
+      "description": "Determines whether `marker.color` should be used as a default to `bgcolor` or a `fgcolor`.",
+      "dflt": "replace",
+      "editType": "style",
+      "valType": "enumerated",
+      "values": [
+       "replace",
+       "overlay"
+      ]
+     },
+     "role": "object",
+     "shape": {
+      "arrayOk": true,
+      "description": "Sets the shape of the pattern fill. By default, no pattern is used for filling the area.",
+      "dflt": "",
+      "editType": "style",
+      "valType": "enumerated",
+      "values": [
+       "",
+       "/",
+       "\\",
+       "x",
+       "-",
+       "|",
+       "+",
+       "."
+      ]
+     },
+     "shapesrc": {
+      "description": "Sets the source reference on Chart Studio Cloud for `shape`.",
+      "editType": "none",
+      "valType": "string"
+     },
+     "size": {
+      "arrayOk": true,
+      "description": "Sets the size of unit squares of the pattern fill in pixels, which corresponds to the interval of repetition of the pattern.",
+      "dflt": 8,
+      "editType": "style",
+      "min": 0,
+      "valType": "number"
+     },
+     "sizesrc": {
+      "description": "Sets the source reference on Chart Studio Cloud for `size`.",
+      "editType": "none",
+      "valType": "string"
+     },
+     "solidity": {
+      "arrayOk": true,
+      "description": "Sets the solidity of the pattern fill. Solidity is roughly the fraction of the area filled by the pattern. Solidity of 0 shows only the background color without pattern and solidty of 1 shows only the foreground color without pattern.",
+      "dflt": 0.3,
+      "editType": "style",
+      "max": 1,
+      "min": 0,
+      "valType": "number"
+     },
+     "soliditysrc": {
+      "description": "Sets the source reference on Chart Studio Cloud for `solidity`.",
+      "editType": "none",
+      "valType": "string"
+     }
+    },
     "groupnorm": {
      "description": "Only relevant when `stackgroup` is used, and only the first `groupnorm` found in the `stackgroup` will be used - including if `visible` is *legendonly* but not if it is `false`. Sets the normalization for the sum of this `stackgroup`. With *fraction*, the value of each trace at each location is divided by the sum of all trace values at that location. *percent* is the same but multiplied by 100 to show percentages. If there are multiple subplots, or multiple `stackgroup`s on one subplot, each will be normalized within its own set.",
      "dflt": "",