Merge remote-tracking branch 'origin/master' into orjson_encoding

# Conflicts: # packages/python/plotly/plotly/io/_json.py # packages/python/plotly/tox.ini
plotly · nicolaskruchten · May 27, 2021 · Dec 5, 2020 · Dec 5, 2020 · Dec 5, 2020
commit 1fbfa0d36cb3ccba737f3e1beedb52be1742c042
diff --git a/.circleci/config.yml b/.circleci/config.yml
diff --git a/.circleci/create_conda_optional_env.sh b/.circleci/create_conda_optional_env.sh
diff --git a/.circleci/install_miniconda_and_build_.sh b/.circleci/install_miniconda_and_build_.sh
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -135,7 +135,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
   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](https://github.com/plotly/plotly.py/pull/2691)
-- `px.imshow` has a new `constrast_rescaling` argument in order to choose how
+- `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](https://github.com/plotly/plotly.py/pull/2691)
 
@@ -239,7 +239,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ### 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 informatiom [#2377](https://github.com/plotly/plotly.py/pull/2377).
+- The `hover_data` parameter of `px` functions can now be a dictionary. This makes it possible to skip hover information for some arguments or to change the formatting of hover information [#2377](https://github.com/plotly/plotly.py/pull/2377).
 - It's now possible to build a development version of Plotly.py against the build artifacts from a non-`master` branch of Plotly.js, which makes for faster QA and development cycles [#2349](https://github.com/plotly/plotly.py/pull/2349). Thanks [@zouhairm](https://github.com/zouhairm) for this Pull Request!
 
 ### Fixed
@@ -252,7 +252,7 @@ This version includes several performance improvements ([#2368](https://github.c
 
  - 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, ploty.py now takes advantage of [PEP-562](https://www.python.org/dev/peps/pep-0562/) to perform submodule imports lazily.  This dramatically improves import times.
+ - When used with Python 3.7 and above, plotly.py now takes advantage of [PEP-562](https://www.python.org/dev/peps/pep-0562/) to perform submodule imports lazily.  This dramatically improves import times.
 
 ## [4.6.0] - 2020-03-31
 
@@ -290,7 +290,7 @@ This version includes several performance improvements ([#2368](https://github.c
 
 - Jupyterlab extension now compatible with both Jupyterlab 1.2 and 2.0 [#2261](https://github.com/plotly/plotly.py/pull/2261) with thanks to [@consideRatio](https://github.com/consideRatio) for the contribution!
 - Fixed a bug when using boolean values for the color argument of px functions [#2127](https://github.com/plotly/plotly.py/pull/2127)
-- Corrected import bug which was occuring with old versions of ipywidgets [#2265](https://github.com/plotly/plotly.py/pull/2265)
+- Corrected import bug which was occurring with old versions of ipywidgets [#2265](https://github.com/plotly/plotly.py/pull/2265)
 - Fixed python 3.8 syntax warning [#2262](https://github.com/plotly/plotly.py/pull/2262), with thanks to [@sgn](https://github.com/sgn) for the contribution!
 
 ## [4.5.3] - 2020-03-05
@@ -365,7 +365,7 @@ This version includes several performance improvements ([#2368](https://github.c
  for more information
  - The tutorials of the [plotly.py documentation](https://plot.ly/python/) are
    now in the main [plotly.py Github repository](https://github.com/plotly/plotly.py). Contributions in order to improve or extend the documentation are very welcome!
- - `plotly.express` generated plots no longer have a default height of 600 pixels, instead they inherit the default height of regular figures [#1990](https://github.com/plotly/plotly.py/pull/1990). To restore the old behavior, set `px.defaults.height=600` once per session, or set the `height` keyword arguement to any `px.function()` to 600.
+ - `plotly.express` generated plots no longer have a default height of 600 pixels, instead they inherit the default height of regular figures [#1990](https://github.com/plotly/plotly.py/pull/1990). To restore the old behavior, set `px.defaults.height=600` once per session, or set the `height` keyword argument to any `px.function()` to 600.
 
 ### Fixed
 
@@ -439,7 +439,7 @@ section [#1969](https://github.com/plotly/plotly.py/pull/1969).
  - The width of a figure produced by the `create_gantt` figure factory now resizes responsively ([#1724](https://github.com/plotly/plotly.py/pull/1724))
 
 ### Fixed
- - The name of the steps property of `graph_objects.indicator.Guage` has been renamed from `stepss` to `steps`
+ - 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](https://github.com/plotly/plotly.py/pull/1723))
 
 ## [4.1.0] - 2019-08-06
@@ -491,7 +491,7 @@ This is a major release that includes many new features, and a few breaking chan
  - Added support for all trace types in `make_subplots` ([#1528](https://github.com/plotly/plotly.py/pull/1528))
  - Added support for secondary y-axes in `make_subplots` ([#1564](https://github.com/plotly/plotly.py/pull/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](https://github.com/plotly/plotly.py/pull/1614))
- - Added dictionary-stule `.pop` method to graph object classes ([#1614](https://github.com/plotly/plotly.py/pull/1614))
+ - Added dictionary-style `.pop` method to graph object classes ([#1614](https://github.com/plotly/plotly.py/pull/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](https://github.com/plotly/plotly.py/pull/1647)).
  - Added `sphinx-gallery` renderer for embedding plotly figures in [Sphinx-Gallery](https://sphinx-gallery.github.io/) ([#1577](https://github.com/plotly/plotly.py/pull/1577), [plotly/plotly-sphinx-gallery](https://github.com/plotly/plotly-sphinx-gallery)).
@@ -1096,7 +1096,7 @@ must be installed:
   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 `OrdererdDict` and `list` instances where the keys in each
+  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.
@@ -1517,7 +1517,7 @@ gone.
 ## [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 occured when downloading plot images offline. Please note: for higher resolution images and more export options, consider making requests to our image servers. See: `help(py.image)` for more details.
+- 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](https://github.com/Rikorose/plotly.py/blob/master/plotly/offline/offline.py#L189) and [examples](https://plot.ly/javascript/configuration-options/) for more information.

diff --git a/build_for_conda.md b/build_for_conda.md
@@ -16,4 +16,4 @@ Finally, build and test the created version:
 
 `conda build plotly`
 
-Currently, the updated (version 1.12.4) conda package sits at https://anaconda.org/chohner/plotly. There seems to be an old offial package at https://anaconda.org/plotly/plotly.
+Currently, the updated (version 1.12.4) conda package sits at https://anaconda.org/chohner/plotly. There seems to be an old official package at https://anaconda.org/plotly/plotly.
diff --git a/doc/python/2D-Histogram.md b/doc/python/2D-Histogram.md
@@ -137,7 +137,7 @@ fig = go.Figure(go.Histogram2d(x=x, y=y, histnorm='probability',
 fig.show()
 ```
 ### Sharing bin settings between 2D Histograms
-This example shows how to use [bingroup](https://plotly.com/python/reference/histogram/#histogram-bingroup) attribute to have a compatible bin settings for both histograms. To define `start`, `end` and `size` value of x-axis and y-axis seperatly, set [ybins](https://plotly.com/python/reference/histogram2dcontour/#histogram2dcontour-ybins) and `xbins`.
+This example shows how to use [bingroup](https://plotly.com/python/reference/histogram/#histogram-bingroup) attribute to have a compatible bin settings for both histograms. To define `start`, `end` and `size` value of x-axis and y-axis separately, set [ybins](https://plotly.com/python/reference/histogram2dcontour/#histogram2dcontour-ybins) and `xbins`.
 
 ```python
 import plotly.graph_objects as go

diff --git a/doc/python/3d-isosurface-plots.md b/doc/python/3d-isosurface-plots.md
@@ -130,7 +130,7 @@ fig = go.Figure(data=go.Isosurface(
 fig.show()
 ```
 
-#### Isosurface with Addtional Slices
+#### Isosurface with Additional Slices
 
 Here we visualize slices parallel to the axes on top of isosurfaces. For a clearer visualization, the `fill` ratio of isosurfaces is decreased below 1 (completely filled).
 
@@ -235,4 +235,4 @@ fig.show()
 ```
 
 #### Reference
-See https://plotly.com/python/reference/isosurface/ for more information and chart attribute options!
+See https://plotly.com/python/reference/isosurface/ for more information and chart attribute options!
diff --git a/doc/python/3d-mesh.md b/doc/python/3d-mesh.md
@@ -83,7 +83,7 @@ IFrame(snippet_url + '3d-mesh', width='100%', height=630)
 
 ### Mesh Tetrahedron
 
-In this example we use the `ì`, `j` and `k` parameters to specify manually the geometry of the triangles of the mesh.
+In this example we use the `i`, `j` and `k` parameters to specify manually the geometry of the triangles of the mesh.
 
 ```python
 import plotly.graph_objects as go

diff --git a/doc/python/LaTeX.md b/doc/python/LaTeX.md
@@ -0,0 +1,68 @@
+---
+jupyter:
+  jupytext:
+    notebook_metadata_filter: all
+    text_representation:
+      extension: .md
+      format_name: markdown
+      format_version: '1.2'
+      jupytext_version: 1.4.2
+  kernelspec:
+    display_name: Python 3
+    language: python
+    name: python3
+  language_info:
+    codemirror_mode:
+      name: ipython
+      version: 3
+    file_extension: .py
+    mimetype: text/x-python
+    name: python
+    nbconvert_exporter: python
+    pygments_lexer: ipython3
+    version: 3.7.7
+  plotly:
+    description: How to add LaTeX to python graphs.
+    display_as: advanced_opt
+    language: python
+    layout: base
+    name: LaTeX
+    order: 5
+    page_type: example_index
+    permalink: python/LaTeX/
+    thumbnail: thumbnail/latex.jpg
+---
+
+#### LaTeX Typesetting
+
+```python
+import plotly.express as px
+
+fig = px.line(x=[1, 2, 3, 4], y=[1, 4, 9, 16], title=r'$\alpha_{1c} = 352 \pm 11 \text{ km s}^{-1}$')
+fig.update_layout(
+    xaxis_title=r'$\sqrt{(n_\text{c}(t|{T_\text{early}}))}$',
+    yaxis_title=r'$d, r \text{ (solar radius)}$'
+)
+fig.show()
+```
+
+```python
+import plotly.graph_objs as go
+
+fig = go.Figure()
+fig.add_trace(go.Scatter(
+    x=[1, 2, 3, 4],
+    y=[1, 4, 9, 16],
+    name=r'$\alpha_{1c} = 352 \pm 11 \text{ km s}^{-1}$'
+))
+fig.add_trace(go.Scatter(
+    x=[1, 2, 3, 4],
+    y=[0.5, 2, 4.5, 8],
+    name=r'$\beta_{1c} = 25 \pm 11 \text{ km s}^{-1}$'
+))
+fig.update_layout(
+    xaxis_title=r'$\sqrt{(n_\text{c}(t|{T_\text{early}}))}$',
+    yaxis_title=r'$d, r \text{ (solar radius)}$'
+)
+fig.show()
+```
diff --git a/doc/python/annotated-heatmap.md b/doc/python/annotated-heatmap.md
@@ -82,7 +82,7 @@ fig.show()
 ```
 
 #### Custom Text and X & Y Labels
-set `annotation_text` to a matrix with the same dimmensions as `z`
+set `annotation_text` to a matrix with the same dimensions as `z`
 
 ```python
 import plotly.figure_factory as ff
@@ -203,4 +203,4 @@ fig.show()
 
 #### Reference
 
-For more info on Plotly heatmaps, see: https://plotly.com/python/reference/heatmap/.<br> For more info on using colorscales with Plotly see: https://plotly.com/python/heatmap-and-contour-colorscales/ <br>For more info on `ff.create_annotated_heatmap()`, see the [full function reference](https://plotly.com/python-api-reference/generated/plotly.figure_factory.create_annotated_heatmap.html#plotly.figure_factory.create_annotated_heatmap)
+For more info on Plotly heatmaps, see: https://plotly.com/python/reference/heatmap/.<br> For more info on using colorscales with Plotly see: https://plotly.com/python/heatmap-and-contour-colorscales/ <br>For more info on `ff.create_annotated_heatmap()`, see the [full function reference](https://plotly.com/python-api-reference/generated/plotly.figure_factory.create_annotated_heatmap.html#plotly.figure_factory.create_annotated_heatmap)
diff --git a/doc/python/axes.md b/doc/python/axes.md
@@ -66,7 +66,7 @@ The axis type is auto-detected by looking at data from the first [trace](/python
 
 ### Forcing an axis to be categorical
 
-It is possible to force the axis type by setting explicitely `xaxis_type`. In the example below the automatic X axis type would be `linear` (because there are not more than twice as many unique strings as unique numbers) but we force it to be `category`.
+It is possible to force the axis type by setting explicitly `xaxis_type`. In the example below the automatic X axis type would be `linear` (because there are not more than twice as many unique strings as unique numbers) but we force it to be `category`.
 
 ```python
 import plotly.express as px
@@ -139,7 +139,7 @@ IFrame(snippet_url + 'axes', width='100%', height=630)
 
 #### Moving Tick Labels Inside the Plot
 
-The `ticklabelposition` attribute moves tick labels inside the plotting area, and modifies the auto-range behaviour to accomodate the labels.
+The `ticklabelposition` attribute moves tick labels inside the plotting area, and modifies the auto-range behaviour to accommodate the labels.
 
 ```python
 import plotly.express as px

diff --git a/doc/python/builtin-colorscales.md b/doc/python/builtin-colorscales.md
@@ -23,7 +23,7 @@ jupyter:
     version: 3.7.6
   plotly:
     description: A reference for the built-in named continuous (sequential, diverging
-      and cylclical) color scales in Plotly.
+      and cyclical) color scales in Plotly.
     display_as: file_settings
     has_thumbnail: true
     ipynb: ~notebook_demo/187

diff --git a/doc/python/carpet-contour.md b/doc/python/carpet-contour.md
@@ -37,7 +37,7 @@ jupyter:
 
 ### Basic Carpet Plot
 
-Set the `x` and `y` coorindates, using `x` and `y` attributes. If `x` coorindate values are ommitted a cheater plot will be created. To save parameter values use `a` and `b` attributes. To make changes to the axes, use `aaxis` or `baxis` attributes. For a more detailed list of axes attributes refer to [python reference](https://plotly.com/python/reference/carpet/#carpet-aaxis).
+Set the `x` and `y` coordinates, using `x` and `y` attributes. If `x` coordinate values are omitted a cheater plot will be created. To save parameter values use `a` and `b` attributes. To make changes to the axes, use `aaxis` or `baxis` attributes. For a more detailed list of axes attributes refer to [python reference](https://plotly.com/python/reference/carpet/#carpet-aaxis).
 
 ```python
 import plotly.graph_objects as go
@@ -286,4 +286,4 @@ fig.show()
 
 ### Reference
 
-See https://plotly.com/python/reference/contourcarpet/ for more information and chart attribute options!
+See https://plotly.com/python/reference/contourcarpet/ for more information and chart attribute options!
diff --git a/doc/python/carpet-plot.md b/doc/python/carpet-plot.md
@@ -39,7 +39,7 @@ jupyter:
 ### Set X and Y Coordinates
 
 
-To set the `x` and `y` coordinates use `x` and `y` attributes. If `x` coordindate values are ommitted a cheater plot will be created. The plot below has a `y` array specified but requires `a` and `b` parameter values before an axis may be plotted.
+To set the `x` and `y` coordinates use `x` and `y` attributes. If `x` coordinate values are omitted a cheater plot will be created. The plot below has a `y` array specified but requires `a` and `b` parameter values before an axis may be plotted.
 <!-- #endregion -->
 
 ```python
@@ -189,4 +189,4 @@ To add points and lines see [Carpet Scatter Plots](https://plotly.com/python/car
 
 ### Reference
 
-See https://plotly.com/python/reference/carpet/ for more information and chart attribute options!
+See https://plotly.com/python/reference/carpet/ for more information and chart attribute options!
diff --git a/doc/python/categorical-axes.md b/doc/python/categorical-axes.md
@@ -40,7 +40,7 @@ This page shows examples of how to configure [2-dimensional Cartesian axes](/pyt
 
 The different types of Cartesian axes are configured via the `xaxis.type` or `yaxis.type` attribute, which can take on the following values:
 
-- `'linear'` (see the [linear axes tutoria](/python/axes/))
+- `'linear'` (see the [linear axes tutorial](/python/axes/))
 - `'log'` (see the [log plot tutorial](/python/log-plots/))
 - `'date'` (see the [tutorial on timeseries](/python/time-series/))
 - `'category'` see below
@@ -55,7 +55,7 @@ The axis type is auto-detected by looking at data from the first [trace](/python
 
 ### Forcing an axis to be categorical
 
-It is possible to force the axis type by setting explicitely `xaxis_type`. In the example below the automatic X axis type would be `linear` (because there are not more than twice as many unique strings as unique numbers) but we force it to be `category`.
+It is possible to force the axis type by setting explicitly `xaxis_type`. In the example below the automatic X axis type would be `linear` (because there are not more than twice as many unique strings as unique numbers) but we force it to be `category`.
 
 ```python
 import plotly.express as px
Original file line number	Diff line number	Diff line change
Expand Up		@@ -16,4 +16,4 @@ Finally, build and test the created version:

		`conda build plotly`

		Currently, the updated (version 1.12.4) conda package sits at https://anaconda.org/chohner/plotly. There seems to be an old offial package at https://anaconda.org/plotly/plotly.
		Currently, the updated (version 1.12.4) conda package sits at https://anaconda.org/chohner/plotly. There seems to be an old official package at https://anaconda.org/plotly/plotly.