Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit 87e5a39

Browse files
authored
Merge pull request #4830 from plotly/add-subtitle-to-px
Add subtitle attribute to Plotly Express figures
2 parents 31b3ad8 + fb0b5fc commit 87e5a39

File tree

4 files changed

+43
-0
lines changed

4 files changed

+43
-0
lines changed

‎CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
99
### Updated
1010

1111
- Updated plotly.py to use base64 encoding of arrays in plotly JSON to improve performance.
12+
- Add `subtitle` attribute to all Plotly Express traces
1213

1314
## [5.24.1] - 2024年09月12日
1415

‎packages/python/plotly/plotly/express/_chart_types.py‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ def scatter(
5555
range_y=None,
5656
render_mode="auto",
5757
title=None,
58+
subtitle=None,
5859
template=None,
5960
width=None,
6061
height=None,
@@ -105,6 +106,7 @@ def density_contour(
105106
nbinsy=None,
106107
text_auto=False,
107108
title=None,
109+
subtitle=None,
108110
template=None,
109111
width=None,
110112
height=None,
@@ -175,6 +177,7 @@ def density_heatmap(
175177
nbinsy=None,
176178
text_auto=False,
177179
title=None,
180+
subtitle=None,
178181
template=None,
179182
width=None,
180183
height=None,
@@ -253,6 +256,7 @@ def line(
253256
line_shape=None,
254257
render_mode="auto",
255258
title=None,
259+
subtitle=None,
256260
template=None,
257261
width=None,
258262
height=None,
@@ -303,6 +307,7 @@ def area(
303307
range_y=None,
304308
line_shape=None,
305309
title=None,
310+
subtitle=None,
306311
template=None,
307312
width=None,
308313
height=None,
@@ -362,6 +367,7 @@ def bar(
362367
range_y=None,
363368
text_auto=False,
364369
title=None,
370+
subtitle=None,
365371
template=None,
366372
width=None,
367373
height=None,
@@ -412,6 +418,7 @@ def timeline(
412418
range_x=None,
413419
range_y=None,
414420
title=None,
421+
subtitle=None,
415422
template=None,
416423
width=None,
417424
height=None,
@@ -467,6 +474,7 @@ def histogram(
467474
nbins=None,
468475
text_auto=False,
469476
title=None,
477+
subtitle=None,
470478
template=None,
471479
width=None,
472480
height=None,
@@ -541,6 +549,7 @@ def ecdf(
541549
range_x=None,
542550
range_y=None,
543551
title=None,
552+
subtitle=None,
544553
template=None,
545554
width=None,
546555
height=None,
@@ -597,6 +606,7 @@ def violin(
597606
points=None,
598607
box=False,
599608
title=None,
609+
subtitle=None,
600610
template=None,
601611
width=None,
602612
height=None,
@@ -650,6 +660,7 @@ def box(
650660
points=None,
651661
notched=False,
652662
title=None,
663+
subtitle=None,
653664
template=None,
654665
width=None,
655666
height=None,
@@ -700,6 +711,7 @@ def strip(
700711
range_x=None,
701712
range_y=None,
702713
title=None,
714+
subtitle=None,
703715
template=None,
704716
width=None,
705717
height=None,
@@ -765,6 +777,7 @@ def scatter_3d(
765777
range_y=None,
766778
range_z=None,
767779
title=None,
780+
subtitle=None,
768781
template=None,
769782
width=None,
770783
height=None,
@@ -816,6 +829,7 @@ def line_3d(
816829
range_y=None,
817830
range_z=None,
818831
title=None,
832+
subtitle=None,
819833
template=None,
820834
width=None,
821835
height=None,
@@ -856,6 +870,7 @@ def scatter_ternary(
856870
opacity=None,
857871
size_max=None,
858872
title=None,
873+
subtitle=None,
859874
template=None,
860875
width=None,
861876
height=None,
@@ -896,6 +911,7 @@ def line_ternary(
896911
markers=False,
897912
line_shape=None,
898913
title=None,
914+
subtitle=None,
899915
template=None,
900916
width=None,
901917
height=None,
@@ -941,6 +957,7 @@ def scatter_polar(
941957
log_r=False,
942958
render_mode="auto",
943959
title=None,
960+
subtitle=None,
944961
template=None,
945962
width=None,
946963
height=None,
@@ -987,6 +1004,7 @@ def line_polar(
9871004
range_theta=None,
9881005
log_r=False,
9891006
title=None,
1007+
subtitle=None,
9901008
template=None,
9911009
width=None,
9921010
height=None,
@@ -1030,6 +1048,7 @@ def bar_polar(
10301048
range_theta=None,
10311049
log_r=False,
10321050
title=None,
1051+
subtitle=None,
10331052
template=None,
10341053
width=None,
10351054
height=None,
@@ -1080,6 +1099,7 @@ def choropleth(
10801099
fitbounds=None,
10811100
basemap_visible=None,
10821101
title=None,
1102+
subtitle=None,
10831103
template=None,
10841104
width=None,
10851105
height=None,
@@ -1137,6 +1157,7 @@ def scatter_geo(
11371157
fitbounds=None,
11381158
basemap_visible=None,
11391159
title=None,
1160+
subtitle=None,
11401161
template=None,
11411162
width=None,
11421163
height=None,
@@ -1193,6 +1214,7 @@ def line_geo(
11931214
fitbounds=None,
11941215
basemap_visible=None,
11951216
title=None,
1217+
subtitle=None,
11961218
template=None,
11971219
width=None,
11981220
height=None,
@@ -1236,6 +1258,7 @@ def scatter_map(
12361258
center=None,
12371259
map_style=None,
12381260
title=None,
1261+
subtitle=None,
12391262
template=None,
12401263
width=None,
12411264
height=None,
@@ -1273,6 +1296,7 @@ def choropleth_map(
12731296
center=None,
12741297
map_style=None,
12751298
title=None,
1299+
subtitle=None,
12761300
template=None,
12771301
width=None,
12781302
height=None,
@@ -1308,6 +1332,7 @@ def density_map(
13081332
map_style=None,
13091333
radius=None,
13101334
title=None,
1335+
subtitle=None,
13111336
template=None,
13121337
width=None,
13131338
height=None,
@@ -1344,6 +1369,7 @@ def line_map(
13441369
center=None,
13451370
map_style=None,
13461371
title=None,
1372+
subtitle=None,
13471373
template=None,
13481374
width=None,
13491375
height=None,
@@ -1383,6 +1409,7 @@ def scatter_mapbox(
13831409
center=None,
13841410
mapbox_style=None,
13851411
title=None,
1412+
subtitle=None,
13861413
template=None,
13871414
width=None,
13881415
height=None,
@@ -1420,6 +1447,7 @@ def choropleth_mapbox(
14201447
center=None,
14211448
mapbox_style=None,
14221449
title=None,
1450+
subtitle=None,
14231451
template=None,
14241452
width=None,
14251453
height=None,
@@ -1455,6 +1483,7 @@ def density_mapbox(
14551483
mapbox_style=None,
14561484
radius=None,
14571485
title=None,
1486+
subtitle=None,
14581487
template=None,
14591488
width=None,
14601489
height=None,
@@ -1491,6 +1520,7 @@ def line_mapbox(
14911520
center=None,
14921521
mapbox_style=None,
14931522
title=None,
1523+
subtitle=None,
14941524
template=None,
14951525
width=None,
14961526
height=None,
@@ -1526,6 +1556,7 @@ def scatter_matrix(
15261556
opacity=None,
15271557
size_max=None,
15281558
title=None,
1559+
subtitle=None,
15291560
template=None,
15301561
width=None,
15311562
height=None,
@@ -1553,6 +1584,7 @@ def parallel_coordinates(
15531584
range_color=None,
15541585
color_continuous_midpoint=None,
15551586
title=None,
1587+
subtitle=None,
15561588
template=None,
15571589
width=None,
15581590
height=None,
@@ -1577,6 +1609,7 @@ def parallel_categories(
15771609
range_color=None,
15781610
color_continuous_midpoint=None,
15791611
title=None,
1612+
subtitle=None,
15801613
template=None,
15811614
width=None,
15821615
height=None,
@@ -1612,6 +1645,7 @@ def pie(
16121645
category_orders=None,
16131646
labels=None,
16141647
title=None,
1648+
subtitle=None,
16151649
template=None,
16161650
width=None,
16171651
height=None,
@@ -1664,6 +1698,7 @@ def sunburst(
16641698
custom_data=None,
16651699
labels=None,
16661700
title=None,
1701+
subtitle=None,
16671702
template=None,
16681703
width=None,
16691704
height=None,
@@ -1714,6 +1749,7 @@ def treemap(
17141749
custom_data=None,
17151750
labels=None,
17161751
title=None,
1752+
subtitle=None,
17171753
template=None,
17181754
width=None,
17191755
height=None,
@@ -1764,6 +1800,7 @@ def icicle(
17641800
custom_data=None,
17651801
labels=None,
17661802
title=None,
1803+
subtitle=None,
17671804
template=None,
17681805
width=None,
17691806
height=None,
@@ -1823,6 +1860,7 @@ def funnel(
18231860
range_x=None,
18241861
range_y=None,
18251862
title=None,
1863+
subtitle=None,
18261864
template=None,
18271865
width=None,
18281866
height=None,
@@ -1849,6 +1887,7 @@ def funnel_area(
18491887
custom_data=None,
18501888
labels=None,
18511889
title=None,
1890+
subtitle=None,
18521891
template=None,
18531892
width=None,
18541893
height=None,

‎packages/python/plotly/plotly/express/_core.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2340,6 +2340,8 @@ def make_figure(args, constructor, trace_patch=None, layout_patch=None):
23402340
layout_patch["title_text"] = args["title"]
23412341
elif args["template"].layout.margin.t is None:
23422342
layout_patch["margin"] = {"t": 60}
2343+
if args["subtitle"]:
2344+
layout_patch["title_subtitle_text"] = args["subtitle"]
23432345
if (
23442346
"size" in args
23452347
and args["size"]

‎packages/python/plotly/plotly/express/_doc.py‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -371,6 +371,7 @@
371371
"If provided, overrides auto-scaling on the angular axis in polar coordinates.",
372372
],
373373
title=["str", "The figure title."],
374+
subtitle=["str", "The figure subtitle."],
374375
template=[
375376
"str or dict or plotly.graph_objects.layout.Template instance",
376377
"The figure template name (must be a key in plotly.io.templates) or definition.",

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /