Merge branch 'master' into patch-1

Author: archmoj

.circleci/config.yml

@@ -1,7 +1,7 @@
 version: 2.1
 
 orbs:
-  browser-tools: circleci/browser-tools@1.4.6
+  browser-tools: circleci/browser-tools@1.4.8
 
 commands:
   test_core:

CHANGELOG.md

@@ -2,6 +2,13 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [5.20.0] - 2024-03-13
+
+### Updated
+- Updated Plotly.js from version 2.29.1 to version 2.30.0. See the [plotly.js CHANGELOG](https://github.com/plotly/plotly.js/blob/master/CHANGELOG.md#2300----2024-03-06) for more information. These changes are reflected in the auto-generated `plotly.graph_objects` module. Notable changes include:
+  - Add fill gradients for scatter traces [[#6905](https://github.com/plotly/plotly.js/pull/6905)], with thanks to @lumip for the contribution!
+  - Add `indentation` to legend [[#6874](https://github.com/plotly/plotly.js/pull/6874)], with thanks to @my-tien for the contribution!
+
 ## [5.19.0] - 2024-02-15
 
 ### Updated

README.md

@@ -33,7 +33,7 @@
 
 ## Quickstart
 
-`pip install plotly==5.19.0`
+`pip install plotly==5.20.0`
 
 Inside [Jupyter](https://jupyter.org/install) (installable with `pip install "jupyterlab>=3" "ipywidgets>=7.6"`):
 
@@ -78,13 +78,13 @@ Built on top of [plotly.js](https://github.com/plotly/plotly.js), `plotly.py` is
 plotly.py may be installed using pip...
 
 ```
-pip install plotly==5.19.0
+pip install plotly==5.20.0
 ```
 
 or conda.
 
 ```
-conda install -c plotly plotly=5.19.0
+conda install -c plotly plotly=5.20.0
 ```
 
 ### JupyterLab Support
@@ -106,7 +106,7 @@ The instructions above apply to JupyterLab 3.x. **For JupyterLab 2 or earlier**,
 
 ```
 # JupyterLab 2.x renderer support
-jupyter labextension install jupyterlab-plotly@5.19.0 @jupyter-widgets/jupyterlab-manager
+jupyter labextension install jupyterlab-plotly@5.20.0 @jupyter-widgets/jupyterlab-manager
 ```
 
 Please check out our [Troubleshooting guide](https://plotly.com/python/troubleshooting/) if you run into any problems with JupyterLab.

binder/requirements.txt

@@ -1,5 +1,5 @@
 jupytext
-plotly==5.19.0
+plotly==5.20.0
 jupyter
 notebook
 pandas==1.2.0

contributing.md

@@ -224,7 +224,30 @@ the `plotly/plotly.js` GitHub repository (and place them in
 `plotly/package_data`). It will then regenerate all of the `graph_objs`
 classes based on the new schema.
 
-For dev branches, it is also possible to use `updateplotlyjsdev --devrepo reponame --devbranch branchname` to update to development versions of `plotly.js`. This will fetch the `plotly.js` in the CircleCI artifact of the branch `branchname` of the repo `reponame`. If `--devrepo` or `--devbranch` are omitted, `updateplotlyjsdev` defaults using `plotly/plotly.js` and `master` respectively.
+For dev branches, it is also possible to use `updateplotlyjsdev` in two configurations:
+
+### CircleCI Release
+
+If your devbranch is part of the official plotly.js repository, you can use 
+```bash
+python setup.py updateplotlyjsdev --devrepo reponame --devbranch branchname
+``` 
+to update to development versions of `plotly.js`. This will fetch the `plotly.js` in the CircleCI artifact of the branch `branchname` of the repo `reponame`. If `--devrepo` or `--devbranch` are omitted, `updateplotlyjsdev` defaults using `plotly/plotly.js` and `master` respectively.
+
+### Local Repository
+
+If you have a local repository of `plotly.js` you'd like to try, you can run:
+
+```bash
+# In your plotly.js/ directory, prepare the package:
+
+$ npm run build
+$ npm pack
+$ mv plotly.js-*.tgz plotly.js.tgz
+
+# In your plotly.py/packages/python/plotly/ directory:
+$ python setup.py updateplotlyjsdev --local /path/to/your/plotly.js/
+```
 
 ## Testing
 

doc/apidoc/conf.py

@@ -26,7 +26,7 @@
 # The short X.Y version
 version = ""
 # The full version, including alpha/beta/rc tags
-release = "5.19.0"
+release = "5.20.0"
 
 
 # -- General configuration ---------------------------------------------------

doc/python/filled-area-plots.md

@@ -6,9 +6,9 @@ jupyter:
       extension: .md
       format_name: markdown
       format_version: '1.3'
-      jupytext_version: 1.14.1
+      jupytext_version: 1.16.1
   kernelspec:
-    display_name: Python 3
+    display_name: Python 3 (ipykernel)
     language: python
     name: python3
   language_info:
@@ -20,7 +20,7 @@ jupyter:
     name: python
     nbconvert_exporter: python
     pygments_lexer: ipython3
-    version: 3.8.8
+    version: 3.10.11
   plotly:
     description: How to make filled area plots in Python with Plotly.
     display_as: basic
@@ -80,13 +80,11 @@ fig = px.area(df, x="medal", y="count", color="nation",
 fig.show()
 ```
 
-<!-- #region tags=[] -->
 ### Filled area chart with plotly.graph_objects
 
 #### Basic Overlaid Area Chart
-<!-- #endregion -->
 
-```python tags=[]
+```python
 import plotly.graph_objects as go
 
 fig = go.Figure()
@@ -131,6 +129,44 @@ fig.add_trace(go.Scatter(
 fig.show()
 ```
 
+#### Gradient Fill
+
+*New in 5.20*
+
+Scatter traces with a fill support a `fillgradient`, which is a `dict` of options that defines the gradient. Use `fillgradient.colorscale` to define the [colorscale](https://plotly.com/python/colorscales) for the gradient and choose a `type` to define the orientation of the gradient (`'horizontal'`, `'vertical'` or `'radial'`). 
+
+In the following example, we've defined a `horizontal` `fillgradient` with a colorscale of three colors. 
+
+```python
+import plotly.graph_objects as go
+
+fig = go.Figure(
+    [
+        go.Scatter(
+            x=[1, 2, 3, 4],
+            y=[3, 4, 8, 3],
+            fill=None,
+            mode="lines",
+            line_color="darkblue",
+        ),
+        go.Scatter(
+            x=[1, 2, 3, 4],
+            y=[1, 6, 2, 6],
+            fill="tonexty",
+            mode="lines",
+            line_color="darkblue",
+            fillgradient=dict(
+                type="horizontal",
+                colorscale=[(0.0, "darkblue"), (0.5, "royalblue"), (1.0, "cyan")],
+            ),
+        ),
+    ]
+)
+
+fig.show()
+
+```
+
 #### Stacked Area Chart
 
 The `stackgroup` parameter is used to add the `y` values of the different traces in the same group. Traces in the same group fill up to the next trace of the group.

doc/python/getting-started.md

@@ -58,13 +58,13 @@ We also encourage you to join the [Plotly Community Forum](http://community.plot
 `plotly` may be installed using `pip`:
 
 ```
-$ pip install plotly==5.19.0
+$ pip install plotly==5.20.0
 ```
 
 or `conda`:
 
 ```
-$ conda install -c plotly plotly=5.19.0
+$ conda install -c plotly plotly=5.20.0
 ```
 This package contains everything you need to write figures to standalone HTML files.
 
@@ -152,7 +152,7 @@ The instructions above apply to JupyterLab 3.x. **For JupyterLab 2 or earlier**,
 
 ```
 # JupyterLab 2.x renderer support
-jupyter labextension install jupyterlab-plotly@5.19.0 @jupyter-widgets/jupyterlab-manager
+jupyter labextension install jupyterlab-plotly@5.20.0 @jupyter-widgets/jupyterlab-manager
 ```
 
 Please check out our [Troubleshooting guide](/python/troubleshooting/) if you run into any problems with JupyterLab, particularly if you are using multiple python environments inside Jupyter.

doc/python/legend.md

@@ -6,7 +6,7 @@ jupyter:
       extension: .md
       format_name: markdown
       format_version: '1.3'
-      jupytext_version: 1.14.7
+      jupytext_version: 1.16.1
   kernelspec:
     display_name: Python 3 (ipykernel)
     language: python
@@ -20,7 +20,7 @@ jupyter:
     name: python
     nbconvert_exporter: python
     pygments_lexer: ipython3
-    version: 3.10.4
+    version: 3.10.11
   plotly:
     description: How to configure and style the legend in Plotly with Python.
     display_as: file_settings
@@ -546,6 +546,40 @@ fig.update_layout(title="Try Clicking on the Legend Items!")
 fig.show()
 ```
 
+#### Indent Legend Entries
+
+*New in 5.20*
+
+To indent legend entries, set `indenation` on `layout.legend` to a number of pixels. In the following example, we indent legend entries by 10 pixels. 
+
+```python
+import plotly.graph_objects as go
+from plotly import data
+
+df = data.iris()
+
+fig = go.Figure(
+    [
+        go.Scatter(
+            x=df[df["species"] == species]["sepal_width"],
+            y=df[df["species"] == species]["sepal_length"],
+            mode="markers",
+            name=species,
+        )
+        for species in df["species"].unique()
+    ],
+    layout=dict(
+        legend=dict(
+            title="Species",
+            indentation=10
+        )
+    ),
+)
+
+
+fig.show()
+```
+
 #### Group click toggle behavior
 
 *New in v5.3*

doc/requirements.txt

@@ -1,4 +1,4 @@
-plotly==5.19.0
+plotly==5.20.0
 jupytext==1.1.1
 ipywidgets==7.7.2
 jupyter-client<7