Skip to content
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

Docs updates for Plotly.py version 6 #4840

Merged
merged 120 commits into from
Nov 27, 2024
Merged
Show file tree
Hide file tree
Changes from 109 commits
Commits
Show all changes
120 commits
Select commit Hold shift + click to select a range
7770164
add examples using base64
archmoj Jan 9, 2024
c2d755e
remove example + make small changes to metadata
LiamConnors Sep 17, 2024
d0bc21b
add back correct examples
LiamConnors Sep 17, 2024
fb0a5d8
add content for numpy arrays
LiamConnors Sep 18, 2024
49ae498
fix typo
LiamConnors Sep 19, 2024
589d105
rename file
LiamConnors Sep 19, 2024
79afc5c
update titles and link
LiamConnors Sep 19, 2024
af1c4a4
fix typo and shorten content
LiamConnors Sep 19, 2024
170d7f9
Update numpy-arrays.md
LiamConnors Sep 19, 2024
7a67f81
merge performance content
LiamConnors Sep 23, 2024
f75521c
add intro and restructure svg intro
LiamConnors Sep 23, 2024
c895f10
Update webgl-vs-svg.md
LiamConnors Sep 23, 2024
77d7aa3
Update webgl-vs-svg.md
LiamConnors Oct 3, 2024
c1e43e7
Update webgl-vs-svg.md
LiamConnors Oct 3, 2024
bdfd6af
Update doc/python/webgl-vs-svg.md
LiamConnors Oct 3, 2024
8a3769c
Update doc/python/webgl-vs-svg.md
LiamConnors Oct 3, 2024
cf7ac59
change order of dtypes + mention specifying dtype in numpy
LiamConnors Oct 10, 2024
13ecdcc
add v6 changes
LiamConnors Oct 16, 2024
9072028
remove old links
LiamConnors Oct 16, 2024
df8e619
add basic draft of v6 changes
LiamConnors Oct 18, 2024
02a9b28
add link to numpy reference docs
LiamConnors Oct 22, 2024
ca4fa05
add updated structure + more changes
LiamConnors Oct 22, 2024
229be09
update structure
LiamConnors Oct 22, 2024
430b909
Merge branch 'master' into version-6-migration
LiamConnors Oct 22, 2024
f151cc3
update version 6 guide
LiamConnors Oct 22, 2024
84e9e76
add transforms removal
LiamConnors Oct 24, 2024
6c6c27b
Merge branch 'master' into add-base64-docs
LiamConnors Nov 1, 2024
56bb8fc
remove extra webgl examples
LiamConnors Nov 4, 2024
cdd7839
shorten webgl content
LiamConnors Nov 4, 2024
9ee6b26
small edits + remove extra example
LiamConnors Nov 4, 2024
1325ac1
rename file
LiamConnors Nov 4, 2024
24021f3
add update to types of series
LiamConnors Nov 4, 2024
5d27f02
Merge branch 'master' into version-6-migration
LiamConnors Nov 4, 2024
f60f02c
Merge branch 'version-6-migration' into add-base64-docs
LiamConnors Nov 4, 2024
a91abfa
add anywidget update
LiamConnors Nov 4, 2024
c9e8630
add anywidget
LiamConnors Nov 4, 2024
2a1f49a
Merge pull request #4769 from plotly/add-base64-docs
LiamConnors Nov 4, 2024
9762699
Merge branch 'master' into version-6-migration
LiamConnors Nov 4, 2024
cfce152
Update v6-changes.md
LiamConnors Nov 4, 2024
61c380a
remove pandas series mention
LiamConnors Nov 4, 2024
8aba24c
add datashader
LiamConnors Nov 4, 2024
8581a53
remove datashader page
LiamConnors Nov 4, 2024
9e9d4a3
Update smith-charts.md
LiamConnors Nov 4, 2024
470050c
remove transforms pages
LiamConnors Nov 5, 2024
531fc9b
fix page order
LiamConnors Nov 5, 2024
2cf815b
add dataframe support
LiamConnors Nov 5, 2024
f51ff00
update pandas references
LiamConnors Nov 5, 2024
25d0d5a
Update doc/python/v6-changes.md
LiamConnors Nov 5, 2024
b4394b1
add transforms note
LiamConnors Nov 5, 2024
d9bf3ac
Merge branch 'version-6-migration' of https://github.com/plotly/plotl…
LiamConnors Nov 5, 2024
ce9091f
various docs updates
LiamConnors Nov 5, 2024
bac2b01
remove dash
LiamConnors Nov 5, 2024
fc66ae3
fix typo
LiamConnors Nov 5, 2024
c6341c0
reorder content
LiamConnors Nov 7, 2024
2f2e84e
various small docs fixes
LiamConnors Nov 7, 2024
a84f754
update starting point text
LiamConnors Nov 7, 2024
593a1ed
Update px-arguments.md
LiamConnors Nov 7, 2024
0a3de82
Merge branch 'master' into version-6-migration
LiamConnors Nov 7, 2024
dd42534
add grouped stacked bar chart example
LiamConnors Nov 8, 2024
67c8d46
Merge branch 'version-6-migration' of https://github.com/plotly/plotl…
LiamConnors Nov 8, 2024
e4b5d79
Update performance.md
LiamConnors Nov 11, 2024
5c389e5
Merge branch 'master' into version-6-migration
LiamConnors Nov 12, 2024
3c578c1
shorten text
LiamConnors Nov 12, 2024
370fd3b
add note on dataframe support
LiamConnors Nov 12, 2024
f0157bb
Merge branch 'master' into version-6-migration
LiamConnors Nov 13, 2024
7e4ec79
add note on dataframe support
LiamConnors Nov 13, 2024
1eeee65
fix issue with code running
LiamConnors Nov 13, 2024
963c5aa
add note on performance
LiamConnors Nov 13, 2024
4a1f120
Update v6-changes.md
LiamConnors Nov 14, 2024
3bd901b
Update doc/python/performance.md
LiamConnors Nov 14, 2024
9c7dc27
Update doc/python/performance.md
LiamConnors Nov 14, 2024
4cdd340
Update doc/python/performance.md
LiamConnors Nov 14, 2024
458a5d4
fix 3d
LiamConnors Nov 14, 2024
df65774
Merge branch 'version-6-migration' of https://github.com/plotly/plotl…
LiamConnors Nov 14, 2024
87a5a05
Update doc/python/performance.md
LiamConnors Nov 14, 2024
e00b553
Update doc/python/px-arguments.md
LiamConnors Nov 14, 2024
39fdfea
Update doc/python/px-arguments.md
LiamConnors Nov 14, 2024
aebdbe5
add note on previous versions
LiamConnors Nov 15, 2024
57f2c71
Merge branch 'version-6-migration' of https://github.com/plotly/plotl…
LiamConnors Nov 15, 2024
c5285b4
edit dependencies section
LiamConnors Nov 15, 2024
ca84936
update arrays and dtypes text
LiamConnors Nov 15, 2024
062d43c
update example
LiamConnors Nov 18, 2024
79b212a
update example
LiamConnors Nov 18, 2024
2d192e7
link out to Plotly Express arguments page
LiamConnors Nov 18, 2024
2425b0a
Merge branch 'master' into version-6-migration
LiamConnors Nov 19, 2024
070f279
Update doc/python/px-arguments.md
LiamConnors Nov 19, 2024
34af731
Update getting-started.md
LiamConnors Nov 22, 2024
a410628
remove known limitation
LiamConnors Nov 22, 2024
eaae154
mention modin and cuDF
LiamConnors Nov 22, 2024
8db1fbc
Merge branch 'master' into version-6-migration
LiamConnors Nov 22, 2024
26232a2
Update CHANGELOG.md
LiamConnors Nov 22, 2024
61f695d
Update CHANGELOG.md
LiamConnors Nov 22, 2024
260d6c9
Update CHANGELOG.md
LiamConnors Nov 22, 2024
011eedc
remove mention of version 7 not working
LiamConnors Nov 22, 2024
d4bd812
Merge branch 'version-6-migration' of https://github.com/plotly/plotl…
LiamConnors Nov 22, 2024
8a81385
reorg of changelog
LiamConnors Nov 22, 2024
55473a1
Update bar-charts.md
LiamConnors Nov 25, 2024
71a183e
Update doc/python/v6-changes.md
LiamConnors Nov 25, 2024
6096262
Update v6-changes.md
LiamConnors Nov 25, 2024
87339c3
Update CHANGELOG.md
LiamConnors Nov 26, 2024
6fe6a88
Update doc/python/performance.md
LiamConnors Nov 26, 2024
58cda6d
Merge branch 'version-6-migration' of https://github.com/plotly/plotl…
LiamConnors Nov 26, 2024
17148c9
Update performance.md
LiamConnors Nov 26, 2024
a6a6f17
Update CHANGELOG.md
LiamConnors Nov 26, 2024
e483903
Update CHANGELOG.md
LiamConnors Nov 26, 2024
d6716cd
Merge branch 'version-6-migration' of https://github.com/plotly/plotl…
LiamConnors Nov 26, 2024
f6654a2
Add back v4 migration
LiamConnors Nov 26, 2024
6f42099
Update LaTeX.md
LiamConnors Nov 26, 2024
306b47f
Update v4-migration.md
LiamConnors Nov 26, 2024
760aabf
Merge branch 'master' into version-6-migration
LiamConnors Nov 26, 2024
fe19d81
Update v4-migration.md
LiamConnors Nov 26, 2024
0d056db
Merge branch 'version-6-migration' of https://github.com/plotly/plotl…
LiamConnors Nov 26, 2024
fb4ac7e
Update doc/python/v6-changes.md
LiamConnors Nov 26, 2024
1adeae7
Update CHANGELOG.md
LiamConnors Nov 26, 2024
8471804
Merge branch 'version-6-migration' of https://github.com/plotly/plotl…
LiamConnors Nov 26, 2024
7549844
Update doc/python/getting-started.md
LiamConnors Nov 26, 2024
d77a0e2
Update doc/python/v6-changes.md
LiamConnors Nov 26, 2024
485a1d8
Update doc/python/performance.md
LiamConnors Nov 26, 2024
45ead3f
remove version pins
LiamConnors Nov 27, 2024
2b8e2ba
Update doc/python/px-arguments.md
LiamConnors Nov 27, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 28 additions & 13 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,36 @@ All notable changes to this project will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).

### Added
- Add `plotly[express]` extra for easily installing Plotly Express dependencies [#4644](https://github.com/plotly/plotly.py/pull/4644)
- Add `plotly[express]` extra for easily installing Plotly Express dependencies [[#4644](https://github.com/plotly/plotly.py/pull/4644)]
- Add `subtitle` attribute to all Plotly Express traces [[#4830](https://github.com/plotly/plotly.py/pull/4830)].

### Removed
- Drop deprecated `pointcloud` and `heatmapgl` traces from the API
- Drop `tenacity` dependency [#4831](https://github.com/plotly/plotly.js/pull/4831)

### Updated

- Updated plotly.py to use base64 encoding of arrays in plotly JSON to improve performance.
- Add `subtitle` attribute to all Plotly Express traces
- Make plotly-express dataframe agnostic via Narwhals [#4790](https://github.com/plotly/plotly.py/pull/4790)
- Drop deprecated `pointcloud` and `heatmapgl` traces from the API [[#4815](https://github.com/plotly/plotly.py/pull/4815)]
- Drop `tenacity` dependency [[#4831](https://github.com/plotly/plotly.py/pull/4831)]
- Drop support for Jupyter Notebook version 6 and earlier [[#4822](https://github.com/plotly/plotly.py/pull/4822)]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Which lower versions are supported?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For Jupyter notebooks? Only 7 and later

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes for For Jupyter notebooks.
Should you revise the following note?

Drop support for Jupyter Notebook version 6 and earlier

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You mean to specify the versions that do work as well as those that are dropped?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes please.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated


### Updated
- Deprecate Mapbox-based traces.[[#4900](https://github.com/plotly/plotly.py/pull/4900)]. See the [MapLibre Migration](https://plotly.com/python/mapbox-to-maplibre/) page for details on migrating from Mapbox to Maplibre.
- Update plotly.py to use base64 encoding of typed arrays e.g. numpy in plotly JSON to keep precision intact and improve performance [[#4470](https://github.com/plotly/plotly.py/pull/4470)].
- Make plotly-express dataframe agnostic via Narwhals [[#4790](https://github.com/plotly/plotly.py/pull/4790)].
- Update `go.FigureWidget` to use `anywidget` [[#4823](https://github.com/plotly/plotly.py/pull/4823)]
- Use modern [native ES6 import](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules) to load plotly.js bundle instead of requirejs which is [no longer under active development](https://github.com/requirejs/r.js/compare/2.3.6...2.3.7) [[#4736](https://github.com/plotly/plotly.py/pull/4763)]
- Update Plotly.js from version 2.34.2 to version 3.0.0-rc0 See the [plotly.js CHANGELOG](https://github.com/plotly/plotly.js/blob/master/CHANGELOG.md#300-rc0----2024-11-11) for more information. These changes are reflected in the auto-generated `plotly.graph_objects` module. Notable changes include:
LiamConnors marked this conversation as resolved.
Show resolved Hide resolved
- Make offsetgroup work with barmode "stacked" and "relative" for bar traces [[#7009](https://github.com/plotly/plotly.js/pull/7009)]
- Drop support for deprecated attributes `titlefont`, `titleposition`, `titleside`, and `titleoffset` [[#7212](https://github.com/plotly/plotly.js/pull/7212)].
archmoj marked this conversation as resolved.
Show resolved Hide resolved
- Drop deprecated pointcloud and heatmapgl traces and gl2d subplots [[#7213](https://github.com/plotly/plotly.js/pull/7213)]
- Drop support for deprecated `bardir` attribute (use `orientation` instead) [[#7214](https://github.com/plotly/plotly.js/pull/7214)]
- Drop support for deprecated `annotation.ref` attribute (use `annotation.xref` and `annotation.yref` instead) [[#7215](https://github.com/plotly/plotly.js/pull/7215)]
- Drop support for deprecated error bar `opacity` attribute (use alpha channel of error bar `color` attribute instead) [[#7214](https://github.com/plotly/plotly.js/pull/7216)]
- Drop support for deprecated attribute `gl3d.cameraposition` (use `gl3d.camera` instead) [[#7217](https://github.com/plotly/plotly.js/pull/7217)]
- Drop deprecated `plot3dPixelRatio` from config [[#7231](https://github.com/plotly/plotly.js/pull/7231)]
- Drop deprecated `zauto`, `zmin` and `zmax` from the surface trace [[#7234](https://github.com/plotly/plotly.js/pull/7234)]
- Drop deprecated `autotick` attributes from cartesian axes [[#7236](https://github.com/plotly/plotly.js/pull/7236)]
- Drop `transforms` from the API [[#7240](https://github.com/plotly/plotly.js/pull/7240), [#7254](https://github.com/plotly/plotly.js/pull/7254)]

## Fixed
- Fix a bug in JupyterLab >= 4 and Jupyter Notebook >= 7 that caused LaTeX to not render in plotly charts [[#4763](https://github.com/plotly/plotly.py/pull/4763)].
- Fix `go.FigureWidget.show` to return `FigureWidget` instead of displaying `Figure` [[#4869](https://github.com/plotly/plotly.py/pull/4869)]

## [5.24.1] - 2024-09-12

Expand All @@ -34,10 +53,6 @@ This project adheres to [Semantic Versioning](http://semver.org/).

- Fixed a bug in integer validation of arrays that threw an error when an array contained a mix of strings and integers.

- Fixed a bug in JupyterLab >= 4 and Jupyter Notebook >= 7 that caused latex to not render in plotly charts.
LiamConnors marked this conversation as resolved.
Show resolved Hide resolved

- Use modern [native ES6 import](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules) to load plotly.js bundle instead of requirejs which is [no longer under active development](https://github.com/requirejs/r.js/compare/2.3.6...2.3.7)

## [5.23.0] - 2024-07-23

### Updated
Expand Down
8 changes: 0 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,6 @@ Built on top of [plotly.js](https://github.com/plotly/plotly.js), `plotly.py` is
- [Contributing to plotly](https://github.com/plotly/plotly.py/blob/master/contributing.md)
- [Changelog](https://github.com/plotly/plotly.py/blob/master/CHANGELOG.md)
- [Code of Conduct](https://github.com/plotly/plotly.py/blob/master/CODE_OF_CONDUCT.md)
- [Version 4 Migration Guide](https://plotly.com/python/v4-migration/)
- [New! Announcing Dash 1.0](https://medium.com/plotly/welcoming-dash-1-0-0-f3af4b84bae)
- [Community forum](https://community.plotly.com)

---
Expand Down Expand Up @@ -143,12 +141,6 @@ or conda
conda install -c plotly plotly-geo=1.0.0
```

## Migration

If you're migrating from plotly.py v3 to v4, please check out the [Version 4 migration guide](https://plotly.com/python/v4-migration/)

If you're migrating from plotly.py v2 to v3, please check out the [Version 3 migration guide](https://github.com/plotly/plotly.py/blob/master/migration-guide.md)

## Copyright and Licenses

Code and documentation copyright 2019 Plotly, Inc.
Expand Down
2 changes: 1 addition & 1 deletion doc/python/LaTeX.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ jupyter:

#### LaTeX Typesetting

Figure titles, axis labels and annotations all accept LaTeX directives for rendering mathematical formulas and notation, when the entire label is surrounded by dollar signs `$...$`. This rendering is handled by the [MathJax library](https://www.mathjax.org/) (version 2.7.5), which must be loaded in the environment where figures are being rendered. MathJax is included by default in Jupyter-like environments, and LateX directives work with Jupyter Notebook version 6. LaTeX directives do not work with Jupyter Notebook version 7. When embedding Plotly figures in other contexts it may be required to ensure that MathJax is separately loaded, for example via a `<script>` tag pointing to a content-delivery network (CDN).
Figure titles, axis labels and annotations all accept LaTeX directives for rendering mathematical formulas and notation, when the entire label is surrounded by dollar signs `$...$`. This rendering is handled by the [MathJax library](https://www.npmjs.com/package/mathjax?activeTab=versions), which must be loaded in the environment where figures are being rendered. MathJax is included by default in Jupyter-like environments. When embedding Plotly figures in other contexts it may be required to ensure that MathJax is separately loaded, for example via a `<script>` tag pointing to a content-delivery network (CDN). Versions 2 and 3 are supported.

```python
import plotly.express as px
Expand Down
275 changes: 0 additions & 275 deletions doc/python/aggregations.md

This file was deleted.

Loading