Skip to content

Commit 947cbb1

Browse files
authored
Merge pull request #4245 from plotly/update-5-15-examples
Minor edits to 5.15 examples
2 parents 7c719a6 + f2840a3 commit 947cbb1

File tree

3 files changed

+55
-24
lines changed

3 files changed

+55
-24
lines changed

Diff for: doc/python/colorscales.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ jupyter:
66
extension: .md
77
format_name: markdown
88
format_version: '1.3'
9-
jupytext_version: 1.14.5
9+
jupytext_version: 1.14.6
1010
kernelspec:
1111
display_name: Python 3 (ipykernel)
1212
language: python
@@ -20,7 +20,7 @@ jupyter:
2020
name: python
2121
nbconvert_exporter: python
2222
pygments_lexer: ipython3
23-
version: 3.10.11
23+
version: 3.10.8
2424
plotly:
2525
description: How to set, create and control continuous color scales and color
2626
bars in scatter, bar, map and heatmap figures.
@@ -307,11 +307,11 @@ Using `labelalias` you can replace some labels on the `colorbar` with alternativ
307307
```python
308308
import plotly.graph_objects as go
309309

310-
import urllib
310+
import urllib.request as request
311311
import json
312312

313313
# Load heatmap data
314-
response = urllib.request.urlopen(
314+
response = request.urlopen(
315315
"https://raw.githubusercontent.com/plotly/datasets/master/custom_heatmap_colorscale.json")
316316
dataset = json.load(response)
317317

Diff for: doc/python/legend.md

+14-10
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ jupyter:
66
extension: .md
77
format_name: markdown
88
format_version: '1.3'
9-
jupytext_version: 1.14.5
9+
jupytext_version: 1.14.6
1010
kernelspec:
1111
display_name: Python 3 (ipykernel)
1212
language: python
@@ -580,7 +580,7 @@ fig.show()
580580

581581
By default, all traces appear on one legend. To have multiple legends, specify an alternative legend for a trace using the `legend` property. For a second legend, set `legend="legend2"`. Specify more legends with `legend="legend3"`, `legend="legend4"` and so on.
582582

583-
In this example, the last two scatter traces display on the second legend, "legend2". On the figure's layout, we then position and style this legend to display on the right of the graph below the first legend.
583+
In this example, the last two scatter traces display on the second legend, "legend2". On the figure's layout, we then position and style each legend.
584584

585585

586586
```python
@@ -622,20 +622,25 @@ fig = go.Figure(
622622
],
623623
layout=dict(
624624
title="GDP Per Capita",
625-
legend={"title": "By country", "bgcolor": "Orange",},
625+
legend={
626+
"title": "By country",
627+
"xref": "container",
628+
"yref": "container",
629+
"y": 0.65,
630+
"bgcolor": "Orange",
631+
},
626632
legend2={
627-
"x": 1.155,
628-
"y": 0.55,
629-
"xanchor": "right",
630-
"yanchor": "middle",
633+
"title": "By continent",
634+
"xref": "container",
635+
"yref": "container",
636+
"y": 0.85,
631637
"bgcolor": "Gold",
632-
"title": {"text": "By continent"},
638+
633639
},
634640
),
635641
)
636642

637643
fig.show()
638-
639644
```
640645

641646
### Positioning Legends
@@ -666,7 +671,6 @@ fig = go.Figure(
666671
"xref": "container",
667672
"yref": "container",
668673
"bgcolor": "Gold",
669-
"title": {"text": "By continent"},
670674
},
671675
),
672676
)

Diff for: doc/python/shapes.md

+37-10
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ jupyter:
66
extension: .md
77
format_name: markdown
88
format_version: '1.3'
9-
jupytext_version: 1.14.5
9+
jupytext_version: 1.14.6
1010
kernelspec:
1111
display_name: Python 3 (ipykernel)
1212
language: python
@@ -20,7 +20,7 @@ jupyter:
2020
name: python
2121
nbconvert_exporter: python
2222
pygments_lexer: ipython3
23-
version: 3.8.8
23+
version: 3.10.10
2424
plotly:
2525
description: How to make SVG shapes in python. Examples of lines, circle, rectangle,
2626
and path.
@@ -917,18 +917,27 @@ fig.show()
917917

918918
*New in 5.15*
919919

920-
Use `texttemplate` to add text with variables to shapes. `texttemplate` uses d3 number and date formatting and supports raw variables, which use the raw data from the shape definition, and some calculated variables. Add a variable with "%{variable}".
920+
Use `texttemplate` to add text with variables to shapes. You have access to raw variables (`x0`, `x1`, `y0`, `y1`), which use raw data values from the shape definition, and the following calculated variables:
921921

922-
This example adds the raw variables `x0` and `y0` to a rectangle and shows the calculated variables `height`, `slope`, and `width` on three other shapes.
922+
- `xcenter`: (x0 + x1) / 2
923+
- `ycenter`: (y0 + y1) / 2
924+
- `dx`: x1 - x0
925+
- `dy`: y1 - y0
926+
- `width`: abs(x1 - x0)
927+
- `height`: abs(y1 - y0)
928+
- `length` (for lines only): sqrt(dx^2 + dy^2)
929+
- `slope`: (y1 - y0) / (x1 - x0)
923930

924-
For a complete list of available variables, see the [Shape Reference Docs](https://plotly.com/python/reference/layout/shapes/).
931+
`texttemplate` supports d3 number and date formatting.
925932

933+
Add a variable with "%{variable}". This example adds the raw variables `x0` and `y0` to a rectangle and shows the calculated variables `height`, `slope`, `length`, and `width` on three other shapes.
926934

927935
```python
928936
import plotly.graph_objects as go
929937

930938
fig = go.Figure()
931939

940+
932941
fig.add_shape(
933942
type="rect",
934943
fillcolor="MediumSlateBlue",
@@ -955,9 +964,12 @@ fig.add_shape(
955964
x0=3,
956965
y0=0.5,
957966
x1=5,
958-
y1=0.8,
967+
y1=1.5,
959968
line_width=3,
960-
label=dict(texttemplate="Slope: %{slope:.3f}", font=dict(size=20)),
969+
label=dict(
970+
texttemplate="Slope of %{slope:.3f} and length of %{length:.3f}",
971+
font=dict(size=20),
972+
),
961973
)
962974
fig.add_shape(
963975
type="rect",
@@ -980,23 +992,38 @@ fig.show()
980992

981993
*New in 5.15*
982994

983-
Use `texttemplate` to add text with variables to new shapes drawn on the graph. This example figure is configured to allow the user to draw lines and automatically labels each line with its slope. Select **Draw line** in the modebar to try it out.
995+
You can also use `texttemplate` to add text with variables to new shapes drawn on the graph.
996+
997+
In this example, we enable drawing lines on the figure by adding `drawline` to `modeBarButtonsToAdd` in `config`. We then define a `texttemplate` for shapes that shows the calculated variable `dy`. Select **Draw line** in the modebar to try it out.
984998

985999
```python
9861000
import plotly.graph_objects as go
1001+
from plotly import data
1002+
1003+
df = data.stocks()
9871004

9881005
fig = go.Figure(
989-
layout=go.Layout(newshape=dict(label=dict(texttemplate="Slope: %{slope:.3f}")))
1006+
data=go.Scatter(
1007+
x=df.date,
1008+
y=df.GOOG,
1009+
),
1010+
layout=go.Layout(
1011+
yaxis=dict(title="Price in USD"),
1012+
newshape=dict(
1013+
label=dict(texttemplate="Change: %{dy:.2f}")
1014+
),
1015+
title="Google Share Price 2018/2019",
1016+
),
9901017
)
9911018

1019+
9921020
fig.show(
9931021
config={
9941022
"modeBarButtonsToAdd": [
9951023
"drawline",
9961024
]
9971025
}
9981026
)
999-
10001027
```
10011028

10021029
### Reference

0 commit comments

Comments
 (0)