Skip to content

Commit ca01aba

Browse files
authored
Merge pull request #5708 from plotly/cam/update-docs-v7
docs: Update docs for v7
2 parents 7e20013 + 9edc6f0 commit ca01aba

47 files changed

Lines changed: 524 additions & 86 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
2525
- `rgb()`/`rgba()` strings with decimal 0–1 fractions are no longer supported
2626
- `hsv()` color strings are no longer supported
2727
- Strings with invalid syntax such as `hsl(120, 50% 50%)` are no longer supported
28-
- New supported formats: `'#ff0000aa'`, `'#f00a'`, `'rgb(255 0 0)'`, `'rgba(255 0 0 / 0.5)'`, `'hsl(0 100% 50% / 0.5)'`, `'hsla(0, 100%, 50%, 0.5)'`, `'hwb(0, 0%, 0%)'`, `lab()`, `lch()`, `oklab()`, `oklch()`, `color()`, `hsl(0.5turn 60% 40%)`, `hsl(none 60% 40%)`
28+
- New supported formats: `'#ff0000aa'`, `'#f00a'`, `'rgb(255 0 0)'`, `'rgba(255 0 0 / 0.5)'`, `'hsl(0 100% 50% / 0.5)'`, `'hsla(0, 100%, 50%, 0.5)'`, `'hwb(0 0% 0%)'`, `lab()`, `lch()`, `oklab()`, `oklch()`, `color()`, `hsl(0.5turn 60% 40%)`, `hsl(none 60% 40%)`
2929
- Replace `country-regex` with `country-iso-search` to search for country names in choropleth, scattergeo traces [[#7856](https://github.com/plotly/plotly.js/pull/7856)]. Most country names are handled exactly the same; a small number of legacy entries have been removed.
3030
- Change `layout.geo.fitbounds` default from `false` to `'locations'` [[#7895](https://github.com/plotly/plotly.js/pull/7895)]. `geo` subplots will now auto-fit the initial view to the trace data by default.
3131
- Dynamically compute `center` and `zoom` values for `scattermap` and `densitymap` traces. The initial map view will now auto-fit to the trace data by default. Add `layout.map.fitbounds` attribute (default `'locations'`) to enable or disable auto-fitting behavior [[#7884](https://github.com/plotly/plotly.js/pull/7884), [#7913](https://github.com/plotly/plotly.js/pull/7913)]

doc/apidoc/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
# The short X.Y version
2525
version = ""
2626
# The full version, including alpha/beta/rc tags
27-
release = "6.6.0"
27+
release = "7.0.0"
2828

2929

3030
# -- General configuration ---------------------------------------------------

doc/python/LaTeX.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ jupyter:
3535

3636
#### LaTeX Typesetting
3737

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

4040
```python
4141
import plotly.express as px

doc/python/axes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ jupyter:
2828
language: python
2929
layout: base
3030
name: Axes
31-
order: 14
31+
order: 15
3232
permalink: python/axes/
3333
thumbnail: thumbnail/axes.png
3434
---

doc/python/builtin-colorscales.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ jupyter:
3030
language: python
3131
layout: base
3232
name: Built-in Continuous Color Scales
33-
order: 28
33+
order: 29
3434
permalink: python/builtin-colorscales/
3535
thumbnail: thumbnail/heatmap_colorscale.jpg
3636
v4upgrade: true

doc/python/colorscales.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ jupyter:
3030
language: python
3131
layout: base
3232
name: Continuous Color Scales and Color Bars
33-
order: 21
33+
order: 22
3434
permalink: python/colorscales/
3535
redirect_from: python/logarithmic-color-scale/
3636
thumbnail: thumbnail/heatmap_colorscale.jpg

doc/python/configuration-options.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ jupyter:
2828
language: python
2929
layout: base
3030
name: Configuration
31-
order: 10
31+
order: 11
3232
page_type: u-guide
3333
permalink: python/configuration-options/
3434
thumbnail: thumbnail/modebar-icons.png
@@ -209,10 +209,14 @@ To delete buttons from the modebar, pass an array of strings containing the name
209209
- **High-level**: `zoom`, `pan`, `select`, `zoomIn`, `zoomOut`, `autoScale`, `resetScale`
210210
- **2D**: `zoom2d`, `pan2d`, `select2d`, `lasso2d`, `zoomIn2d`, `zoomOut2d`, `autoScale2d`, `resetScale2d`, `v1hovermode`
211211
- **2D Shape Drawing**: `drawline`, `drawopenpath`, `drawclosedpath`, `drawcircle`, `drawrect`, `eraseshape`
212-
- **3D**: `zoom3d`, `pan3d`, `orbitRotation`, `tableRotation`, `handleDrag3d`, `resetCameraDefault3d`, `resetCameraLastSave3d`, `hoverClosest3d`
212+
- **3D**: `zoom3d`, `pan3d`, `orbitRotation`, `tableRotation`, `resetCameraDefault3d`, `resetCameraLastSave3d`, `hoverClosest3d`
213213
- **Cartesian**: `hoverClosestCartesian`, `hoverCompareCartesian`
214214
- **Geo**: `zoomInGeo`, `zoomOutGeo`, `resetGeo`, `hoverClosestGeo`
215-
- **Other**: `hoverClosestGl2d`, `hoverClosestPie`, `toggleHover`, `resetViews`, `toImage`, `sendDataToCloud`, `toggleSpikelines`, `resetViewMap`
215+
- **Tile maps**: `zoomInMap`, `zoomOutMap`, `resetViewMap`
216+
- **Sankey**: `resetSankeyGroup`
217+
- **Other**: `hoverClosestPie`, `toggleHover`, `resetViews`, `toImage`, `sendChartToCloud`, `toggleSpikelines`
218+
219+
*Changed in 7.0*: `handleDrag3d` and `hoverClosestGl2d` no longer exist, and `sendDataToCloud` is now named `sendChartToCloud`.
216220

217221
```python
218222
import plotly.graph_objects as go

doc/python/discrete-color.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ jupyter:
3030
language: python
3131
layout: base
3232
name: Discrete Colors
33-
order: 29
33+
order: 30
3434
permalink: python/discrete-color/
3535
thumbnail: thumbnail/heatmap_colorscale.jpg
3636
v4upgrade: true

doc/python/figure-factories.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ jupyter:
2828
language: python
2929
layout: base
3030
name: Figure Factories
31-
order: 33
31+
order: 34
3232
permalink: python/figure-factories/
3333
thumbnail: thumbnail/streamline.jpg
3434
---
@@ -41,7 +41,7 @@ The following plot types can be created with Figure Factory:
4141

4242
* [Dendrograms](/python/dendrogram/)
4343
* [Hexagonal Binning Tile Map](/python/hexbin-map/)
44-
* [Quiver Plots](/python/quiver-plots/)
44+
* [Quiver Plots](/python/quiver-plots/) — since version 7.0, quiver plots are better made with the `go.Quiver` trace type. `create_quiver` remains available for its `angle` and `scaleratio` options.
4545
* [Streamline Plots](/python/streamline-plots/)
4646
* [Tables](/python/figure-factory-table/)
4747
* [Ternary Contour Plots](/python/ternary-contour/)
@@ -65,4 +65,3 @@ The following legacy Figure Factory functions have been replaced by Plotly Expre
6565
#### Reference
6666

6767
For more information about the contents of `plotly.figure_factory`, please refer to our [API Reference documentation](https://plotly.com/python-api-reference/plotly.figure_factory.html).
68-

doc/python/figure-introspection.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ jupyter:
2727
language: python
2828
layout: base
2929
name: Introspecting Figures
30-
order: 36
30+
order: 37
3131
page_type: u-guide
3232
permalink: python/figure-introspection/
3333
thumbnail: thumbnail/violin.jpg

0 commit comments

Comments
 (0)