You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CHANGELOG.md
+59-10
Original file line number
Diff line number
Diff line change
@@ -2,11 +2,60 @@
2
2
All notable changes to this project will be documented in this file.
3
3
This project adheres to [Semantic Versioning](http://semver.org/).
4
4
5
+
## UNRELEASED
5
6
6
-
## [4.14.3] - 2021-01-12
7
+
8
+
## [5.1.0] - 2021-06-28
9
+
10
+
- Updated Plotly.js to from version 2.1.0 to version 2.2.0. See the [plotly.js CHANGELOG](https://github.com/plotly/plotly.js/blob/master/CHANGELOG.md#220----2021-06-28) for more information. These changes are reflected in the auto-generated `plotly.graph_objects` module. Notable changes include:
11
+
- new `<trace>.legendgrouptitle` attribute for legend group titles
12
+
- new `%h` text formatting directive for half-years
13
+
- performance improvements and bug fixes
14
+
15
+
16
+
## [5.0.0] - 2021-06-21
17
+
18
+
### Updated/Changed
19
+
20
+
Items in this section may be considered backwards-incompatible changes for the purposes of [Semantic Versioning](http://semver.org/) but we expect the vast majority of users to be able to upgrade to version 5.0 without encountering any issues.
21
+
22
+
-**Dropped support for Python older than 3.6**[#3160](https://github.com/plotly/plotly.py/pull/3160)
23
+
- Updated Plotly.js to from version 1.58.4 to version 2.1.0. See the [plotly.js CHANGELOG](https://github.com/plotly/plotly.js/blob/master/CHANGELOG.md#210----2021-06-18) for more information. These changes are reflected in the auto-generated `plotly.graph_objects` module. Notable changes include:
24
+
- dropped support for IE9 and IE10
25
+
- dropped support for long-deprecated `graph_objects` like `area` traces and `scatter.(t|r)` and `layout.(radial|angular)axis` attributes
26
+
- modebar no longer has hovermode or spikeline buttons by default (can be added back with `fig.update_layout(modebar_add=["v1hovermode", "toggleSpikeLines"])`)
27
+
- "Aa" text no longer appears on legend items unless `mode="text"`
28
+
- In `bar` traces, `textposition` now defaults to `"auto"`
29
+
- Font size for legend and colorbar titles now matches axis title font size (slightly bigger)
30
+
- deprecated `heatmapgl`, `pointcloud` traces as well as all `transform` attributes
31
+
- Combined `plotlywidget` into `jupyterlab-plotly` and packaged them as a federated extension [#3142](https://github.com/plotly/plotly.py/pull/3142) with massive thanks to [@fcollonval](https://github.com/fcollonval) for the contribution
32
+
- In addition to this change, large Plotly.js bundles are now lazily loaded on-demand by JupyterLab
33
+
- Plotly.js CDN url will now be versioned by default for HTML exports using `include_plotlyjs='cdn'` and for "connected" renderers. [#2961](https://github.com/plotly/plotly.py/pull/2961) with thanks to [@adehad](https://github.com/adehad) for the contribution
34
+
- Recommending Kaleido by default over Orca [#3094](https://github.com/plotly/plotly.py/pull/3094)
35
+
- Replaced `retrying` dependency with `tenacity`[#2911](https://github.com/plotly/plotly.py/pull/2911) with thanks to [@jmsmdy](https://github.com/jmsmdy) for the contribution
36
+
- Plotly Express now always takes into account every value in `category_orders` when computing discrete mappings (color, symbol, line-dash, pattern-shapes) as well as facets, even those values which are absent in the data [#3247](https://github.com/plotly/plotly.py/pull/3247)
37
+
38
+
### Added
39
+
40
+
- Additions due to bumping Plotly.js from 1.58.4 to 2.1.0 (see [changelog]((https://github.com/plotly/plotly.js/blob/master/CHANGELOG.md#210----2021-06-18))):
41
+
- New `icicle` trace type, with thanks to [@Kully](https://github.com/Kully) and [@mtwichan](https://github.com/mtwichan) of [Zyphr](https://www.zyphr.ca/) for their contribution!
42
+
- New `marker.pattern` options for `bar`-like trace types with thanks to [@s417-lama](https://github.com/s417-lama) for the contribution!
43
+
- New `legendrank` attribute to control rank of traces within legends
44
+
- Plotly Express' `px.bar()`, `px.histogram()` and `px.bar_polar()` now support the `pattern_shape` argument [#3252](https://github.com/plotly/plotly.py/pull/3252)
45
+
- New Plotly Express `px.icicle()` function, with thanks to [@Kully](https://github.com/Kully) and [@mtwichan](https://github.com/mtwichan) of [Zyphr](https://www.zyphr.ca/) for their contribution! [#3256](https://github.com/plotly/plotly.py/pull/3256)
46
+
- New functions in `plotly.colors`: `get_colorscale()` and `sample_colorscale()`[#3136](https://github.com/plotly/plotly.py/pull/3136) and [#3186](https://github.com/plotly/plotly.py/pull/3186) with thanks to [@CarlAndersson](https://github.com/CarlAndersson) for the contributions
47
+
- Faster JSON encoding when `orjson` is present [#2955](https://github.com/plotly/plotly.py/pull/2955)
7
48
8
49
### Fixed
9
50
51
+
- Pandas and Numpy datetime serialization fixes [#3022](https://github.com/plotly/plotly.py/pull/3022)
52
+
- Fixed selected points of histograms in FigureWidget [#2771](https://github.com/plotly/plotly.py/pull/2771) with thanks to [@meffmadd](https://github.com/meffmadd) for the contribution
53
+
- Static image export now honors `layout.(width|height)`[#3240](https://github.com/plotly/plotly.py/pull/3240)
54
+
- Improvements to "matplotlylib" conversion utility in `plotly.tools.mpl_to_plotly()` with thanks to [@fdion](https://github.com/fdion)[#3143](https://github.com/plotly/plotly.py/pull/3143)
55
+
56
+
57
+
## [4.14.3] - 2021-01-12
58
+
10
59
-`px.timeline()` now allows `hover_data` formatting of start and end times [3018](https://github.com/plotly/plotly.py/pull/3018)
11
60
- Small change to packaging of `plotlywidget` extension for JupyterLab 3 [3021](https://github.com/plotly/plotly.py/pull/3021)
12
61
@@ -135,7 +184,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
135
184
faster image rendering and smaller figure size. Additional optional arguments
136
185
`binary_backend`, `binary_format` and `binary_compression_level` control
137
186
how to generate the b64 string ([#2691](https://github.com/plotly/plotly.py/pull/2691)
138
-
-`px.imshow` has a new `constrast_rescaling` argument in order to choose how
187
+
-`px.imshow` has a new `contrast_rescaling` argument in order to choose how
139
188
to set data values corresponding to the bounds of the color range
@@ -239,7 +288,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
239
288
240
289
### Added
241
290
242
-
- The `hover_data` parameter of `px` functions can now be a dictionary. This makes it possible to skip hover information for some arguments or to change the formatting of hover informatiom[#2377](https://github.com/plotly/plotly.py/pull/2377).
291
+
- The `hover_data` parameter of `px` functions can now be a dictionary. This makes it possible to skip hover information for some arguments or to change the formatting of hover information[#2377](https://github.com/plotly/plotly.py/pull/2377).
243
292
- It's now possible to build a development version of Plotly.py against the build artifacts from a non-`master` branch of Plotly.js, which makes for faster QA and development cycles [#2349](https://github.com/plotly/plotly.py/pull/2349). Thanks [@zouhairm](https://github.com/zouhairm) for this Pull Request!
244
293
245
294
### Fixed
@@ -252,7 +301,7 @@ This version includes several performance improvements ([#2368](https://github.c
252
301
253
302
- Child graph objects (e.g. `figure.layout.xaxis`) are no longer created eagerly during graph object construction. Instead, they are created lazily the first time the property is accessed.
254
303
- Property validation is now disabled for select internal operations.
255
-
- When used with Python 3.7 and above, ploty.py now takes advantage of [PEP-562](https://www.python.org/dev/peps/pep-0562/) to perform submodule imports lazily. This dramatically improves import times.
304
+
- When used with Python 3.7 and above, plotly.py now takes advantage of [PEP-562](https://www.python.org/dev/peps/pep-0562/) to perform submodule imports lazily. This dramatically improves import times.
256
305
257
306
## [4.6.0] - 2020-03-31
258
307
@@ -290,7 +339,7 @@ This version includes several performance improvements ([#2368](https://github.c
290
339
291
340
- Jupyterlab extension now compatible with both Jupyterlab 1.2 and 2.0 [#2261](https://github.com/plotly/plotly.py/pull/2261) with thanks to [@consideRatio](https://github.com/consideRatio) for the contribution!
292
341
- Fixed a bug when using boolean values for the color argument of px functions [#2127](https://github.com/plotly/plotly.py/pull/2127)
293
-
- Corrected import bug which was occuring with old versions of ipywidgets [#2265](https://github.com/plotly/plotly.py/pull/2265)
342
+
- Corrected import bug which was occurring with old versions of ipywidgets [#2265](https://github.com/plotly/plotly.py/pull/2265)
294
343
- Fixed python 3.8 syntax warning [#2262](https://github.com/plotly/plotly.py/pull/2262), with thanks to [@sgn](https://github.com/sgn) for the contribution!
295
344
296
345
## [4.5.3] - 2020-03-05
@@ -365,7 +414,7 @@ This version includes several performance improvements ([#2368](https://github.c
365
414
for more information
366
415
- The tutorials of the [plotly.py documentation](https://plot.ly/python/) are
367
416
now in the main [plotly.py Github repository](https://github.com/plotly/plotly.py). Contributions in order to improve or extend the documentation are very welcome!
368
-
-`plotly.express` generated plots no longer have a default height of 600 pixels, instead they inherit the default height of regular figures [#1990](https://github.com/plotly/plotly.py/pull/1990). To restore the old behavior, set `px.defaults.height=600` once per session, or set the `height` keyword arguement to any `px.function()` to 600.
417
+
-`plotly.express` generated plots no longer have a default height of 600 pixels, instead they inherit the default height of regular figures [#1990](https://github.com/plotly/plotly.py/pull/1990). To restore the old behavior, set `px.defaults.height=600` once per session, or set the `height` keyword argument to any `px.function()` to 600.
- The width of a figure produced by the `create_gantt` figure factory now resizes responsively ([#1724](https://github.com/plotly/plotly.py/pull/1724))
440
489
441
490
### Fixed
442
-
- The name of the steps property of `graph_objects.indicator.Guage` has been renamed from `stepss` to `steps`
491
+
- The name of the steps property of `graph_objects.indicator.Gauge` has been renamed from `stepss` to `steps`
443
492
- Avoid crash in iframe renderers when running outside iPython ([#1723](https://github.com/plotly/plotly.py/pull/1723))
444
493
445
494
## [4.1.0] - 2019-08-06
@@ -491,7 +540,7 @@ This is a major release that includes many new features, and a few breaking chan
491
540
- Added support for all trace types in `make_subplots` ([#1528](https://github.com/plotly/plotly.py/pull/1528))
492
541
- Added support for secondary y-axes in `make_subplots` ([#1564](https://github.com/plotly/plotly.py/pull/1564))
493
542
- Support passing a scalar trace object (rather than a list or tuple of trace objects) as the `data` property to the `Figure` constructor ([#1614](https://github.com/plotly/plotly.py/pull/1614))
494
-
- Added dictionary-stule`.pop` method to graph object classes ([#1614](https://github.com/plotly/plotly.py/pull/1614))
543
+
- Added dictionary-style`.pop` method to graph object classes ([#1614](https://github.com/plotly/plotly.py/pull/1614))
495
544
- New `jupyterlab-plotly` JupyterLab extension for rendering figures in JupyterLab. Replaces the `@jupyterlab/plotly-extension` extension, and includes JupyterLab 1.0 support.
496
545
- Added new suite of built-in colorscales to the `plotly.colors` module, and support for specifying this wide range of colorscales by name. Also added support for specifying colorscales as a list of colors, in which case the color spacing is assumed to be uniform ([#1647](https://github.com/plotly/plotly.py/pull/1647)).
497
546
- Added `sphinx-gallery` renderer for embedding plotly figures in [Sphinx-Gallery](https://sphinx-gallery.github.io/) ([#1577](https://github.com/plotly/plotly.py/pull/1577), [plotly/plotly-sphinx-gallery](https://github.com/plotly/plotly-sphinx-gallery)).
@@ -1096,7 +1145,7 @@ must be installed:
1096
1145
properties are ignored rather than causing an exception.
1097
1146
- A `to_ordered_dict` method has been added to the `Figure` and `FigureWidget`
1098
1147
classes. This method returns a representation of the figure as a nested
1099
-
structure of `OrdererdDict` and `list` instances where the keys in each
1148
+
structure of `OrderedDict` and `list` instances where the keys in each
1100
1149
`OrderedDict` are sorted alphabetically. This method replaces the
1101
1150
`get_ordered` method that was available in version 2, and makes it possible
1102
1151
to traverse the nested structure of a figure in a deterministic order.
@@ -1517,7 +1566,7 @@ gone.
1517
1566
## [1.12.10] - 2016-11-28
1518
1567
### Updated
1519
1568
-`FF.create_violin` and `FF.create_scatterplotmatrix` now by default do not print subplot grid information in output
1520
-
- Removed alert that occured when downloading plot images offline. Please note: for higher resolution images and more export options, consider making requests to our image servers. See: `help(py.image)` for more details.
1569
+
- Removed alert that occurred when downloading plot images offline. Please note: for higher resolution images and more export options, consider making requests to our image servers. See: `help(py.image)` for more details.
1521
1570
1522
1571
### Added
1523
1572
- Plot configuration options for offline plots. See the list of [configuration options](https://github.com/Rikorose/plotly.py/blob/master/plotly/offline/offline.py#L189) and [examples](https://plot.ly/javascript/configuration-options/) for more information.
Copy file name to clipboardExpand all lines: README.md
+21-24
Original file line number
Diff line number
Diff line change
@@ -33,13 +33,13 @@
33
33
34
34
## Data Science Workspaces
35
35
36
-
Our recommended IDE for Plotly’s Python graphing library is Dash Enterprise’s[Data Science Workspaces](https://plotly.com/dash/workspaces/), which has both Jupyter notebook and Python code file support.
36
+
Our recommended IDE for Plotly’s Python graphing library is Dash Enterprise’s[Data Science Workspaces](https://plotly.com/dash/workspaces/), which has both Jupyter notebook and Python code file support.
37
37
38
38
## Quickstart
39
39
40
-
`pip install plotly==4.14.3`
40
+
`pip install plotly==5.1.0`
41
41
42
-
Inside [Jupyter notebook](https://jupyter.org/install) (installable with `pip install "notebook>=5.3" "ipywidgets>=7.5"`):
42
+
Inside [Jupyter](https://jupyter.org/install) (installable with `pip install "jupyterlab>=3" "ipywidgets>=7.6"`):
43
43
44
44
```python
45
45
import plotly.graph_objects as go
@@ -86,57 +86,54 @@ Built on top of [plotly.js](https://github.com/plotly/plotly.js), `plotly.py` is
86
86
plotly.py may be installed using pip...
87
87
88
88
```
89
-
pip install plotly==4.14.3
89
+
pip install plotly==5.1.0
90
90
```
91
91
92
92
or conda.
93
93
94
94
```
95
-
conda install -c plotly plotly=4.14.3
95
+
conda install -c plotly plotly=5.1.0
96
96
```
97
97
98
-
### Jupyter Notebook Support
98
+
### JupyterLab Support
99
99
100
-
For use in the Jupyter Notebook, install the `notebook` and `ipywidgets`
100
+
For use in [JupyterLab](https://jupyterlab.readthedocs.io/en/stable/), install the `jupyterlab` and `ipywidgets`
101
101
packages using `pip`:
102
102
103
103
```
104
-
pip install "notebook>=5.3" "ipywidgets>=7.5"
104
+
$ pip install "jupyterlab>=3" "ipywidgets>=7.6"
105
105
```
106
106
107
107
or `conda`:
108
108
109
109
```
110
-
conda install "notebook>=5.3" "ipywidgets>=7.5"
110
+
$ conda install "jupyterlab>=3" "ipywidgets>=7.6"
111
111
```
112
112
113
-
### JupyterLab Support
114
-
115
-
For use in JupyterLab, install the `jupyterlab` and `ipywidgets`
116
-
packages using `pip`:
113
+
The instructions above apply to JupyterLab 3.x. **For JupyterLab 2 or earlier**, run the following commands to install the required JupyterLab extensions (note that this will require [`node`](https://nodejs.org/) to be installed):
Please check out our [Troubleshooting guide](https://plotly.com/python/troubleshooting/) if you run into any problems with JupyterLab.
121
+
122
+
### Jupyter Notebook Support
123
+
124
+
For use in the Jupyter Notebook, install the `notebook` and `ipywidgets`
125
+
packages using `pip`:
123
126
124
127
```
125
-
conda install jupyterlab "ipywidgets>=7.5"
128
+
pip install "notebook>=5.3" "ipywidgets>=7.5"
126
129
```
127
130
128
-
Then run the following commands to install the required JupyterLab extensions (note that this will require [`node`](https://nodejs.org/) to be installed):
0 commit comments