Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

jupyterlab-plotly

plotly75.4kMIT5.24.1

The plotly Jupyter extension

jupyter, widgets, ipython, ipywidgets, plotly

readme

Jupyter Extension for Plotly.py

See https://plot.ly/python/getting-started/ for details.

Install with jupyter labextension install plotlywidget in JupyterLab, otherwise just install Plotly.py and it will automatically work in Classic Notebooks.

changelog

Changelog

All notable changes to this project will be documented in this file. This project adheres to Semantic Versioning.

Unreleased

Fixed

[6.0.1] - 2025-03-14

Updated

  • Updated Plotly.js from version 3.0.0 to version 3.0.1. See the plotly.js CHANGELOG for more information.

Fixed

  • Fix TypeError when using orjson to serialize pandas.NA [#5040].
  • Fix issue where using category_orders on px.pie raised ColumnNotFoundError [#5000].
  • Fix incorrect DeprecationWarning shown when creating a px chart [#5080, #5086]

[6.0.0] - 2025-01-28

Added

  • Add plotly[express] extra for easily installing Plotly Express dependencies [#4644]
  • Add subtitle attribute to all Plotly Express traces [#4830].

Removed

  • Drop deprecated pointcloud and heatmapgl traces from the API [#4815]
  • Drop tenacity dependency [#4831]
  • Drop support for Jupyter Notebook version 6 and earlier [#4822]. The minimum supported version is now 7.0.0.

Updated

  • Update Plotly.js from version 2.34.2 to version 3.0.0 See the plotly.js CHANGELOG for more information. These changes are reflected in the auto-generated plotly.graph_objects module. Notable changes include:
    • Make offsetgroup work with barmode "stacked" and "relative" for bar traces [#7009]
    • Drop support for deprecated attributes titlefont, titleposition, titleside, and titleoffset [#7212].
    • Drop deprecated pointcloud and heatmapgl traces and gl2d subplots [#7213]
    • Drop support for deprecated bardir attribute (use orientation instead) [#7214]
    • Drop support for deprecated annotation.ref attribute (use annotation.xref and annotation.yref instead) [#7215]
    • Drop support for deprecated error bar opacity attribute (use alpha channel of error bar color attribute instead) [#7214]
    • Drop support for deprecated attribute gl3d.cameraposition (use gl3d.camera instead) [#7217]
    • Drop deprecated plot3dPixelRatio from config [#7231]
    • Drop deprecated zauto, zmin and zmax from the surface trace [#7234]
    • Drop deprecated autotick attributes from cartesian axes [#7236]
    • Drop transforms from the API [#7240, #7254]
  • Deprecate Mapbox-based traces.[#4900]. See the MapLibre Migration 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].
  • Make plotly-express dataframe agnostic via Narwhals [#4790].
  • Update go.FigureWidget to use anywidget [#4823]
  • Use modern native ES6 import to load plotly.js bundle instead of requirejs which is no longer under active development [#4736]

Fixed

  • Fix a bug in JupyterLab >= 4 and Jupyter Notebook >= 7 that caused LaTeX to not render in plotly charts [#4763].
  • Fix go.FigureWidget.show to return FigureWidget instead of displaying Figure [#4869]

[5.24.1] - 2024-09-12

Updated

  • Updated Plotly.js from version 2.35.0 to version 3.0.0-rc.0. See the plotly.js CHANGELOG for more information.

[5.24.0] - 2024-08-29

Added

  • New px functions for maps: scatter_map, line_map, choropleth_map, and density_map.

Updated

  • Updated Plotly.js from version 2.34.0 to version 2.35.0. See the plotly.js CHANGELOG for more information. These changes are reflected in the auto-generated plotly.graph_objects module. Notable changes include:

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

[5.23.0] - 2024-07-23

Updated

  • Updated Plotly.js from version 2.32.0 to version 2.34.0. See the plotly.js CHANGELOG for more information. These changes are reflected in the auto-generated plotly.graph_objects module. Notable changes include:
    • Add subtitle attribute to layout.title to enable adding subtitles to plots [#7012]
    • Introduce "u" and "s" pseudo html tags to add partial underline and strike-through styles to SVG text elements [#7043]
    • Add geometric mean functionality and 'geometric mean ascending' + 'geometric mean descending' to category_order on cartesian axes [#6223], with thanks to @acxz and @prabhathc for the contribution!
    • Add axis property ticklabelindex for drawing the label for each minor tick n positions away from a major tick, with thanks to @my-tien for the contribution! [#7036]
    • Add property ticklabelstandoff and ticklabelshift to cartesian axes to adjust positioning of tick labels, with thanks to @my-tien for the contribution! [#7006]
    • Add x0shift, x1shift, y0shift, y1shift to shapes to add control over positioning of shape vertices on (multi-)category axes, with thanks to @my-tien for the contribution! [#7005]
  • Specify Python version 3.8-3.11 for development virtual environments and pin pytest at version 8.1.1 to match.
  • Update IntegerValidator to handle extras option to allow supporting additional keyword values. For example, 'bold' and 'normal' as well as integers as used in font weights [#4612].

[5.22.0] - 2024-05-01

Updated

  • Updated Plotly.js from version 2.31.1 to version 2.32.0. See the plotly.js CHANGELOG for more information. These changes are reflected in the auto-generated plotly.graph_objects module. Notable changes include:
    • Add "bold" weight, "italic" style and "small-caps" variant options to fonts [#6956]
    • Fix applying autotickangles on axes with showdividers as well as cases where tickson is set to "boundaries" [#6967], with thanks to @my-tien for the contribution!
    • Fix positioning of multi-line axis titles with standoff [#6970], with thanks to @my-tien for the contribution!

[5.21.0] - 2024-04-17

Updated

  • Updated Plotly.js from version 2.30.0 to version 2.31.1. See the plotly.js CHANGELOG for more information. These changes are reflected in the auto-generated plotly.graph_objects module. Notable changes include:
    • Add zorder attribute to various cartesian traces for controlling stacking order of SVG traces drawn into a subplot [#6918, #6953], This feature was anonymously sponsored: thank you to our sponsor!
    • Add "between" option to shape layer for placing them above grid lines and below traces [#6927], with thanks to @my-tien for the contribution!
    • Add "raw" sizemode to cone trace [#6938]
    • Add layout.hoversubplots to enable hover effects across multiple cartesian suplots sharing one axis [#6947, #6950]

Fixed

  • Fixed orjson loading issue [#4562]

[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 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], with thanks to @lumip for the contribution!
    • Add indentation to legend [#6874], with thanks to @my-tien for the contribution!

[5.19.0] - 2024-02-15

Updated

  • Updated Plotly.js from version 2.27.0 to version 2.29.1. See the plotly.js CHANGELOG for more information. These changes are reflected in the auto-generated plotly.graph_objects module. Notable changes include:
    • Add layout.barcornerradius and trace.marker.cornerradius properties to support rounding the corners of bar traces [#6761], with thanks to Displayr for sponsoring development!
    • Add autotickangles to cartesian and radial axes [#6790], with thanks to @my-tien for the contribution!
    • Add align option to sankey nodes to control horizontal alignment [#6800], with thanks to @adamreeve for the contribution!
    • Add the possibility of loading "virtual-webgl" script for WebGL 1 to help display several WebGL contexts on a page [#6784], with thanks to @greggman for the contribution!
    • Add options to use base64 encoding (bdata) and shape (for 2 dimensional arrays) to declare various typed arrays i.e. dtype=(float64|float32|int32|int16|int8|uint32|uint16|uint8) [#5230]
    • Adjust stamen styles to point to stadiamaps.com, the users may also need to provide their own API_KEY via config.mapboxAccessToken [#6776, #6778]
  • Removed Python 3.6 and Python 3.7 support [#4492]

Fixed

  • Ensure scatter mode is deterministic from px [#4429]
  • Fix issue with creating dendrogram in subplots [#4411],
  • Fix issue with px.line not accepting "spline" line shape [#2812]
  • Fix KeyError when using column of pd.Categorical dtype with unobserved categories [#4437]
  • Fix dataframe interchange in case column_names returns an unmaterialized object: generator, iterator, etc. [#4442]
  • Fix issue with FutureWarning being displayed when setting the color argument in plotly.express [#4519]

[5.18.0] - 2023-10-25

Updated

  • Updated Plotly.js from version 2.26.0 to version 2.27.0. See the plotly.js CHANGELOG for more information. These changes are reflected in the auto-generated plotly.graph_objects module. Notable changes include:
    • Add insiderange to cartesian axes to help avoid overlap between visible grid lines and tick labels of the counter axis when they are positioned inside [#6735], this feature was anonymously sponsored: thank you to our sponsor!
    • Fix column order changes on hover [#6718], with thanks to @bhavinpatel1109 for the contribution!
    • Fix hover at timestamp '1970-01-01 00:00:00' [#6752], with thanks to @adamjhawley for the contribution!
    • Fix clearing empty candlestick using react [#6757]

Fixed

  • Repair crash on Matplotlib 3.8 related to get_offset_position [#4372],
  • Handle deprecation of pandas.Series.dt.to_pydatetime() calls and suppress the FutureWarning they currently emit. [#4379]

[5.17.0] - 2023-09-15

Updated

  • Improved json docstrings, added BasePlotlyType.to_json() method [#4301]
  • Updated Plotly.js from version 2.25.2 to version 2.26.0. See the plotly.js CHANGELOG for more information. These changes are reflected in the auto-generated plotly.graph_objects module. Notable changes include:
    • Add "min", "max", "min reversed" and "max reversed" autorange options and handle partial ranges (i.e. one end being null), add autorangeoptions (clipmin, clipmax, minallowed, maxallowed, include) as well as minallowed and maxallowed to cartesian, gl3d and radial axes [#6547]
    • Add [n]-sigma (std deviations) box plots as an alternative to quartiles [#6697], with thanks to @28raining for the contribution!
    • Add "top left" & "top center" side options to legend title [#6711], with thanks to @28raining for the contribution!
    • Add "false" option to scaleanchor to allow removing a constraint that is set by default [#6712], with thanks to @lvlte for the contribution!

Fixed

  • Fixed two issues with px.imshow: [#4330] when facet_col is an earlier dimension than animation_frame for xarrays and [#4329] when facet_col has string coordinates in xarrays [#4331]

[5.16.1] - 2023-08-16

Fixed

  • Fixed issue with necessary columns from complex arguments dropped when interchanging dataframes [#4324]

[5.16.0] - 2023-08-11

Updated

  • Updated Plotly.js from version 2.24.1 to version 2.25.2. See the plotly.js CHANGELOG for more information. These changes are reflected in the auto-generated plotly.graph_objects module. Notable changes include:
    • Add "Equal Earth" projection to geo subplots [#6670], with thanks to @apparebit for the contribution!
    • Add options to include legends for shapes and newshape [#6653]
  • px methods now accept data-frame-like objects that support a dataframe interchange protocol, such as polars, vaex, modin etc. This protocol has priority on to_pandas call, but will only be used if pandas>=2.0.2 is installed in the environment.
  • px methods now accept data-frame-like objects that support a toPandas() method, such as Spark DataFrames, or a to_pandas_df() method, such as Vaex DataFrames.

Fixed

  • Fixed Pandas performance warning issue caused by multiple frame.insert [#4246]

[5.15.0] - 2023-06-08

Updated

  • Updated Plotly.js from version 2.20.0 to version 2.24.1. See the plotly.js CHANGELOG for more information. Notable changes include:
    • Add pattern to pie, funnelarea, sunburst, icicle and treemap traces [#6601, #6619, #6622, #6626, #6627, #6628, #6629], with thanks to @thierryVergult for the contribution!
    • Add texttemplate to shape.label for parametric shapes i.e. line, rect and circle [#6527], with thanks to the Volkswagen Center of Excellence for Battery Systems for sponsoring development!
    • Add strict option to custom bundle command [#6557], with thanks to @CallumNZ for the contribution!
    • Add legend references to traces and legend2, legend3, etc. to layout, also add visible to legend i.e. to allow positioning multiple legends on a graph [#6535], this feature was anonymously sponsored: thank you to our sponsor!
    • Add legend.xref and legend.yref to enable container-referenced positioning of legends [#6589], with thanks to Gamma Technologies for sponsoring the related development.
    • Add colorbar.xref and colorbar.yref to enable container-referenced positioning of colorbars [#6593], with thanks to Gamma Technologies for sponsoring the related development.
  • px methods now accept data-frame-like objects that support a to_pandas() method, such as polars, cudf, vaex etc [#4244], [#4286]

Fixed

  • Fixed another compatibility issue with Pandas 2.0, just affecting px.*(line_close=True) [#4190]
  • Empty pandas dataframe with facet row/column set no longer fails [#4038]
  • Added some rounding to the make_subplots function to handle situations where the user-input specs cause the domain to exceed 1 by small amounts [#4153]
  • Sanitize JSON output to prevent an XSS vector when graphs are inserted directly into HTML [#4196]
  • Fixed issue with shapes and annotations plotting on the wrong y axis when supplied with a specific axis in the yref parameter [#4177]
  • Remove use_2to3 setuptools arg, which is invalid in the latest Python and setuptools versions [#4206]
  • Fix #4066 JupyterLab v4 giving tiny default graph height [#4227]
  • Fixed issue with colors.n_colors where generated RGB color values were not being constrained to stay between 0 and 255 [#4110]
  • Fix streamline figure factory with recent versions of Numpy
  • Fix issue with shapes and annotations not drawing on correct axis [#4177]

[5.14.1] - 2023-04-05

Fixed

  • Fixed compatibility issue with Pandas 2.0 [#4103]

[5.14.0] - 2023-03-29

Updated

  • Updated Plotly.js from version 2.18.2 to version 2.20.0. See the plotly.js CHANGELOG for more information. Notable changes include:
    • Add title.automargin to enable automatic top and bottom margining for both container and paper referenced titles [#6428], with thanks to Gamma Technologies for sponsoring the related development.
    • Add label attribute to shapes [#6454], with thanks to the Volkswagen Center of Excellence for Battery Systems for sponsoring development!
    • Add labelalias to various axes namely cartesian, gl3d, polar, smith, ternary, carpet, indicator and colorbar [#6481], this feature was anonymously sponsored: thank you to our sponsor!
  • Key errors no longer precalculated when performing updates on plots [#4101]

Fixed

  • Fixed an issue with characters displaying incorrectly, by adding charset="utf-8" to scripts in to_html [#4114]
  • Added packaging to install requirements, fixing a No module named 'packaging error on Python 3.6 [#4113]

Added

  • Added option to allow passing a column name as a str in hover_data and custom_data in plotly.express [4083]

[5.13.1] - 2023-02-24

Updated

  • Updated Plotly.js to from version 2.18.0 to version 2.18.2. See the plotly.js CHANGELOG for more information. These changes are reflected in the auto-generated plotly.graph_objects module.
  • Updated distutils.Version to packaging.Version #3897] and #4055]

[5.13.0] - 2023-01-23

Updated

  • Updated Plotly.js to from version 2.17.1 to version 2.18.0. See the plotly.js CHANGELOG for more information. Notable changes include:
    • Add sync tickmode option [#6356, #6443], with thanks to @filipesantiagoAM and @VictorBezak for the contribution!
  • Build process now uses Node 18.x and version 2 lockfile (should be an invisible change for users) [#4034]

Fixed

  • write_html() now explicitly encodes output as UTF-8 because Plotly.js' bundle contains such characters [#4021] and [#4022]
  • fixed iframe renderer regression from 5.12 and also fixed error when this renderer was used in the very first cell in a notebook [#4036]

[5.12.0] - 2023-01-12

Updated

  • Support for ipywidgets 8 [#3930]
  • Updated Plotly.js to from version 2.16.1 to version 2.17.1. See the plotly.js CHANGELOG for more information. Notable changes include:
    • Add shift and autoshift to cartesian y axes to help avoid overlapping of multiple axes [#6334], with thanks to Gamma Technologies for sponsoring the related development!
    • Introduce group attributes for scatter trace i.e. alignmentgroup, offsetgroup, scattermode and scattergap [#6381], this feature was anonymously sponsored: thank you to our sponsor!
    • Add marker.cornerradius attribute to treemap trace [#6351]

      Fixed

  • Fixed the usage of some deprecated NumPy types which were removed in NumPy 1.24 [#3997]
  • Fixed bug for trendlines with datetime axes [#3683]
  • marker.angle attribute now accepts iterables where appropriate [#4013]
  • selector=0 now correctly returns the first trace in .select_traces() and related methods [#3817]

[5.11.0] - 2022-10-27

Updated

  • Updated Plotly.js to from version 2.14.0 to version 2.16.1. See the plotly.js CHANGELOG for more information. Notable changes include:
    • Add clustering options to scattermapbox [#5827], with thanks to @elben10 for the contribution!
    • Add bounds to mapbox suplots [6339]
    • Add angle, angleref and standoff to marker and add backoff to line; also introduce new arrow symbols to facilitate drawing networks [#6297]
    • Add minreducedwidth and minreducedheight to layout for increasing control over automargin [#6307]
    • Add entrywidth and entrywidthmode to legend [#6202, #6324]

[5.10.0] - 2022-08-11

Updated

  • Updated Plotly.js to from version 2.12.1 to version 2.14.0. See the plotly.js CHANGELOG for more information. Notable changes include:
    • Add support for sankey links with arrows
    • Add selections, newselection and activeselection layout attributes to have persistent and editable selections over cartesian subplots
    • Add unselected.line.color and unselected.line.opacity options to parcoords trace
    • Display Plotly's new logo in the modebar

[5.9.0] - 2022-06-23

Added

  • pattern_shape options now available in px.timeline() #3774
  • facet_* and category_orders now available in px.pie() #3775

Performance

  • px methods no longer call groupby on the input dataframe when the result would be a single group, and no longer groups by a lambda, for significant speedups #3765 with thanks to @jvdd

Updated

  • Allow non-string extras in flaglist attributes, to support upcoming changes to ax.automargin in plotly.js plotly.js#6193, #3749

[5.8.2] - 2022-06-10

Fixed

  • Fixed a syntax error that caused rendering issues in Databricks notebooks and likely elsewhere. #3763 with thanks to @fwetdb

[5.8.1] - 2022-06-08

(no changes, due to a mixup with the build process!)

[5.8.0] - 2022-05-09

Fixed

  • Improve support for type checking and IDE auto-completion by bypassing lazy-loading when type checking. #3425 with thanks to @JP-Ellis
  • line dash-style validators are now correctly used everywhere so that values like 10px 2px are accepted #3722
  • Resolved various deprecation warning messages and compatibility issues with upstream dependencies and Python 3.11, plus removed dependency on six, with thanks to @maresb, @hugovk, @tirkarthi, @martinRenou, and @BjoernLudwigPTB
  • Better support for MathJax 3 #3706

Added

  • Type annotations for Plotly Express functions and chainable go.Figure methods, for better IDE auto-completion #3708

Updated

  • Updated Plotly.js to from version 2.11.1 to version 2.12.1. See the plotly.js CHANGELOG for more information. Notable changes include:
    • Add minor ticks to cartesian axes
    • Add griddash option to most axes

[5.7.0] - 2022-04-05

Added

  • added pattern_shape options to px.area() #3668

Updated

  • Updated Plotly.js to from version 2.9.0 to version 2.11.1. See the plotly.js CHANGELOG for more information. Notable changes include:
    • Add fillpattern options to scatter trace
    • Various JS-specific improvements such as MathJax 3.0 support

[5.6.0] - 2022-02-09

Updated

  • Updated Plotly.js to from version 2.8.3 to version 2.9.0. See the plotly.js CHANGELOG for more information. Notable changes include:
    • Implement ticklabelstep to reduce labels on cartesian axes and colorbars
    • Display the version of plotly.js when hovering over the modebar

[5.5.0] - 2021-12-20

Added

  • text_auto argument to px.bar, px.histogram, px.density_heatmap, px.imshow #3518
  • Deprecated ff.create_annotated_heatmap, ff.create_county_choropleth, ff.create_gantt #3518
  • div_id argument to pio.to_html, pio.write_html, fig.to_html and fig.write_html to optionally make its IDs deterministic #3487 with thanks to @Skn0tt

Fixed

  • Fixed ValueError when ff.create_annotated_heatmap passes rgba() colors into to_rgb_color_list #3478 with thanks to @janosh

Updated

  • Updated Plotly.js to from version 2.6.3 to version 2.8.3. See the plotly.js CHANGELOG for more information. Notable changes include:
    • Horizontal color bars
    • texttemplate for histogram-like and heatmap-like traces

[5.4.0] - 2021-11-15

Fixed

  • Fixed error when serializing dict with mix of string and non-string keys #3380

Updated

  • The JSON serialization engines no longer sort their keys #3380
  • Updated Plotly.js to from version 2.4.2 to version 2.6.3. See the plotly.js CHANGELOG for more information. Notable changes include:
    • New subplot type smith that supports scattersmith trace types for visualizing data in the complex domain
    • Changes to Plotly.js packaging

[5.3.1] - 2021-08-31

Updated

  • Updated Plotly.js to from version 2.4.1 to version 2.4.2. See the plotly.js CHANGELOG for more information. These changes are reflected in the auto-generated plotly.graph_objects module. Notable changes include:
    • Bug fix for rendering unified hover labels in classic Jupyter Notebooks

[5.3.0] - 2021-08-29

Updated

  • Updated Plotly.js to from version 2.3.1 to version 2.4.1. See the plotly.js CHANGELOG for more information. These changes are reflected in the auto-generated plotly.graph_objects module. Notable changes include:
    • Added legend.groupclick options
    • Provide bbox of hover items in event data

[5.2.2] - 2021-08-23

Fixed

  • Fixed error when using the orjson engine with non-string keys #3351

[5.2.1] - 2021-08-13

Updated

  • Updated Plotly.js to from version 2.2.0 to version 2.3.1. See the plotly.js CHANGELOG for more information. These changes are reflected in the auto-generated plotly.graph_objects module. Notable changes include:
    • new projections in geo subplots from a more recent version of d3-geo
    • new number-formatting directives from a more recent version of d3-format
    • Improve rendering of scattergl, splom and parcoords by implementing plotGlPixelRatio for those traces
    • performance improvements and bug fixes

Added

  • Extra flags were added to the gapminder and stocks dataset to facilitate testing, documentation and demos #3305
  • All line-like Plotly Express functions now accept markers argument to display markers, and all but line_mapbox accept symbol to map a field to the symbol attribute, similar to scatter-like functions #3326
  • px.scatter and px.density_contours now support new trendline types 'rolling', 'expanding' and 'ewm' #2997
  • px.scatter and px.density_contours now support new trendline_options argument to parameterize trendlines, with support for constant control and log-scaling in 'ols' and specification of the fraction used for 'lowess', as well as pass-through to Pandas for 'rolling', 'expanding' and 'ewm' #2997
  • px.scatter and px.density_contours now support new trendline_scope argument that accepts the value 'overall' to request a single trendline for all traces, including across facets and animation frames #2997
  • A new px.ecdf() function for Empirical Cumulative Distribution Functions #3330

Fixed

  • Fixed regression introduced in version 5.0.0 where pandas/numpy arrays with dtype of Object were being converted to list values when added to a Figure (#3292, #3293)
  • Better detection of Chrome and Chromium browsers in the Renderers framework, especially on Linux (#3278) with thanks to @c-chaitanya for the contribution

[5.1.0] - 2021-06-28

  • Updated Plotly.js to from version 2.1.0 to version 2.2.0. See the plotly.js CHANGELOG for more information. These changes are reflected in the auto-generated plotly.graph_objects module. Notable changes include:
    • new <trace>.legendgrouptitle attribute for legend group titles
    • new %h text formatting directive for half-years
    • performance improvements and bug fixes

[5.0.0] - 2021-06-21

Updated/Changed

Items in this section may be considered backwards-incompatible changes for the purposes of Semantic Versioning but we expect the vast majority of users to be able to upgrade to version 5.0 without encountering any issues.

  • Dropped support for Python older than 3.6 #3160
  • Updated Plotly.js to from version 1.58.4 to version 2.1.0. See the plotly.js CHANGELOG for more information. These changes are reflected in the auto-generated plotly.graph_objects module. Notable changes include:
    • dropped support for IE9 and IE10
    • dropped support for long-deprecated graph_objects like area traces and scatter.(t|r) and layout.(radial|angular)axis attributes
    • modebar no longer has hovermode or spikeline buttons by default (can be added back with fig.update_layout(modebar_add=["v1hovermode", "toggleSpikeLines"]))
    • "Aa" text no longer appears on legend items unless mode="text"
    • In bar traces, textposition now defaults to "auto"
    • Font size for legend and colorbar titles now matches axis title font size (slightly bigger)
    • deprecated heatmapgl, pointcloud traces as well as all transform attributes
  • Combined plotlywidget into jupyterlab-plotly and packaged them as a federated extension #3142 with massive thanks to @fcollonval for the contribution
    • In addition to this change, large Plotly.js bundles are now lazily loaded on-demand by JupyterLab
  • Plotly.js CDN url will now be versioned by default for HTML exports using include_plotlyjs='cdn' and for "connected" renderers. #2961 with thanks to @adehad for the contribution
  • Recommending Kaleido by default over Orca #3094
  • Replaced retrying dependency with tenacity #2911 with thanks to @jmsmdy for the contribution
  • 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

Added

  • Additions due to bumping Plotly.js from 1.58.4 to 2.1.0 (see changelog):
    • New icicle trace type, with thanks to @Kully and @mtwichan of Zyphr for their contribution!
    • New marker.pattern options for bar-like trace types with thanks to @s417-lama for the contribution!
    • New legendrank attribute to control rank of traces within legends
  • Plotly Express' px.bar(), px.histogram() and px.bar_polar() now support the pattern_shape argument #3252
  • New Plotly Express px.icicle() function, with thanks to @Kully and @mtwichan of Zyphr for their contribution! #3256
  • New functions in plotly.colors: get_colorscale() and sample_colorscale() #3136 and #3186 with thanks to @CarlAndersson for the contributions
  • Faster JSON encoding when orjson is present #2955

Fixed

  • Pandas and Numpy datetime serialization fixes #3022
  • Fixed selected points of histograms in FigureWidget #2771 with thanks to @meffmadd for the contribution
  • Static image export now honors layout.(width|height)#3240
  • Improvements to "matplotlylib" conversion utility in plotly.tools.mpl_to_plotly() with thanks to @fdion #3143

[4.14.3] - 2021-01-12

  • px.timeline() now allows hover_data formatting of start and end times 3018
  • Small change to packaging of plotlywidget extension for JupyterLab 3 3021

[4.14.2] - 2021-01-11

Updated

  • JupyterLab extensions now compatible with JupyterLab 3.x 3016
  • Updated Plotly.js to version 1.58.4. See the plotly.js CHANGELOG for more information. These changes are reflected in the auto-generated plotly.graph_objects module. Notable changes include:
    • fixes for rendering 3d plots on recent Safari versions
    • fixes to inside ticklabels
    • regression fixes

Fixed

  • px.histogram() Y-axis labels now take into account histnorm and barnorm 2989
  • px.histogram() marginal and facet_* now work correctly together 3014

[4.14.1] - 2020-12-09

Updated

  • Updated Plotly.js to version 1.58.2. See the plotly.js CHANGELOG for more information. These changes are reflected in the auto-generated plotly.graph_objects module. Notable changes include:
    • fixes for new ticklabelposition attribute
    • fixes for a regression related to treemaps in the previous version

[4.14.0] - 2020-12-07

Added

  • px.imshow now supports facet_col and animation_frame arguments for visualizing 3-d and 4-d images 2746
  • px.defaults now supports color_discrete_map, symbol_map, line_dash_map, labels and category_orders as well as a .reset() method 2957

Fixed

  • axes will now auto-type numeric strings as categorical data rather than linear in the default templates 2951

Updated

  • Updated Plotly.js to version 1.58.1. See the plotly.js CHANGELOG for more information. These changes are reflected in the auto-generated plotly.graph_objects module. Notable changes include:
    • a new ticklabelposition attribute to enable positioning tick labels inside the plotting area
    • better support for scaleanchor and matches on cartesian axes for matched square subplots
    • a new autotypenumbers attribute which is now set to strict in the default templates
    • various fixes relating to automargins for small figures

[4.13.0] - 2020-11-23

Added

  • px.choropleth, px.scatter_geo and px.line_geo now support faceting as well as fitbounds and basemap_visible 2923
  • px.scatter_geo and px.line_geo now support geojson/featureidkey input 2923
  • px.scatter_geo now supports symbol 2923
  • go.Figure now has a set_subplots method to set subplots on an already existing figure. 2866
  • Added Turbo colorscale and fancier swatch display functions 2882
  • A utility function image_array_to_data_uri has been added in plotly.utils, in order to transform NumPy arrays to data b64 URIs (which can be passed to the source parameter of go.Image, or to layout images). 2879
  • the selector argument to updater/selector functions now accepts ints and strs 2894

Updated

  • the JSON serialization of plotly figures has been accelerated thanks to a different handling of Infinity and NaN values. For example, a figure with a 1000x1000 Heatmap should now serialize 2x faster. 2880
  • Coding mistakes with "magic underscores" now return significantly more ergonomic error messages 2843
  • Error messages related to impossible subplot geometries are now much more helpful 2897

Fixed

  • px.scatter_geo support for text is fixed 2923
  • the x and y parameters of px.imshow are now used also in the case where an Image trace is used (for RGB data or with binary_string=True). However, only numerical values are accepted (while the Heatmap trace allows date or string values for x and y). 2761

[4.12.0] - 2020-10-23

Added

  • For add_trace, add_shape, add_annotation and add_layout_image, the row and/or col argument now also accept the string "all". row="all" adds the object to all the subplot rows and col="all" adds the object to all the subplot columns. (#2840)
  • Shapes that reference the plot axes in one dimension and the data in another dimension can be added with the new add_hline, add_vline, add_hrect, add_vrect functions, which also support the row="all" and col="all" arguments. (#2840)
  • The add_trace, add_shape, add_annotation, add_layout_image, add_hline, add_vline, add_hrect, add_vrect functions accept an argument exclude_empty_subplots which if True, only adds the object to subplots already containing traces or layout objects. This is useful in conjunction with the row="all" and col="all" arguments. (#2840)
  • For all go.Figure functions accepting a selector argument (e.g., select_traces), this argument can now also be a function which is passed each relevant graph object (in the case of select_traces, it is passed every trace in the figure). For graph objects where this function returns true, the graph object is included in the selection. (#2844)

Added

  • Better magic underscore error messages. For example, some_fig.update_layout(geo_ltaxis_showgrid=True) shows Bad property path:\ngeo_ltaxis_showgrid\n ^ and lists the valid properties for geo.

Updated

  • Updated Plotly.js to version 1.57.1. See the plotly.js CHANGELOG for more information. These changes are reflected in the auto-generated plotly.graph_objects module.

[4.11.0] - 2020-10-01

Updated

  • Updated Plotly.js to version 1.56.0. See the plotly.js CHANGELOG for more information. These changes are reflected in the auto-generated plotly.graph_objects module.

[4.10.0] - 2020-09-10

Added

  • Added plotly.io.full_figure_for_development() and plotly.graph_objects.Figure.full_figure_for_development() (#2737)

Updated

  • The JSON serialization of plotly figures had been accelerated by handling differently figures with and without NaN and Inf values (#2880).

Updated

  • Updated Plotly.js to version 1.55.2. See the plotly.js CHANGELOG for more information. These changes are reflected in the auto-generated plotly.graph_objects module.
  • px.imshow has a new binary_string boolean argument, which passes the image data as a b64 binary string when True. Using binary strings allow for faster image rendering and smaller figure size. Additional optional arguments binary_backend, binary_format and binary_compression_level control how to generate the b64 string (#2691
  • px.imshow has a new contrast_rescaling argument in order to choose how to set data values corresponding to the bounds of the color range (#2691

Fixed

  • Plotly Express no longer converts datetime columns of input dataframes to UTC (#2749)
  • Plotly Express has more complete support for datetimes as additional hover_data (#2749)
  • Histogram selection behaviour with FigureWidget (#2711) with thanks to @meffmadd
  • Behaviour of full_html() with html=False (#2469) with thanks to @tallamjr
  • ff.distplot() now only computes traces that will be shown (#2730) with thanks to @akbo
  • Pandas backend .hist() works with latest version of Pandas (#2713) with thanks to @Kerybas

[4.9.0] - 2020-07-16

Added

  • Added image export support using Kaleido. The image export backend can be configured using the new engine argument to plotly.io.to_image and plotly.io.write_image. The engine argument may be set to "kaleido", "orca", or "auto". The default is engine="auto", in which case the Kaleido backend is enabled if the kaleido package from PyPI is installed, otherwise Orca is used. (#2613).
  • plotly.express.timeline() added as an official alternative to plotly.figure_factories.create_gantt() (#2626)
  • create_hexbin_mapbox() added to Figure Factories, with thanks to @RenaudLN for the impressive contribution!
  • facet_row_spacing and facet_col_spacing added to Plotly Express cartesian 2d functions (#2614)
  • base added to Plotly Express bar and bar_polar functions (#2626)
  • px.NO_COLOR constant to override wide-form color assignment in Plotly Express (#2614)

Fixed

  • trendline traces are now of type scattergl when render_mode="webgl" in Plotly Express (#2614)
  • regression from 4.8.1 whereby "parent" was not accepted as part of path for px.sunburst() and px.treemap() (#2640)
  • create_dendrogram() figure factory now works correctly with scipy 1.5.1 (#2627)

Updated

  • Updated Plotly.js to version 1.54.6. See the plotly.js CHANGELOG for more information.
  • Added all cartesian-2d Plotly Express functions, plus imshow, to Pandas backend with kind option (#2541)
  • plotly.express.imshow now uses data frame index and columns names and values to populate axis parameters by default (#2539)
  • Javascript extensions are now build using Node 12, and have an updated package-lock.json with many fewer security warnings (#2636)

[4.8.2] - 2020-06-26

Updated

  • Updated Plotly.js to version 1.54.5. See the plotly.js CHANGELOG for more information.
  • add_traces() now accepts bare int-like values for rows/cols as well as lists thereof (#2546), with thanks to @MCBoarder289 for the contribution!

Fixed

  • row/col now accept int-like values, not strictly int values (#2451), with thanks to @MCBoarder289 for the contribution!
  • Fixed special cases with px.sunburst and px.treemap with path input (#2524)
  • Fixed bug in hover_data argument of px functions, when the column name is changed with labels and hover_data is a dictionary setting up a specific format for the hover data (#2544).
  • Made the Plotly Express trendline argument more robust and made it work with datetime x values (#2554)
  • Fixed bug in px.sunburst and px.treemap: when the color and values arguments correspond to the same column, a different aggregation function has to be used for the two arguments (#2591)
  • Plotly Express wide mode now accepts mixed integer and float columns (#2598)
  • Plotly Express range_(x|y) should not impact the unlinked range of marginal subplots (#2600)
  • px.line now sets line_group=<variable> in wide mode by default (#2599)
  • Corrected some regex warnings (#2577), with thanks to @georgevdd for the contribution!

[4.8.1] - 2020-05-28

Fixed

  • Fixed the accidental removal of some functions and submodules from plotly.colors and plotly.express.colors

[4.8.0] - 2020-05-26

Added

  • plotly now provides a Plotly Express-backed Pandas-compatible plotting backend, which can be activated via pandas.options.plotting.backend = "plotly". Note that it is not intended to implement every Pandas plotting function, nor is it intended to replicate the behaviour of every argument, although per the changes below, x and y should behave similarly. (#2336)
  • New datasets have been added to plotly.express.data: stocks, experiment, medals_wide and medals_long. (#2336)
  • plotly go.Figure and go.FigureWidget now have a _repr_html_ and a _repr_mimebundle_ method, which are standard hooks for integration in systems based on IPython. In particular, with _repr_html_ plotly figures can now be used within sphinx-gallery without any scraper. These additions should not change anything to the way plotly figures are displayed in notebook environments, since the _ipython_display_ method (already present in earlier versions) takes precedence over the new methods.

Updated

  • The behaviour of the x, y, orientation, histfunc, violinmode, boxmode and stripmode arguments for 2d-cartesian functions in Plotly Express (i.e. scatter, line, area, bar, histogram, violin, box, strip, funnel, density_heatmap and density_contour) has been refined (#2336):
    • if x or y is missing, it is inferred to be the index of data_frame if data_frame provided, otherwise a stable index of integers starting at 0. In the case of px.bar, if the provided value is not continuous, the missing value is treated as a column of 1s named "count", so as to behave more like px.histogram and to avoid sizing the resulting bars differently based on their position in the column. Previously, missing values defaulted to integers starting at 0 per trace which made it potentially inconsistent or misleading.
    • if x (y) is missing, orientation now defaults to v (h). Previously it always defaulted to v but this is not considered a breaking change, as the cases in which it now defaults to h caused unreadable output if set to v.
    • if both x and y are provided and one of them does not contain continuous values, orientation defaults to the value perpendicular to that axis. Previously it always defaulted to v but this is not considered a breaking change, as the cases in which it now defaults to h caused unreadable output if set to v.
    • if either x or y (but not both) may now be provided as a list of column references into data_frame or columns of data, in which case the imputed data frame will be treated as "wide" data and melt()ed internally before applying the usual mapping rules, with function-specific defaults.
    • if neither x nor y is provided but data_frame is, the data frame will be treated as "wide" with defaults depending on the value of orientation (and orientation has accordingly been added to scatter, line, density_heatmap, and density_contour for this purpose). Previously this would have resulted in an empty figure.
    • if both x and y are provided to histogram, and if x, y and z are provided to density_heatmap or density_contour, then histfunc now defaults to sum so as to avoid ignoring the provided data, and to cause histogram and bar to behave more similarly.
    • violinmode, boxmode and stripmode now default to overlay if x (y) in in v (h) orientation is also mapped to color, to avoid strange spacing issues with the previous default of group in all cases.
  • The Plotly Express arguments color_discrete_map, symbol_map and line_dash_map now accept the string "identity" which causes the corresponding input data to be used as-is rather than mapped into color_discrete_sequence, symbol_sequence or line_dash_sequence, respectively. (#2336)
  • Plotly Express now accepts px.Constant or px.Range objects in the place of column references so as to express constant or increasing integer values. (#2336)

[4.7.1] - 2020-05-08

Fixed

  • Fix AttributeError: module 'plotly.graph_objs' has no attribute 'FigureWidget' exception on from plotly.graph_objs import * when ipywidgets is not installed. Error also occurred when importing plotly.figure_factor. It is now possible to import plotly.graph_objs.FigureWidget when ipywidgets is not installed, and an informative ImportError exception will be raised in the FigureWidget constructor (#2443, #1111).
  • Fix TypeError: unhashable type: 'Template' during Figure construction when plotly.io.templates.default is set to a Template object rather than a string.

[4.7.0] - 2020-05-06

Updated

  • Updated Plotly.js to version 1.54.1. See the plotly.js CHANGELOG for more information. The main new feature of this version of Plotly.js is the possibility to draw layout shapes, using custom dragmodes and corresponding modebar buttons.
  • The sphinx-gallery scraper has been updated to work with different structures of galleries #2149

Added

  • 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.
  • 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. Thanks @zouhairm for this Pull Request!

Fixed

  • Plotly Express trendlines now handle missing data correctly #2357

Performance

This version includes several performance improvements (#2368, #2403).

  • 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.
  • Property validation is now disabled for select internal operations.
  • When used with Python 3.7 and above, plotly.py now takes advantage of PEP-562 to perform submodule imports lazily. This dramatically improves import times.

[4.6.0] - 2020-03-31

Updated

  • Updated Plotly.js to version 1.53.0. See the plotly.js CHANGELOG for more information on the numerous new features and bug fixes of this release. The main features of the Plotly.js release are
    • Introduce range breaks on date axes (for example, to remove week-ends) via layout.xaxis.rangebreaks
    • Introduce a new unified x (or y) hovermode (layout.hovermode="x unified"), in which the hover box shows the information for all traces at a given x (or y) position
    • Add node.customdata and link.customdata to sankey traces
      • Updated contributing notes for more explanations on how to contribute to plotly.py #2290. Please give feedback on these notes!
      • Updated documentation examples #2325, and to show how to color links in Sankey diagrams #2291.
      • Special thanks to @SylwiaOliwia2 and @dangercrow for improving our documentation!

Added

  • px.imshow now accepts xarray inputs, with metadata being used for axis labels, hover and colorbar #2166

Fixed

  • Fixed handling of opacity in px.pie, px.funnel_area, px.density_mapbox, px.funnel #2317, with thanks to @tvaucher for the contribution!

[4.5.4] - 2020-03-11

Updated

Fixed

  • Jupyterlab extension now compatible with both Jupyterlab 1.2 and 2.0 #2261 with thanks to @consideRatio for the contribution!
  • Fixed a bug when using boolean values for the color argument of px functions #2127
  • Corrected import bug which was occurring with old versions of ipywidgets #2265
  • Fixed python 3.8 syntax warning #2262, with thanks to @sgn for the contribution!

[4.5.3] - 2020-03-05

Updated

  • Removed development dependency on nose testing framework #2217

Fixed

  • JupyterLab extension now compatible with JupyterLab 2.0 #2245 with thanks to @consideRatio for the contribution!

[4.5.2] - 2020-02-24

Fixed

  • Fix build errors in JupyterLab extension by pinning version of @types/plotly.js #2223

[4.5.1] - 2020-02-19

Updated

  • Updated Plotly.js to version 1.52.2. See the plotly.js CHANGELOG for more information on bug fixes.

Fixed

  • update_annotations, update_shapes and update_layout_images now no longer require the patch argument, as per the docstring #2167
  • px.defaults no longer accepts arbitrary keys #2168
  • better error message when pandas is not installed #2125
  • support columns of numerical type in path argument of px.sunburst/px.treemap and add values of color column in hoverlabel for px.sunburst/px.treemap #2133

[4.5.0] - 2020-01-22

Updated

  • Updated Plotly.js to version 1.52.1. See the plotly.js CHANGELOG for more information on numerous new attribute and bug fixes.
  • Plotly Express uses the new legend.title attribute and so now has shorter trace names #2051
  • The heuristic used by px.parallel_categories to determine which columns of the data frame to draw has been changed and made more configurable with the dimensions_max_cardinality argument #2102
  • The simple_white colorbar styling has been streamlined #2110
  • The jupyterlab-plotly and plotlywidget JupyterLab extensions should now share code when installed together, resulting in smaller JupyterLab vendor bundle sizes #2103

Fixed

  • Plotly Express category_orders are now respected independent of the contents of the data set #2084
  • go.Scattergl symbols now accept numeric specification #1928
  • px.scatter trendline coefficients are now more readable #1984
  • Built-in cyclical color scales now all have identical start and end points #2016

Added

  • px.sunburst and px.treemap now accept a path argument for passing columns of a rectangular dataframe to build the charts #2006
  • px.choropleth now accepts a user-supplied geojson attribute #2057
  • px.choropleth and px.choropleth_mapbox now accept featureidkey to specify the GeoJSON field to use to match locations #2057
  • px.choropleth and px.choropleth_mapbox now accept discrete color #2057
  • px.bar_polar now accepts continuous color #2017
  • New layout.uniformtext attribute allows for automatic standardization of font sizes across bar-like and hierarchical traces. See the plotly.js CHANGELOG for more information

[4.4.1] - 2019-12-10

Fixed

  • Fixed improper JSON encoding exception when the pillow module not installed #1993

[4.4.0] - 2019-12-10

Updated

  • Updated Plotly.js to version 1.51.2. See the plotly.js CHANGELOG for more information
  • The tutorials of the plotly.py documentation are now in the main plotly.py Github repository. Contributions in order to improve or extend the documentation are very welcome!
  • plotly.express generated plots no longer have a default height of 600 pixels, instead they inherit the default height of regular figures #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.

Fixed

  • Fixed a plotly.express input bug when using data frame indices#1934
  • Fixed how to display facet labels with plotly express #1966
  • Fixed a bug to use correctly the zmin/zmax parameter in px.imshow for single-channel images #1981
  • Clipped docstring width for better display in Jupyterlab #1939. Thank you @joelostblom!
  • Fixed a bug in the case of external orca server #1915 thank you @dev-dsp!

Added

  • Extended the plotly.express functional API with 7 new functions: px.pie, px.sunburst, px.treemap, px.funnel, and px.funnel_area (#1909) px.density_mapbox and px.choropleth_mapbox #1937.
  • plotly.express mapbox functions in plotly.express have new arguments center and mapbox_style #1937.
  • plotly.express polar plots (scatter_polar, line_polar, bar_polar) now have a range_theta keyword argument for representing only an angular section #1969.
  • All continuous colorscales now accept a _r suffix that reverses their direction #1933
  • Docstrings of plotly.py are now doctested #1921.
  • Reversing a predefined colorscale by appending _r to its name #1933

[4.3.0] - 2019-11-11

Updated

  • Updated Plotly.js to version 1.51.1. See the plotly.js CHANGELOG for more information
  • Improved propagation of empty templates (#1892)
  • Update the add_annotations/add_shapes/add_images methods to no longer default to adding objects in paper coordinates. This allows plotly.js to determine the default reference frame based on context (#1888)
  • Use the default template's background color for displaying color swatches (#1872). Special thanks to @joelostblom for this contribution!
  • Improved docstrings (#1835, #1837)

Added

  • Added image trace type (plotly.js#4289, plotly.js#4307, plotly.js#4313, plotly.js#4319)
  • Added matplotlib-style plotly.express.imshow convenience function to display images and heatmaps (#1855, #1885)
  • Added matplotlib-style simple_white template (#1864). Special thanks to @joelostblom for this contribution.
  • Added support for using an externally managed orca server for image export features (#1850). Special thanks to @miriad for this contribution.
  • Added facet wrapping support to plotly express functions using the new facet_col_wrap argument (#1838)

[4.2.1] - 2019-10-18

Fixed

  • Fixed regression in 4.2.0 that caused all figure factories to require that scikit-image be installed (#1832)

[4.2.0] - 2019-10-16

Updated

Added

Fixed

  • Fixed iframe renderer on Python 2 (#1822)
  • Fixed use of merged templates in plotly.express (#1819)

[4.1.1] - 2019-09-02

Updated

  • Updated Plotly.js to version 1.49.4. See the plotly.js CHANGELOG for more information
  • The width of a figure produced by the create_gantt figure factory now resizes responsively (#1724)

Fixed

  • The name of the steps property of graph_objects.indicator.Gauge has been renamed from stepss to steps
  • Avoid crash in iframe renderers when running outside iPython (#1723)

[4.1.0] - 2019-08-06

Updated

  • Updated Plotly.js to version 1.49.1. See the plotly.js CHANGELOG for more information.
  • Bars in the figures produced by the create_gantt figure factory may now be hidden by clicking on the legend (#1665). Special thanks to @csabaszan for this contribution!
  • Improved performance when serializing figures containing large numpy arrays (#1690). Special thanks to @miriad for this contribution!

Added

Fixed

  • Fixed incorrect facet row ordering in figures generated by plotly.express functions (plotly/plotly_express#129)
  • Fixed "The truth value of an array with more than one element is ambiguous" error when specifying subplot titles as numpy array of strings (#1685). Special thanks to @MrQubo for this contribution!
  • The line_3d plotly express function was not visible by default when importing * from plotly.express (#1667)

[4.0.0] - 2019-07-16

This is a major release that includes many new features, and a few breaking changes. See the version 4 announcement for a summary of the important changes.

Updated

Added

  • The Plotly Express tech preview (https://medium.com/@plotlygraphs/introducing-plotly-express-808df010143d) has been integrated as the plotly.express module (#1613)
  • Added a new renderers framework the supports rendering figure in a wide variety of contexts (#1474). See the new Displaying Plotly Figures documentation page for more information.
  • Added plotly.io.write_html and plotly.io.to_html functions for exporting figures to HTML (1474). Also available as .write_html and .to_html figure methods.
  • Added new figure methods for batch updating figure properties (update_layout, update_traces, update_xaxes, etc.) (#1624). See the new Creating and Updating Figures documentation page for more details.
  • Added support for all trace types in make_subplots (#1528)
  • Added support for secondary y-axes in make_subplots (#1564)
  • Support passing a scalar trace object (rather than a list or tuple of trace objects) as the data property to the Figure constructor (#1614)
  • Added dictionary-style .pop method to graph object classes (#1614)
  • New jupyterlab-plotly JupyterLab extension for rendering figures in JupyterLab. Replaces the @jupyterlab/plotly-extension extension, and includes JupyterLab 1.0 support.
  • 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).
  • Added sphinx-gallery renderer for embedding plotly figures in Sphinx-Gallery (#1577, plotly/plotly-sphinx-gallery).

Removed

  • The follow modules for interfacing with the Chart Studio cloud service have been removed from plotly.py and moved to the new chart-studio distribution package. The following modules have been moved to a new top-level chart_studio module:
    • plotly.plotly -> chart_studio.plotly
    • plotly.api -> chart_studio.api
    • plotly.dashboard_objs -> chart_studio.dashboard_objs
    • plotly.grid_objs -> chart_studio.grid_objs
    • plotly.presentation_objs -> chart_studio.presentation_objs
  • The legacy plotly.widgets.GraphWidget class for displaying online figures hosted by Chart Studio as ipywidgets has been removed. Please use the offline, and much more capable, plotly.graph_objects.FigureWidget class instead.
  • The fileopt argument to chart_studio.plotly.plot has been removed, so in-place modifications to previously published figures are no longer supported, and a figure will always overwrite a figure with the same name.

Changed

  • The 'plotly' template is used as the default theme across all figures.
  • In order to reduce the size of the core plotly distribution package, the bundled geographic shape files used by the create_choropleth figure factory have been moved to a new optional plotly-geo distribution package (1604)
  • For consistency with other figure factories, the create_choropleth and create_gantt figure factories now always returns Figure objects, rather than dictionaries (#1600, #1607).
  • Figure add trace methods (.add_trace, .add_traces, .add_scatter, etc.) now return a reference to the calling figure, rather than the newly created trace (#1624)
  • plotly.tools.make_subplots has been moved to plotly.subplots.make_subplots, though it is still available at the previous location for backward compatibility
  • The plotly.graph_objs module has been moved to plotly.graph_objects, though it is still available at the previous location for backward compatibility (#1614)
  • Trace uid properties are only generated automatically when a trace is added to a FigureWidget. When a trace is added to a standard Figure graph object the input uid, if provided, is accepted as is (#1580).
  • datetime objects that include timezones are not longer converted to UTC (#1581)
  • When a tuple property (e.g. layout.annotations) is updated with a list/tuple that is longer than the current value, the extra elements are appended to the end of the tuple.

Fixed

  • Fixed visibility of bar trace error bars in built-in templates (1656)

[3.10.0] - 2019-05-31

Updated

Added

  • Added funnel trace (plotly/plotly.js#3817, plotly/plotly.js#3911)
  • Added funnelarea traces (#3876, #3912)
  • Added support for shared color axes via coloraxis attributes in the layout (#3803, #3786, #3901, #3916)
  • Added support for sorting categorical cartesian axes by value (#3864)
  • Added bingroup to histogram, histogram2d and histogram2dcontour to group traces to have compatible auto-bin values (#3845)
  • Add legend itemclick and itemdoubleclick attributes to set or disable the legend item click and double-click behavior (#3862)
  • Added support for calling orca through Xvfb to support static image export on Linux when X11 is not available (#1523).

Fixed

  • Fixed PlotlyJSONEncoder encoding error when simplejson is installed (#1556, #1561)
  • HTML export now honors the figure height specified in the figure template (#1560)
  • Fixed display height of figure displayed in JupyterLab (#1572, #1571)
  • Fixed honouring of the validate=False option for all renderer types (#1576)

[3.9.0] - 2019-04-19

Updated

Added

  • Added "magic underscore" support for specifying nested figure properties (#1534)
  • Added select_traces, for_each_trace, and update_traces figure methods for accessing and updating traces by subplot location and trace properties (#1534)
  • Added select_*, for_each_*, and update_* figure methods for accessing and updating subplot objects (xaxis, scene, polar, etc) (#1548)
  • Added support for Dash Design Kit style color specifications (#1541). Thanks to @wbrgss for this contribution!
  • Added support for the plotly_unselect plotly.js event in a new on_unselect trace method (#1542). Thanks to @denphi for this contribution!

Changed

  • Changed the default colorscale to be plasma for the plotly, plotly_white, and plotly_dark templates for plotly.py version 4 (#1274, #1549)
  • Reordered the default colorway for the plotly, plotly_white, and plotly_dark templates for plotly.py version 4 (#1549)

Fixed

  • Fixed package listing in setup.py (#1543). Thanks to @jakevdp for this contribution!
  • Fixed built-in templates so that heatmap colorscales can be overridden without specifying autocolorscale=False (#1454, #1549)
  • Fix UnboundLocalError error in the presence of a missing or corrupt ~/.plotly/.config file (#1551)
  • Fixed error when combining sankey traces with cartesian subplots (#1527, plotly/plotly.js#3802)

[3.8.1] - 2019-04-19

Updated

Fixed

Changed

  • Reverted change to layout.legend.itemsizing = 'constant' in built-in templates that was made in 3.8.0. This resulted in unexpectedly large legend entries in some common cases (#1526)

[3.8.0] - 2019-04-15

Updated

Added

Fixed

  • Fix race condition when checking the permissions of the .plotly settings directory (#1498). Special thanks to @pb-cdunn for this contribution!
  • Fix OSError when processing time series data using Python 3.7+ (#1402, #1501)

Updated

  • Align hoverlabels left and set legend items to constant-size in builtin themes (#1520)

[3.7.1] - 2019-03-19

Fixed

  • Fixed .update on numbered axis objects for Python < 3.6 (#1462, #1464)

[3.7.0] - 2019-03-08

Updated

Added

  • Added new auto_play argument to offline plot and iplot to control whether figures with frames are automatically animated when the figure is loaded (#1447)
  • Added support for uploading "offline" animations (those with inline data arrays rather than grid references) to Chart Studio using plotly.plotly.create_animations (#1432)

Updated

  • Updated implementation of the ternary_contour figure factory that was added in 3.6.0. The new implementation uses the native plotly.js ternary axes and provides ILR transform support. (#1418)

Fixed

  • Make sure the trace selectedpoints property of FigureWidget traces is updated on the Python side in response to plotly.js selection events (#1433)
  • Fix validation for 0-dimensional numpy arrays (#1444). Special thanks to @ankokumoyashi for this contribution!

[3.6.1] - 2019-02-08

Updated

Fixed

  • Crash on import when ipywidgets < 7 installed (#1425)
  • Made scipy an optional import for the ternary contour figure factory (#1423)
  • Eliminated use of deprecated numpy.asscalar function (#1428)

Updated

  • Updated Plotly.js to version 1.44.1. Select highlights included below. See the plotly.js CHANGELOG for more information.

[3.6.0] - 2019-02-01

Updated

  • Updated Plotly.js to version 1.44.1. Select highlights included below. See the plotly.js CHANGELOG for more information.

Added

  • Add isosurface gl3d trace type (plotly/plotly.js#3438)
  • Preview of ternary contour figure factory (#1413). Special thanks to @emmanuelle for this contribution!
  • Add support for line.color colorbars for scatter3d traces (#1085, plotly/plotly.js#3384)
  • Add support for hovertemplate on scatterpolar, scatterpolargl, scatterternary, barpolar, choropleth, scattergeo, and scattermapbox trace (plotly/plotly.js#3398, plotly/plotly.js#3436)
  • Add width attribute to box and violin traces (plotly/plotly.js#3234)
  • Add support for <sup>, <sup>, <b>, <i> and <em> pseudo-html tags in extra (aka trace "name") hover labels (plotly/plotly.js#3443)
  • Add 4 additional colors to the colorway cycle of the plotly themes (#1408)
  • Automatically coerce array-like objects (e.g. xarray DataArrays) to numpy arrays (#1393). Special thanks to @malmaud for this contribution!

Fixed

  • Fix annotated heatmap text color when values are specified as a nested list (#1300)
  • Fix update method with legacy title* properties (#1403)
  • Fix deprecation warnings on Python 3.7 and ipywidgets > 7.0 (#1417). Special thanks to @Juanlu001 for this contribution!

[3.5.0] - 2019-01-04

Updated

Changed

  • Plotly.js 1.43 converted title properties (e.g. layout.title) from strings into compound objects that contain the text as the text property along with new title placement attributes x, y, xref, yref, xanchor, yanchor and pad. Plotly.py 3.5.0 follows the new schema, but still supports specifying title as a string, in which case the string is assigned to the title.text property (#1302)
  • Plotly.js 1.43 also moved existing title* properties (e.g. layout.titlefont) under the title object (e.g. layout.title.font). Plotly.py 3.5.0 follows the new schema, but still supports the legacy title* properties by mapping them to the corresponding title.* property (#1302)
  • The update method on graph_objs now returns the updated object in order to support chaining multiple update operations together (#1379)
  • The show_link option has been set to False by default in the offline plot and iplot functions. Now that the "send data to cloud" button has been disabled by default in plotly.js 1.43.0, no buttons/links will be displayed by default that result in data being sent off of the local machine (#1304)
  • config options that are not known by plotly.py result in a warning but are still passed along to plotly.js. Prior to this change these unknown options were dropped silently (#1290)
  • Built-in themes now specify colorscales using the new global layout.colorscale properties. Previously the colorscales were defined for each trace type individually. This reduces the size of the resulting theme files (#1303)
  • Increased the maximum retry time of the orca integration from 8s to 30s (#1297)

Fixed

  • Fixed FigureWidget performance regression that, when working with large datasets, resulted in a slight freeze of the widget after user interactions (pan, zoom, etc) (1305)
  • Fix orca error when the ELECTRON_RUN_AS_NODE environment variable is set (#1293)
  • The 'responsive' config key was being silently blocked (#1290)
  • Fixed error when using unicode characters in string properties on Python 2 (#1289)
  • Removed invalid calls to non-existent validate and strip_style Figure methods in matplotlylib conversion logic (#1128)

[3.4.2] - 2018-11-23

Fixed

  • config options are now supported when using plotly.offline.iplot to display a figure in JupyterLab. Requires version 0.18.1 of the @jupyterlab/plotly-extension extension. (#1281, jupyterlab/jupyter-renderers#168)
  • Custom plotly_domain values are now supported in FigureWidget in both the classic notebook and JupyterLab (#1284)

[3.4.1] - 2018-11-09

Updated

Fixed

  • Fixed histogram binning with pandas Series or numpy array (regression introduced in 3.4.0) (#1257, plotly/plotly.js#3211)
  • Fixed incorrect validation error on the args property of layout.updatemenu.Button() when value is a list that starts with a list (#1265)
  • Fixed deadlock causing plotly.io.write_image to hang on Windows after exporting more than ~25 images (#1255)
  • Fixed plot display error for scattergl trace with mode='lines' and more than 100k points (#1271)
  • Fixed responsive resizing error with iplot in the classic notebook (#1263)

[3.4.0] - 2018-11-02

Updated

  • Updated Plotly.js to version 1.42.2. Select highlights included below, see the plotly.js CHANGELOG for more information.

Added

  • Default figure properties may now be customized using figure templates (themes) and 7 new predefined templates are bundled with plotly.py (#1224)
  • Added Parallel Categories (parcats) trace type for the visualization of multi-dimensional categorical datasets (plotly/plotly.js#2963)
  • Added LaTeX typesetting support for figures displayed in the Jupyter Notebook using plotly.offline.iplot and plotly.graph_objs.FigureWidget. Note: There are still outstanding issues with MathJax rendering in FireFox, but it is now working well in Chrome. (#1243)
  • Added include_mathjax argument to plotly.offline.plot to support the creation of HTML files with LaTeX typesetting (#1243)
  • Added new plotly.offline.get_plotlyjs function that returns the contents of the bundled plotly.js library as a string (#637, #1246)
  • Added new plotly.offline.get_plotlyjs_version function that returns the version of the bundled plotly.js library (#1246)
  • HTML div strings returned by plotly.offline.plot now contain logic to automatically resize the figure responsively. This logic was previously only added for html files. (#1043, #1234)
  • Figures displayed using plotly.offline.iplot in the classic Jupyter Notebook will now resize responsively (#1234)
  • Added 'cdn', 'directory', and path string include_plotlyjs options in plotly.offline.plot (#1234)
    • When 'cdn', the resulting html file/div includes a script tag reference to the plotlyjs cdn.
    • When 'directory', the resulting html file/div includes a script tag reference to a plotly.min.js bundle in the same directory as the html file. If output_type is 'file' then this plotly.min.js bundle is created in the output directory if it doesn't already exist.
    • When a string ending with '.js', the resulting html file/div includes a script tag that references this exact path. This can be used to point to a plotly.js bundle from an alternative CDN.
  • Added a new color_threshold argument to the create_dendrogram figure factory to control the dendrogram clustering cutoff (#995, #1075, #1214)
  • Added support for autorange='reversed' in 3D axes (#803, plotly/plotly.js#3141)
  • Added new gl3d tick and title auto-rotation algorithm that limits text overlaps (plotly/plotly.js#3084, plotly/plotly.js#3131)
  • Added modebar layout style attributes: orientation, bgcolor, color and activecolor (plotly/plotly.js#3068, plotly/plotly.js#3091)
  • Added title, titleposition and titlefont attributes to pie traces (plotly/plotly.js#2987)
  • Added hoverlabel.split attribute to ohlc and candlestick traces to split hover labels into multiple pieces (plotly/plotly.js#2959)
  • Added support for line.shape values 'hv', 'vh', 'hvh' and 'vhv' in scattergl traces (plotly/plotly.js#3087)
  • Added trace, node and link hoverinfo for sankey traces (#3096, #3150)
  • Added per-sector textfont settings in pie traces (#3130)

Changed

Fixed

  • Plotly's use of MathJax for LaTeX typesetting no longer interferes with the Jupyter Notebook's use of MathJax (#445, #360)
  • Fixed several issues with the use of reversescale=True in the create_annotated_heatmap figure factory (#1251)
  • Fixed case where plotly.offline.iplot would fail to render in the classic Jupyter Notebook if the notebook contained a Markdown headline with the text "Plotly" (#816)
  • None values in a scatter.hovertext list are now omitted from the hover label rather than being displayed as the string "None" (#1244)
  • Subplot titles created by plotly.tools.make_subplots are now positioned properly when custom row_width/column_width arguments are specified (#1229)
  • The bar.width property may now be specified as a numpy array or a pandas series (#1231, plotly/plotly.js#3169)
  • Error bars are now scaled correctly for logarithmic scatter3d traces (#1139)
  • Use uuid.uuid4 rather than uuid.uuid1 to work around an upstream Python bug (#1235, #1236)
  • The layout.grid.subplots property may now be specified as a 2D list of subplot identifiers (#1220, #1240)
  • Fixed scatter3d text alignment (#1055, plotly/plotly.js#3180)

JupyterLab Versions

For use with JupyterLab, the following versions of the following packages must be installed:

[3.3.0] - 2018-09-28

Updated

  • Updated Plotly.js to version 1.41.3. Select highlights included below, see the plotly.js CHANGELOG for more information.
  • Do not create or check permissions on the ~/.plotly configuration directory until a configuration write operation is performed (#1195). This change avoids some concurrency problems associated with running many instances of plotly.py simultaneously (#1068).

Added

  • Enable selection by clicking on points via new layout attribute clickmode and flag 'select' (#2944)
  • Added stacked area charts via new attributes stackgroup and stackgaps in scatter traces (#2960)
  • Added barpolar trace type - which replace and augment area traces (#2954)
  • Added polar.hole layout parameter to punch hole at the middle of polar subplot offsetting the start of the radial range (#2977, #2996)
  • Figures may now be easily converted to and from JSON using the new to_json, from_json, read_json, and write_json functions in the plotly.io package (#1188)
  • Figures and graph objects now support deepcopy and pickle operations (#1191)
  • The location of the "~/.plotly" settings directory may now be customized using the PLOTLY_DIR environment variable (#1195)
  • Added optional scaleratio argument to the create_quiver figure factory. When specified, the axes are restricted to this ratio and the quiver arrows are computed to have consistent lengths across angles. (#1197)

Fixed

  • Replace use of pkg_resources.resource_string with pkgutil.get_data to improve compatibility with cx_Freeze (#1201)
  • An exception is no longer raised when an optional dependency raises an exception on import. The exception is logged and plotly.py continues as if the dependency were not installed (#1192)
  • Fixed invalid dendrogram axis labels when the points being clustered contain duplicate values (#1186)
  • Added missing LICENSE.txt file to PyPI source distribution (#765)

JupyterLab Versions

For use with JupyterLab, the following versions of the following packages must be installed:

[3.2.1] - 2018-09-14

This is a patch release that fixes a few bugs and reintroduces a few version 2 features that were not supported in version 3.

The bundled version of plotly.js remains at 1.40.1

JupyterLab Versions

For use with JupyterLab, the following versions of the following packages must be installed:

Added

  • An optional skip_invalid argument has been added to the Figure and FigureWidget constructors. By default, skip_invalid is False and invalid figure properties will result in an exception (this is identical to the previous behavior). When skip_invalid is set to True, invalid properties will instead be silently ignored. This argument replaces the _raise argument that was available in version 2, and makes it possible to import figure definitions from different plotly versions, where incompatible properties are ignored rather than causing an exception.
  • A to_ordered_dict method has been added to the Figure and FigureWidget classes. This method returns a representation of the figure as a nested structure of OrderedDict and list instances where the keys in each OrderedDict are sorted alphabetically. This method replaces the get_ordered method that was available in version 2, and makes it possible to traverse the nested structure of a figure in a deterministic order.

Fixed

[3.2.0] - 2018-09-05

This release introduces the long-anticipated ability to programmatically export figures as high quality static images in both raster and vector formats.

JupyterLab Versions (Python 3.5+)

For use with JupyterLab, the following versions of the following packages must be installed:

Added

  • plotly.js version 1.40.1, which introduces the following features:
  • Support for offline static image export with the to_image and write_image functions in the new plotly.io package (#1120).
    • Note: Image export requires the plotly orca command line utility and the psutil Python package.
  • New documentation sections covering Static Image Export and Orca Management
  • Support for displaying FigureWidget instances in static contexts (e.g. nbviewer) just like the built-in ipywidgets (#1117)
  • Full integration of the Cividis colorscale (#883)
  • conda packaging
    • From here forward, new versions of plotly.py will be published to the plotly anaconda channel on the same day they are published to PyPI. (72ad0e4)
    • The README now includes conda installation instructions alongside the pip instructions.
    • In addition to the existing installation approaches, orca is now also available as a conda package from the plotly anaconda channel.

Updated

  • Show traces at the top of the Gantt chart's colorbar (#1110)
  • Significantly improved validation performance for numeric pandas Series objects (#1149)
  • Specialize auto-generated docstrings for Python syntax
  • More robust and specific logic for retrying requests to the plot.ly cloud service (#1146)
  • Support basic authentication when using the streaming API behind a proxy server (#1133)

Fixed

  • Validators for dash properties (e.g. scatter.line.dash) incorrectly rejected dash length lists (#1136)
  • Annotated heatmap error when custom colorscale was specified (#1151)
  • Incorrect deprecation warning for deprecated plotly.graph_objs.Annotations class (#1138)
  • Harmless JavaScript console error when opening an html file produced by plotly.offline.plot (#1152)
  • Incorrect validation errors when writing data to the streaming API (#1145)

[3.1.1] - 2018-08-10

This release is a minor bug-fix update to version 3.1.0

JupyterLab Versions

For use with JupyterLab, the following versions of the following packages must be installed:

Updated

  • Updated plotly.js to version 1.39.4.

Fixed

[3.1.0] - 2018-07-20

JupyterLab Versions

For use with JupyterLab, the following versions of the following packages must be installed. See README.md for instructions.

Updated

Added

  • Added 3D streamtube traces plotly/plotly.js#2658
  • Added support for on-graph text in scattergl traces
  • Added gridshape attribute to polar subplots with values 'circular' (the default) and 'linear' (to draw polygon grids) plotly/plotly.js#2739

[3.0.2] - 2018-07-17

This is a minor bug-fix release to 3.0.0

JupyterLab plotlywidget version: 0.1.1

Plotly.js version: 1.38.3

Fixed

  • Several errors related to numbered subplot labels (e.g. xaxis2, polar3, etc.) GH1057
  • Error where the v property was ignored in cone traces GH1060
  • Assorted performance improvements when constructing graph objects GH1061

[3.0.1] - 2018-07-17 [YANKED]

Note: This release's installation was broken. It has been removed from PyPI

[3.0.0] - 2018-07-05

This is a major version with many exciting updates. See the Introducing plotly.py 3.0.0 post for more information.

JupyterLab plotlywidget version: 0.1.1

Plotly.js version: 1.38.3

Added

  • Full Jupyter ipywidgets integration with the new graph_objs.FigureWidget class
  • FigureWidget figures can be updated interactively using property assignment syntax
  • The full trace and layout API is generated from the plotly schema to provide a great experience for interactive use in the notebook
  • Support for setting array properties as numpy arrays. When numpy arrays are used, ipywidgets binary serialization protocol is used to avoid converting these to JSON strings.
  • Context manager API for animation. Run help(go.Figure().batch_animate) for the full doc string.
  • Perform automatic retries when communicating with plot.ly services. This introduces a new required dependency on the retrying library.
  • Improved data validation covering the full API with clear, informative error messages. This means that incorrect properties and/or values now always raise a ValueError with a description of the error, the invalid property, and the available properties on the level that it was placed in the graph object. Eg. go.Scatter(foo=123) raises a validation error. See https://plot.ly/python/reference/ for a reference to all valid properties and values in the Python API.
  • Error message for plotly.figure_factory.create_choropleth is now helpful to Anaconda users who do not have the correct modules installed for the County Choropleth figure factory.

Changed / Deprecated

Please see the migration guide for a full list of the changes and deprecations in version 3.0.0

[2.7.0] - 2018-05-23

Updated

  • Updated plotly.min.js to version 1.38.0.
    • New features include a 3D cone trace to visualize vector fields.
    • See the plotly.js CHANGELOG for additional information regarding the updates.

[2.6.0] - 2018-05-09

Updated

  • Updated plotly.min.js to version 1.37.1.
    • New features include a splom (scatter plot matrix) trace type.
    • See the plotly.js CHANGELOG for additional information regarding the updates.
  • Error message for plotly.figure_factory.create_choropleth is more helpful for Windows users on installing geopandas and dependencies including shapely.

[2.5.1] - 2018-03-26

Fixed

  • plotly.figure_factory.create_choropleth now works in Windows without raising an OSError. The module now uses cross-platform path tools from os to manipulate and manage the shapefiles contained in this package.

[2.5.0] - 2018-03-12

Fixed

  • import plotly.figure_factory does not fail if pandas is not installed. See https://github.com/plotly/plotly.py/pull/958

    Added

  • New parameter fill_percent to the .insert method for the dashboards API. You can now insert a box into the dashboard layout and specify what proportion of the original container box it will occupy. Run help(plotly.dashboard_objs.Dashboard.insert) for more information on fill_percent.

    Updated

  • Updated plotly.min.js to version 1.35.2.
    • New features include adding an automargin attribute to cartesian axes and a layout grids attribute for easy subplot generation.
    • See the plotly.js CHANGELOG for additional information regarding the updates.
  • plotly.figure_factory.create_choropleth has changed some of the default plotting options:

[2.4.1] - 2018-02-21

Fixed

  • The required shapefiles to generate the choropleths via plotly.figure_factory.create_choropleth are now shipped in the package data.

[2.4.0] - 2018-02-16

Added

  • County Choropleth figure factory. Call help(plotly.figure_factory.create_choropleth) for examples and how to get started making choropleths of US counties with the Python API.

Note: Calling plotly.figure_factory.create_choropleth will fail with an IOError due to missing shapefiles see: https://github.com/plotly/plotly.py/blob/master/CHANGELOG.md#241---2018-02-21

[2.3.0] - 2018-01-25

Fixed

  • Merged pull request that fixes GraphWidget for IPython > v6

    Updated

  • Updated plotly.min.js to version 1.33.1.
    • New plot types include a violin trace type.
    • New features include completely rewritten scattergl using regl and a completely rewritten polar chart renderer.
    • See the plotly.js CHANGELOG for additional information regarding the updates.

[2.2.3] - 2017-12-04

Added

-column_width and row_width parameters for plotly.tools.make_subplots. Call help(plotly.tools.make_subplots) for documentation.

Updated

  • Updated plotly.min.js to version 1.31.2.
    • Fixes include adjustments to table trace for offline plotting.
    • See the plotly.js CHANGELOG for additional information regarding the updates.

[2.2.2] - 2017-11-23

Added

  • Bullet chart figure factory. Call help(plotly.figure_factory.create_bullet) for examples and how to get started making bullet charts with the API.

[2.2.1] - 2017-10-26

Fixed

  • Presentation objects now added to setup.py

[2.2.0] - 2017-10-26

Added

  • NEW Presentations API for Python! Run help(plotly.presentation_objs.Presentations) for help or check out the new documentation

[2.1.0] - 2017-10-10

Updated

  • Updated plotly.min.js to version 1.31.0.
    • New features include a table trace type.
    • See the plotly.js CHANGELOG for additional information regarding the updates.

[2.0.16] - 2017-10-06

Updated

  • Updated plotly.min.js to version 1.31.0 for plotly.offline.

[2.0.15] - 2017-08-22

Updated

  • Updated plotly.min.js to version 1.30.0 for plotly.offline.

[2.0.14] - 2017-08-09

Fixed

  • Sharekey enabling issue where plots were made private instead of secret.
  • Issue removing rug plots from violin plots with multiple traces.

[2.0.13] - 2017-08-04

Updated

  • Updated plotly.min.js to version 1.29.1 for plotly.offline.
  • figure_factory.create_gantt and figure_factory.create_dendrogram now return a Plotly figure (consistent with other figure factory chart types).
  • offline.init_notebook_mode() is now optional when using offline.iplot().

[2.0.12] - 2017-06-30

Updated

  • Updated plotly.min.js to version 1.28.3 for plotly.offline.
  • figure_factory.create_facet_grid now supports histogram, bar, and box traces.

[2.0.11] - 2017-06-20

Updated

  • Updated plotly.min.js to version 1.28.1 for plotly.offline.

[2.0.10] - 2017-06-12

Added

  • The figure_factory can now create facet grids with .create_facet_grid. Check it out with:
    import plotly.figure_factory as ff
help(ff.create_facet_grid)

[2.0.9] - 2017-05-30

Fixed

Added

  • 'sort' parameter to FF.create_violin to control whether violin plots are sorted alphabetically.

[2.0.8] - 2017-04-21

Added

  • Beta: Added API methods that wrap the API endpoint for managing Dash objects on plot.ly. The API interface is under plotly.api.v2.dash_apps
  • offline embedded plots are now responsive to window resizing when output_type == "div" is set in plotly.offline.iplot().
  • Offline embedded plots are now responsive to window resizing when output_type == "div" is set in plotly.offline.iplot().
  • Offline animations are now supported on Plotly Cloud.

Updated

  • Updated plotly.min.js to version 1.26.0 for plotly.offline.

Updated

  • plotly.offline.plot and plotly.offline.iplot now accept various configuration options for their arguments.

[2.0.7] - 2017-04-07

Updated

  • Updated plotly.min.js to version 1.25.0 for plotly.offline.

Added

  • Added check to verify the share key is enabled when secret charts are created.

[2.0.6] - 2017-03-20

Added

  • Added a new mimetype 'text/vnd.plotly.v1+html' for iplot outputs.

[2.0.5] - 2017-03-07

Fixed

  • import plotly was broken in 2.0.3 and 2.0.2 because the new dashboard_objs wasn't included in our setup.py's "packages". Now it is and import plotly and the other features introduced in 2.0.3 and 2.0.2 should work.

[2.0.4] - 2017-03-07 [YANKED]

Note: This release's installation was broken. It has been removed from PyPI

Added

  • Added dashboard_objs to top level import.

[2.0.3] - 2017-03-06 [YANKED]

Note: This release's installation was broken. It has been removed from PyPI

Added

  • Dashboards can now be created using the API and uploaded to Plotly. Use import plotly.dashboard_objs to create a Dashboard object. You can learn more about Dashboard objects by running help(plotly.dashboard_objs) and help(plotly.plotly.plotly.dashboard_ops) for uploading and retrieving dashboards from the cloud.

[2.0.2] - 2017-02-20

Fixed

  • Offline plots created with plotly.offline.plot now resize as expected when the window is resized.
  • plotly.figure_factory.create_distplot now can support more than 10 traces without raising an error. Updated so that if the list of colors (default colors too) is less than your number of traces, the color for your traces will loop around to start when it hits the end.

[2.0.1] - 2017-02-07

Added

Changed

  • a Grid from plotly.grid_objs now accepts a pandas.Dataframe as its argument.
  • computationally-intensive graph_reference functions are memoized.

[2.0.0] - 2017-01-25

Changed

  • plotly.exceptions.PlotlyRequestException is always raised for network failures. Previously either a PlotlyError, PlotlyRequestException, or a requests.exceptions.ReqestException could be raised. In particular, scripts which depend on try-except blocks containing network requests should be revisited.
  • plotly.py:sign_in now validates to the plotly server specified in your config. If it cannot make a successful request, it raises a PlotlyError.
  • plotly.figure_factory will raise an ImportError if numpy is not installed.
  • plotly.figure_factory.create_violin() now has a rugplot parameter which determines whether or not a rugplot is draw beside each violin plot.

Deprecated

  • plotly.tools.FigureFactory. Use plotly.figure_factory.*.
  • (optional imports) plotly.tools._*_imported It was private anyhow, but now it's gone. (e.g., _numpy_imported)
  • (plotly v2 helper) plotly.py._api_v2 It was private anyhow, but now it's gone.

[1.13.0] - 2016-12-17

Added

  • Python 3.5 has been added as a tested environment for this package.

Updated

  • plotly.plotly.create_animations and plotly.plotly.icreate_animations now return appropriate error messages if the response is not successful.
  • frames are now integrated into GRAPH_REFERENCE and figure validation.

Changed

  • The plot-schema from https://api.plot.ly/plot-schema is no longer updated on import.

[1.12.12] - 2016-12-06

Updated

  • Updated plotly.min.js to version 1.20.5 for plotly.offline.
  • FF.create_scatterplotmatrix now by default does not show the trace labels for the box plots, only if diag=box is selected for the diagonal subplot type.

[1.12.11] - 2016-12-01

Fixed

  • The link text in the bottom right corner of the offline plots now properly displays Export to [Domain Name] for the given domain name set in the users' .config file.

[1.12.10] - 2016-11-28

Updated

  • FF.create_violin and FF.create_scatterplotmatrix now by default do not print subplot grid information in output
  • 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.

Added

  • Plot configuration options for offline plots. See the list of configuration options and examples for more information.
    • Please note that these configuration options are for offline plots ONLY. For configuration options when embedding online plots please see our embed tutorial.
  • colors.py file which contains functions for manipulating and validating colors and arrays of colors
  • 'scale' param in FF.create_trisurf which now can set the interpolation on the colorscales
  • animations now work in offline mode. By running plotly.offline.plot() and plotly.offline.iplot() with a fig with frames, the resulting plot will cycle through the figures defined in frames either in the browser or in an ipython notebook respectively. Here's an example: ` import IPython.display from IPython.display import display, HTML from plotly.offline import download_plotlyjs, init_notebook_mode, plot, iplot init_notebook_mode(connected=True)

figure_or_data = {'data': [{'x': [1, 2], 'y': [0, 1]}], 'layout': {'xaxis': {'range': [0, 3], 'autorange': False}, 'yaxis': {'range': [0, 20], 'autorange': False}, 'title': 'First Title'}, 'frames': [{'data': [{'x': [1, 2], 'y': [5, 7]}]}, {'data': [{'x': [-1, 3], 'y': [3, 9]}]}, {'data': [{'x': [2, 2.6], 'y': [7, 5]}]}, {'data': [{'x': [1.5, 3], 'y': [7.5, 4]}]}, {'data': [{'x': [1, 2], 'y': [0, 1]}], 'layout': {'title': 'End Title'}}]} iplot(figure_or_data)

More examples can be found at https://plot.ly/python/animations/.
- animations now work in online mode: use `plotly.plotly.create_animations` and `plotly.plotly.icreate_animations` which animate a figure with the `frames` argument. Here is a simple example:

import plotly.plotly as py from plotly.grid_objs import Grid, Column

column_1 = Column([0.5], 'x') column_2 = Column([0.5], 'y') column_3 = Column([1.5], 'x2') column_4 = Column([1.5], 'y2')

grid = Grid([column_1, column_2, column_3, column_4]) py.grid_ops.upload(grid, 'ping_pong_grid', auto_open=False)

create figure

figure = { 'data': [ { 'xsrc': grid.get_column_reference('x'), 'ysrc': grid.get_column_reference('y'), 'mode': 'markers', } ], 'layout': {'title': 'Ping Pong Animation', 'xaxis': {'range': [0, 2], 'autorange': False}, 'yaxis': {'range': [0, 2], 'autorange': False}, 'updatemenus': [{ 'buttons': [ {'args': [None], 'label': u'Play', 'method': u'animate'} ], 'pad': {'r': 10, 't': 87}, 'showactive': False, 'type': 'buttons' }]}, 'frames': [ { 'data': [ { 'xsrc': grid.get_column_reference('x2'), 'ysrc': grid.get_column_reference('y2'), 'mode': 'markers', } ] }, { 'data': [ { 'xsrc': grid.get_column_reference('x'), 'ysrc': grid.get_column_reference('y'), 'mode': 'markers', } ] } ] }

py.create_animations(figure, 'ping_pong')


### Fixed
- Trisurf now uses correct `Plotly Colorscales` when called
- Fixed a bug in the format of unique-identifiers in columns of grids that are uploaded to plotly via `plotly.plotly.upload`. See https://github.com/plotly/plotly.py/pull/599 for details. In particular, creating plots that are based off of plotly grids is no longer broken. Here is an example:

import plotly.plotly as py from plotly.grid_objs import Grid, Column

c1 = Column([6, 6, 6, 5], 'column 1') c2 = Column(['a', 'b', 'c', 'd'], 'column 2') g = Grid([c1, c2])

Upload the grid

py.grid_ops.upload(g, 'my-grid', auto_open=False)

Make a graph that with data that is referenced from that grid

trace = Scatter(xsrc=g[0], ysrc=g[1]) url = py.plot([trace], filename='my-plot')

Then, whenever you update the data in `'my-grid'`, the associated plot will update too. See https://plot.ly/python/data-api for more details on usage and examples.

## [1.12.9] - 2016-08-22
### Fixed
- the colorbar in `.create_trisurf` now displays properly in `offline mode`.

### Updated
- the colorbar in `.create_trisurf` now displays the appropriate max and min values on the ends of the bar which corresponding to the coloring metric of the figure
- `edges_color` is now a param in `.create_trisurf` which only takes `rgb` values at the moment

## [1.12.8] - 2016-08-18
### Fixed
- Fixed color bug with trisurf plots where certain triangles were colored strangely. The coordinates of `rgb(...)` are now rounded to their nearest integer (using Python3 method of rounding), then placed in the color string to fix the issue.

## [1.12.7] - 2016-08-17
### Fixed
- Edited `plotly.min.js` due to issue using `iplot` to plot offline in Jupyter Notebooks
  - Please note that `plotly.min.js` may be cached in your Jupyter Notebook. Therefore, if you continue to experience this issue after upgrading the Plotly package please open a new notebook or clear the cache to ensure the correct `plotly.min.js` is referenced.

## [1.12.6] - 2016-08-09
### Updated
- Updated `plotly.min.js` from 1.14.1 to 1.16.2
  - Trace type scattermapbox is now part of the main bundle
  - Add updatemenus (aka dropdowns) layout components
  - See [the plotly.js CHANGELOG](https://github.com/plotly/plotly.js/blob/master/CHANGELOG.md) for additional information regarding the updates

## [1.12.5] - 2016-08-03
### Updated
- `.create_trisurf` now supports a visible colorbar for the trisurf plots. Check out the docs for help:

import plotly.tools as tls help(tls.FigureFactory.create_trisurf)


## [1.12.4] - 2016-07-14
### Added
- The FigureFactory can now create 2D-density charts with `.create_2D_density`. Check it out with:

import plotly.tools as tls help(tls.FigureFactory.create_2D_density)


## [1.12.3] - 2016-06-30
### Updated
- Updated `plotly.min.js` from 1.13.0 to 1.14.1
  - Numerous additions and changes where made to the mapbox layout layers attributes
  - Attribute line.color in scatter3d traces now support color scales
  - Layout shapes can now be moved and resized (except for 'path' shapes) in editable contexts
  - See [the plotly.js CHANGELOG](https://github.com/plotly/plotly.js/blob/master/CHANGELOG.md#1141----2016-06-28) for additional information regarding the updates
- Updated `default-schema`

### Added
- Added `update_plotlyjs_for_offline` in makefile in order to automate updating `plotly.min.js` for offline mode

## [1.12.2] - 2016-06-20
### Updated
- Updated plotly.min.js so the offline mode is using plotly.js v1.13.0
  - Fix `Plotly.toImage` and `Plotly.downloadImage` bug specific to Chrome 51 on OSX
  - Beta version of the scattermapbox trace type - which allows users to create mapbox-gl maps using the plotly.js API. Note that scattermapbox is only available through custom bundling in this release.
  - See [the plotly.js CHANGELOG](https://github.com/plotly/plotly.js/blob/master/CHANGELOG.md#1130----2016-05-26) for additional additions and updates.

### Added
- The FigureFactory can now create gantt charts with `.create_gantt`. Check it out with:

import plotly.tools as tls help(tls.FigureFactory.create_gantt)

- Ability to download images in offline mode. By providing an extra keyword `image` to the existing plot calls, you can now download the images of the plots you make in offline mode.

### Fixed
- Fixed check for the height parameter passed to `_plot_html`, and now sets the correct `link text` for plots
generated in offline mode.


## [1.12.1] - 2016-06-19
### Added
- The FigureFactory can now create violin plots with `.create_violin`. Check it out with:

import plotly.tools as tls help(tls.FigureFactory.create_violin)


## [1.12.0] - 2016-06-06
### Added
- Added ability to enable/disable SSL certificate verification for streaming. Disabling SSL certification verification requires Python v2.7.9 / v3.4.3 (or above). This feature can be toggled via the `plotly_ssl_verification` configuration setting.

## [1.11.0] - 2016-05-27
### Updated
- Changed the default option for `create_distplot` in the figure factory from `probability` to `probability density` and also added the `histnorm` parameter to allow the user to choose between the two options.
Note: This is a backwards incompatible change.

- Updated plotly.min.js so the offline mode is using plotly.js v1.12.0
  - Light position is now configurable in surface traces
  - surface and mesh3d lighting attributes are now accompanied with comprehensive descriptions

- Allowed `create_scatterplotmatrix` and `create_trisurf` to use divergent and categorical colormaps. The parameter `palette` has been replaced by `colormap` and `use_palette` has been removed. In `create_scatterplotmatrix`, users can now:
  - Input a list of different color types (hex, tuple, rgb) to `colormap` to map colors divergently
  - Use the same list to categorically group the items in the index column
  - Pass a singlton color type to `colormap` to color all the data with one color
  - Input a dictionary to `colormap` to map index values to a specific color
  - 'cat' and 'seq' are valid options for `colormap_type`, which specify the type of colormap being used

- In `create_trisurf`, the parameter `dist_func` has been replaced by `color_func`. Users can now:
  - Input a list of different color types (hex, tuple, rgb) to `colormap` to map colors divergently
  - Input a list|array of hex and rgb colors to `color_func` to assign each simplex to a color

### Added
- Added the option to load plotly.js from a CDN by setting the parameter `connected=True`
 in the `init_notebook_mode()` function call
- The FigureFactory can now create trisurf plots with `.create_trisurf`. Check it out with:

import plotly.tools as tls help(tls.FigureFactory.create_trisurf)




## [1.10.0] - 2016-05-19
### Fixed
- Version 1.9.13 fixed an issue in offline mode where if you ran `init_notebook_mode`
more than once the function would skip importing (because it saw that it had
already imported the library) but then accidentally clear plotly.js from the DOM.
This meant that if you ran `init_notebook_mode` more than once, your graphs would
not appear when you refreshed the page.
Version 1.9.13 solved this issue by injecting plotly.js with every iplot call.
While this works, it also injects the library excessively, causing notebooks
to have multiple versions of plotly.js inline in the DOM, potentially making
notebooks with many `iplot` calls very large.
Version 1.10.0 brings back the requirement to call `init_notebook_mode` before
making an `iplot` call. It makes `init_notebook_mode` idempotent: you can call
it multiple times without worrying about losing your plots on refresh.


## [1.9.13] - 2016-05-19
### Fixed
- Fixed issue in offline mode related to the inability to reload plotly.js on page refresh and extra init_notebook_mode calls.

## [1.9.12] - 2016-05-16
### Added
- SSL support for streaming.

## [1.9.11] - 2016-05-02
### Added
- The FigureFactory can now create scatter plot matrices with `.create_scatterplotmatrix`. Check it out with:

import plotly.tools as tls help(tls.FigureFactory.create_scatterplotmatrix)


## [1.9.10] - 2016-04-27
### Updated
- Updated plotly.min.js so the offline mode is using plotly.js v1.10.0
  - Added beta versions of two new 2D WebGL trace types: heatmapgl, contourgl
  - Added fills for scatterternary traces
  - Added configurable shapes layer positioning with the shape attribute: `layer`

## [1.9.9] - 2016-04-15
### Fixed
- Fixed `require is not defined` issue when plotting offline outside of Ipython Notebooks.

## [1.9.8] - 2016-04-14
### Fixed
- Error no longer results from a "Run All" cells when working in a Jupyter Notebook.

### Updated
- Updated plotly.min.js so offline is using plotly.js v1.9.0
  - Added Ternary plots with support for scatter traces (trace type `scatterternary`, currently only available in offline mode)
  - For comprehensive update list see the [plotly.js CHANGELOG](https://github.com/plotly/plotly.js/blob/master/CHANGELOG.md)

## [1.9.7] - 2016-04-04
### Fixed
- Offline mode will no longer delete the Jupyter Notebook's require, requirejs, and define variables.

### Updated
- Updated plotly.min.js so offline is using plotly.js v1.8.0
  - Added range selector functionality for cartesian plots
  - Added range slider functionality for scatter traces
  - Added custom surface color functionality
  - Added ability to subplot multiple graph types (SVG cartesian, 3D, maps, pie charts)
  - For comprehensive update list see the [plotly.js CHANGELOG](https://github.com/plotly/plotly.js/blob/master/CHANGELOG.md)

## [1.9.6] - 2016-02-18
### Updated
- Updated plotly.min.js so offline is using plotly.js v1.5.2

## [1.9.5] - 2016-01-17
### Added
- Offline matplotlib to Plotly figure conversion. Use `offline.plot_mpl` to convert and plot a matplotlib figure as a Plotly figure independently of IPython/Jupyter notebooks or use `offline.iplot_mpl` to convert and plot inside of IPython/Jupyter notebooks. Additionally, use `offline.enable_mpl_offline` to convert and plot all matplotlib figures as plotly figures inside an IPython/Jupyter notebook. See examples below:

An example independent of IPython/Jupyter notebooks:

from plotly.offline import init_notebook_mode, plot_mpl import matplotlib.pyplot as plt

init_notebook_mode()

fig = plt.figure() x = [10, 15, 20] y = [100, 150, 200] plt.plot(x, y, "o")

plot_mpl(fig)


An example inside of an IPython/Jupyter notebook:

from plotly.offline import init_notebook_mode, iplot_mpl import matplotlib.pyplot as plt

init_notebook_mode()

fig = plt.figure() x = [10, 15, 20] y = [100, 150, 200] plt.plot(x, y, "o")

iplot_mpl(fig)


An example of enabling all matplotlib figures to be converted to
Plotly figures inside of an IPython/Jupyter notebook:

from plotly.offline import init_notebook_mode, enable_mpl_offline import matplotlib.pyplot as plt

init_notebook_mode() enable_mpl_offline()

fig = plt.figure() x = [10, 15, 20, 25, 30] y = [100, 250, 200, 150, 300] plt.plot(x, y, "o") fig


## [1.9.4] - 2016-01-11
### Added
- Offline plotting now works outside of the IPython/Jupyter notebook. Here's an example:

from plotly.offline import plot from plotly.graph_objs import Scatter

plot([Scatter(x=[1, 2, 3], y=[3, 1, 6])])


This command works entirely locally. It writes to a local HTML file with the necessary [plotly.js](https://plot.ly/javascript) code to render the graph. Your browser will open the file after you make the call.

The call signature is very similar to `plotly.offline.iplot` and `plotly.plotly.plot` and `plotly.plotly.iplot`, so you can basically use these commands interchangeably.

If you want to publish your graphs to the web, use `plotly.plotly.plot`, as in:

import plotly.plotly as py from plotly.graph_objs import Scatter

py.plot([Scatter(x=[1, 2, 3], y=[5, 1, 6])])


This will upload the graph to your online plotly account.

## [1.9.3] - 2015-12-08
### Added
- Check for `no_proxy` when determining if the streaming request should pass through a proxy in the chunked_requests submodule. Example: `no_proxy='my_stream_url'` and `http_proxy=my.proxy.ip:1234`, then `my_stream_url` will not get proxied. Previously it would.

## [1.9.2] - 2015-11-30
**Bug Fix**: Previously, the "Export to plot.ly" link on
offline charts would export your figures to the
public plotly cloud, even if your `config_file`
(set with `plotly.tools.set_config_file` to the file
`~/.plotly/.config`) set `plotly_domain` to a plotly enterprise
URL like `https://plotly.acme.com`.

This is now fixed. Your graphs will be exported to your
`plotly_domain` if it is set.

## [1.9.1] - 2015-11-26
### Added
- The FigureFactory can now create annotated heatmaps with `.create_annotated_heatmap`. Check it out with:

import plotly.tools as tls help(tls.FigureFactory.create_annotated_heatmap)

- The FigureFactory can now create tables with `.create_table`.

import plotly.tools as tls help(tls.FigureFactory.create_table)


## [1.9.0] - 2015-11-15
- Previously, using plotly offline required a paid license.
No more: `plotly.js` is now shipped inside this package to allow
unlimited free use of plotly inside the ipython notebook environment.
The `plotly.js` library that is included in this package is free,
open source, and maintained independently on GitHub at
[https://github.com/plotly/plotly.js](https://github.com/plotly/plotly.js).
- The `plotly.js` bundle that is required for offline use is no longer downloaded
and installed independently from this package: `plotly.offline.download_plotlyjs`
is **deprecated**.
- New versions of `plotly.js` will be tested and incorporated
  into this package as new versioned pip releases;
  `plotly.js` is not automatically kept in sync with this package.

## [1.8.12] - 2015-11-02
- *Big data* warning mentions `plotly.graph_objs.Scattergl` as possible solution.

## [1.8.9] - 2015-10-11
- If you're behind a proxy, you can make requests by setting the environmental variable HTTP_PROXY and HTTPS_PROXY (http://docs.python-requests.org/en/v1.0.4/user/advanced/#proxies). This didn't work for streaming, but now it does.

## [1.8.8] - 2015-10-05
- Sometimes creating a graph with a private share-key doesn't work -
the graph is private, but not accessible with the share key.
Now we check to see if it didn't work, and re-try a few times until
it does.

## [1.8.7] - 2015-10-01
### Added
- The FigureFactory can now create dendrogram plots with `.create_dendrogram`.

## [1.8.6] - 2015-09-28
### Fixed
- Saving "world_readable" to your config file via `plotly.tools.set_config` actually works.

### Added
- You can also save `auto_open` and `sharing` to the config file so that you can forget these
  keyword argument in `py.iplot` and `py.plot`.

## [1.8.5] - 2015-09-29
### Fixed
- Fixed validation errors (validate=False workaround no longer required)

### Added
- Auto-sync API request on import to get the latest schema from Plotly
- `.`-access for nested attributes in plotly graph objects
- General `.help()` method for plotly graph objects
- Specific attribute `.help(<attribute>)` also included

### Removed
- No more *is streamable*, streaming validation.

## [1.8.3] - 2015-08-14
### Fixed
- Fixed typos in `plot` and `iplot` documentations

## [1.8.2] - 2015-08-11
### Added
- CHANGELOG
- `sharing` keyword argument for `plotly.plotly.plot` and `plotly.plotly.iplot` with options `'public' | 'private' | 'secret'` to control the privacy of the charts. Depreciates `world_readable`

### Changed
- If the response from `plot` or `iplot` contains an error message, raise an exception

### Removed
- `height` and `width` are no longer accepted in `iplot`. Just stick them into your figure's layout instead, it'll be more consistent when you view it outside of the IPython notebook environment. So, instead of this:

py.iplot([{'x': [1, 2, 3], 'y': [3, 1, 5]}], height=800)


  do this:

py.iplot({ 'data': [{'x': [1, 2, 3], 'y': [3, 1, 5]}], 'layout': {'height': 800} }) `

Fixed

  • The height of the graph in iplot respects the figure's height in layout