Skip to content

Merge recent docs changes to main #5043

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Feb 19, 2025
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ pip install plotly
or conda.

```
conda install -c plotly plotly
conda install -c conda-forge plotly
```

### Jupyter Widget Support
Expand Down
2 changes: 1 addition & 1 deletion doc/python/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ $ pip install plotly
or `conda`:

```
$ conda install -c plotly plotly
$ conda install -c conda-forge plotly
```

If you want to use Plotly Express, install its required dependencies with:
Expand Down
4 changes: 4 additions & 0 deletions doc/python/performance.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,10 @@ The following [array data types](https://numpy.org/devdocs/reference/arrays.scal

Arrays or data types that are not supported for base64 encoding to Plotly.js's typed arrays specification will still work and render correctly with Plotly. Those arrays and or data types just won't have the performance benefits that Plotly.js's base64 typed arrays feature provides.

### Dash Design Kit Compatibility

The Dash Design Kit `Graph` component from versions of Dash Design Kit earlier than 1.13 doesn't work with Plotly.py version 6 when using Python objects listed in the previous "Arrays and Data Types Supported". Upgrade Dash Design Kit to 1.13 or later to resolve this issue.

### Unsupported Attributes

Arrays passed to attributes with the following names are not supported for base64 encoding for rendering with Plotly.js.
Expand Down
5 changes: 4 additions & 1 deletion doc/python/v6-changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,12 @@ pip install anywidget

Plotly.py now takes advantage of recent changes in how Plotly.js handles typed arrays for improved performance. See the [performance page](https://plotly.com/python/performance/) for more details.

> If you are using Plotly.py 6 or later with Dash Design Kit, you may need to upgrade your Dash Design Kit version. See the [Dash Design Kit Compatibility section on the performance page](/python/performance/#dash-design-kit-compatibility) for more details.


## Dataframe Support

Plotly Express now uses [Narwhals](https://narwhals-dev.github.io/narwhals/) to natively support pandas, Polars, and PyArrow. With this change, the [performance](https://plotly.com/python/performance/) of using Polars or PyArrow with Plotly Express is significantly improved.
Plotly Express now uses [Narwhals](https://narwhals-dev.github.io/narwhals/) to natively support pandas, Polars, and PyArrow. With this change, the [performance](https://plotly.com/python/performance/) of using Polars or PyArrow with Plotly Express is significantly improved.

## Mapbox Deprecation

Expand Down