Merge pull request #5357 from plotly/update-plotlyjs-v3.1.1

Update plotly.js to version 3.1.1

Author: emilykl

.github/workflows/check-js-build.yml

@@ -29,6 +29,7 @@ jobs:
         cd js
         npm ci
         npm run build
+        npm ls
     - name: Check JupyterLab build artifacts
       run: |
         # 1. Hash contents of all static files, sort by content hash

codegen/resources/plot-schema.json

@@ -4008,7 +4008,7 @@
         "valType": "string"
        },
        "type": {
-        "description": "Sets the layer type, that is the how the layer data set in `source` will be rendered With `sourcetype` set to *geojson*, the following values are allowed: *circle*, *line*, *fill* and *symbol*. but note that *line* and *fill* are not compatible with Point GeoJSON geometries. With `sourcetype` set to *vector*, the following values are allowed:  *circle*, *line*, *fill* and *symbol*. With `sourcetype` set to *raster* or `*image*`, only the *raster* value is allowed.",
+        "description": "Sets the layer type, that is the how the layer data set in `source` will be rendered With `sourcetype` set to *geojson*, the following values are allowed: *circle*, *line*, *fill* and *symbol*. but note that *line* and *fill* are not compatible with Point GeoJSON geometries. With `sourcetype` set to *vector*, the following values are allowed:  *circle*, *line*, *fill* and *symbol*. With `sourcetype` set to *raster* or *image*, only the *raster* value is allowed.",
         "dflt": "circle",
         "editType": "plot",
         "valType": "enumerated",
@@ -4414,7 +4414,7 @@
         "valType": "string"
        },
        "type": {
-        "description": "Sets the layer type, that is the how the layer data set in `source` will be rendered With `sourcetype` set to *geojson*, the following values are allowed: *circle*, *line*, *fill* and *symbol*. but note that *line* and *fill* are not compatible with Point GeoJSON geometries. With `sourcetype` set to *vector*, the following values are allowed:  *circle*, *line*, *fill* and *symbol*. With `sourcetype` set to *raster* or `*image*`, only the *raster* value is allowed.",
+        "description": "Sets the layer type, that is the how the layer data set in `source` will be rendered With `sourcetype` set to *geojson*, the following values are allowed: *circle*, *line*, *fill* and *symbol*. but note that *line* and *fill* are not compatible with Point GeoJSON geometries. With `sourcetype` set to *vector*, the following values are allowed:  *circle*, *line*, *fill* and *symbol*. With `sourcetype` set to *raster* or *image*, only the *raster* value is allowed.",
         "dflt": "circle",
         "editType": "plot",
         "valType": "enumerated",
@@ -47932,7 +47932,7 @@
      "valType": "number"
     },
     "source": {
-     "description": "Specifies the data URI of the image to be visualized. The URI consists of \"data:image/[<media subtype>][;base64],<data>\"",
+     "description": "Specifies the data URI of the image to be visualized. The URI consists of \"data:image/[<media subtype\\\\>][;base64\\\\],<data\\\\>\"",
      "editType": "calc",
      "valType": "string"
     },
@@ -53288,7 +53288,7 @@
      ]
     },
     "hovertemplate": {
-     "description": "Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, *xother* will be added to those with different x positions from the first point. An underscore before or after *(x|y)other* will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available.  This value here applies when hovering over dimensions. Note that `*categorycount`, *colorcount* and *bandcolorcount* are only available when `hoveron` contains the *color* flagFinally, the template string has access to variables `count`, `probability`, `category`, `categorycount`, `colorcount` and `bandcolorcount`. Anything contained in tag `<extra>` is displayed in the secondary box, for example `<extra>%{fullData.name}</extra>`. To hide the secondary box completely, use an empty tag `<extra></extra>`.",
+     "description": "Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example \"y: %{y}\" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, *xother* will be added to those with different x positions from the first point. An underscore before or after *(x|y)other* will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example \"Price: %{y:$.2f}\". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example \"Day: %{2019-01-01|%A}\". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available.  This value here applies when hovering over dimensions. Note that *categorycount*, *colorcount* and *bandcolorcount* are only available when `hoveron` contains the *color* flag. Finally, the template string has access to variables `count`, `probability`, `category`, `categorycount`, `colorcount` and `bandcolorcount`. Anything contained in tag `<extra>` is displayed in the secondary box, for example `<extra>%{fullData.name}</extra>`. To hide the secondary box completely, use an empty tag `<extra></extra>`.",
      "dflt": "",
      "editType": "plot",
      "valType": "string"

commands.py

@@ -296,8 +296,8 @@ def update_plotlyjs_dev(args, outdir):
     perform_codegen(outdir)
 
 
-def parse_args():
-    """Parse command-line arguments."""
+def make_parser():
+    """Make argument parser."""
 
     parser = argparse.ArgumentParser()
     subparsers = parser.add_subparsers(dest="cmd", help="Available subcommands")
@@ -322,6 +322,11 @@ def parse_args():
 
     subparsers.add_parser("updateplotlyjs", help="update plotly.js")
 
+    return parser
+
+
+def parse_args(parser: argparse.ArgumentParser):
+    """Parse command line arguments."""
     return parser.parse_args()
 
 
@@ -331,7 +336,8 @@ def main():
     project_root = os.path.dirname(os.path.realpath(__file__))
     outdir = os.path.join(project_root, "plotly")
 
-    args = parse_args()
+    parser = make_parser()
+    args = parse_args(parser)
 
     if args.cmd == "codegen":
         perform_codegen(outdir, noformat=args.noformat)
@@ -350,6 +356,10 @@ def main():
         print(version)
         update_plotlyjs(version, outdir)
 
+    elif args.cmd is None:
+        parser.print_help()
+        sys.exit(1)
+
     else:
         print(f"unknown command {args.cmd}", file=sys.stderr)
         sys.exit(1)

js/lib/mimeExtension.js

@@ -19,7 +19,7 @@
     },
     "dependencies": {
       "lodash-es": "^4.17.21",
-      "plotly.js": "3.1.0",
+      "plotly.js": "3.1.1",
       "@lumino/widgets": "~2.4.0"
     },
     "devDependencies": {

js/package-lock.json

@@ -9980,7 +9980,7 @@ def add_image(
         source
             Specifies the data URI of the image to be visualized.
             The URI consists of "data:image/[<media
-            subtype>][;base64],<data>"
+            subtype\\>][;base64\\],<data\\>"
         stream
             :class:`plotly.graph_objects.image.Stream` instance or
             dict with compatible properties
@@ -11853,9 +11853,9 @@ def add_parcats(
             data. Additionally, every attributes that can be
             specified per-point (the ones that are `arrayOk: true`)
             are available.  This value here applies when hovering
-            over dimensions. Note that `*categorycount`,
+            over dimensions. Note that "categorycount",
             "colorcount" and "bandcolorcount" are only available
-            when `hoveron` contains the "color" flagFinally, the
+            when `hoveron` contains the "color" flag. Finally, the
             template string has access to variables `count`,
             `probability`, `category`, `categorycount`,
             `colorcount` and `bandcolorcount`. Anything contained

js/package.json

@@ -9982,7 +9982,7 @@ def add_image(
         source
             Specifies the data URI of the image to be visualized.
             The URI consists of "data:image/[<media
-            subtype>][;base64],<data>"
+            subtype\\>][;base64\\],<data\\>"
         stream
             :class:`plotly.graph_objects.image.Stream` instance or
             dict with compatible properties
@@ -11855,9 +11855,9 @@ def add_parcats(
             data. Additionally, every attributes that can be
             specified per-point (the ones that are `arrayOk: true`)
             are available.  This value here applies when hovering
-            over dimensions. Note that `*categorycount`,
+            over dimensions. Note that "categorycount",
             "colorcount" and "bandcolorcount" are only available
-            when `hoveron` contains the "color" flagFinally, the
+            when `hoveron` contains the "color" flag. Finally, the
             template string has access to variables `count`,
             `probability`, `category`, `categorycount`,
             `colorcount` and `bandcolorcount`. Anything contained

plotly/graph_objs/_figure.py

@@ -521,7 +521,8 @@ def opacity(self, val):
     def source(self):
         """
         Specifies the data URI of the image to be visualized. The URI
-        consists of "data:image/[<media subtype>][;base64],<data>"
+        consists of "data:image/[<media
+        subtype\\>][;base64\\],<data\\>"
 
         The 'source' property is a string and must be specified as:
           - A string
@@ -1021,7 +1022,7 @@ def _prop_descriptions(self):
         source
             Specifies the data URI of the image to be visualized.
             The URI consists of "data:image/[<media
-            subtype>][;base64],<data>"
+            subtype\\>][;base64\\],<data\\>"
         stream
             :class:`plotly.graph_objects.image.Stream` instance or
             dict with compatible properties
@@ -1294,7 +1295,7 @@ def __init__(
         source
             Specifies the data URI of the image to be visualized.
             The URI consists of "data:image/[<media
-            subtype>][;base64],<data>"
+            subtype\\>][;base64\\],<data\\>"
         stream
             :class:`plotly.graph_objects.image.Stream` instance or
             dict with compatible properties

plotly/graph_objs/_figurewidget.py

@@ -249,14 +249,14 @@ def hovertemplate(self):
         Additionally, every attributes that can be specified per-point
         (the ones that are `arrayOk: true`) are available.  This value
         here applies when hovering over dimensions. Note that
-        `*categorycount`, "colorcount" and "bandcolorcount" are only
-        available when `hoveron` contains the "color" flagFinally, the
-        template string has access to variables `count`, `probability`,
-        `category`, `categorycount`, `colorcount` and `bandcolorcount`.
-        Anything contained in tag `<extra>` is displayed in the
-        secondary box, for example `<extra>%{fullData.name}</extra>`.
-        To hide the secondary box completely, use an empty tag
-        `<extra></extra>`.
+        "categorycount", "colorcount" and "bandcolorcount" are only
+        available when `hoveron` contains the "color" flag. Finally,
+        the template string has access to variables `count`,
+        `probability`, `category`, `categorycount`, `colorcount` and
+        `bandcolorcount`. Anything contained in tag `<extra>` is
+        displayed in the secondary box, for example
+        `<extra>%{fullData.name}</extra>`. To hide the secondary box
+        completely, use an empty tag `<extra></extra>`.
 
         The 'hovertemplate' property is a string and must be specified as:
           - A string
@@ -619,9 +619,9 @@ def _prop_descriptions(self):
             data. Additionally, every attributes that can be
             specified per-point (the ones that are `arrayOk: true`)
             are available.  This value here applies when hovering
-            over dimensions. Note that `*categorycount`,
+            over dimensions. Note that "categorycount",
             "colorcount" and "bandcolorcount" are only available
-            when `hoveron` contains the "color" flagFinally, the
+            when `hoveron` contains the "color" flag. Finally, the
             template string has access to variables `count`,
             `probability`, `category`, `categorycount`,
             `colorcount` and `bandcolorcount`. Anything contained
@@ -802,9 +802,9 @@ def __init__(
             data. Additionally, every attributes that can be
             specified per-point (the ones that are `arrayOk: true`)
             are available.  This value here applies when hovering
-            over dimensions. Note that `*categorycount`,
+            over dimensions. Note that "categorycount",
             "colorcount" and "bandcolorcount" are only available
-            when `hoveron` contains the "color" flagFinally, the
+            when `hoveron` contains the "color" flag. Finally, the
             template string has access to variables `count`,
             `probability`, `category`, `categorycount`,
             `colorcount` and `bandcolorcount`. Anything contained