Title moves off-page when adding new line with `<br>`
还没有人认领这个 Issue。
- 主要语言
- Python
- 星标
- 18.8k
- 派生
- 2.8k
- 平均合并
- 16 小时 26 分钟
- 30 天内合并 PR
- 21
描述
Description
When I am plotting normally, sometimes I want to add a new line to the title, and use that as a sub-title. When I do this, it will move the first line of my title up and off the page. This occurs even when I set title_y=1 and title_yref="container" and title_yanchor="top".
Reproducible Example
First, let's define the default plot.
from plotly import express as px
data = px.data.stocks(indexed=True, datetimes=True)
fig = (
px.line()
.add_scatter(
name="Google",
x=data.index,
y=data["GOOG"],
showlegend=True,
)
.add_scatter(
name="Amazon",
x=data.index,
y=data["AMZN"],
showlegend=True,
)
.add_scatter(
name="Netflix",
x=data.index,
y=data["NFLX"],
showlegend=True,
)
)
When I run this with a title with only 1 line, it looks good:
fig1 = fig.update_layout(
margin={"t": 40, "b": 10, "l": 10, "r": 10},
title=dict(
text="<b>Stock Prices</b>",
x=0.5,
xref="container",
xanchor="center",
y=0.99,
yref="container",
yanchor="top",
),
xaxis_title="Date",
yaxis_title="Values",
legend_title="Stock",
)
fig1.show()
However, when I change only the title to add a second line, it will push the top of the title off the page.
fig2 = fig1.update_layout(title_text="<b>Stock Prices</b><br>For years 2018-2019")
fig2.show()
It will even have the same problem when I leave the margins as their default values.
fig3 = fig2.update_layout(margin=None)
fig3.show()
If I manually move the title downwards, it will resolve the issue. However, that is not the point here. Because the title should already be anchored to the top of the container at y level 0.99. I shouldn't need to manually move it downwards even more when I add a new line to the title.
fig4 = fig2.update_layout(
margin={"t": 40, "b": 10, "l": 10, "r": 10},
title_y=0.9,
)
fig4.show()
Conclusion
Something whacky is happening to the title whenever we set it to run with two lines. Even if we lock it to the top and with the reference to the container, it will still somehow be overwritten.
Please help to fix it.
Additional information
I include the schema files for each plot:
plot1_schema.json.txt
plot2_schema.json.txt
plot3_schema.json.txt
plot4_schema.json.txt
And the full script for entirely reproducible example:
Expand for full script
# Import
from plotly import express as px
import json
# Data
data = px.data.stocks(indexed=True, datetimes=True)
# Default figure
fig = (
px.line()
.add_scatter(
name="Google",
x=data.index,
y=data["GOOG"],
showlegend=True,
)
.add_scatter(
name="Amazon",
x=data.index,
y=data["AMZN"],
showlegend=True,
)
.add_scatter(
name="Netflix",
x=data.index,
y=data["NFLX"],
showlegend=True,
)
)
# Figure 1: Works well
fig1 = fig.update_layout(
margin={"t": 40, "b": 10, "l": 10, "r": 10},
title=dict(
text="<b>Stock Prices</b>",
x=0.5,
xref="container",
xanchor="center",
y=0.99,
yref="container",
yanchor="top",
),
xaxis_title="Date",
yaxis_title="Values",
legend_title="Stock",
)
fig1.show()
fig1.write_image("plot1.png", engine="kaleido")
with open("plot1_schema.json.txt", "wt") as f:
f.write(json.dumps(fig1.layout.to_plotly_json(), indent=2))
# Figure 2: Title off page
fig2 = fig1.update_layout(title_text="<b>Stock Prices</b><br>For years 2018-2019")
fig2.show()
fig2.write_image("plot2.png", engine="kaleido")
with open("plot2_schema.json.txt", "wt") as f:
f.write(json.dumps(fig2.layout.to_plotly_json(), indent=2))
# Figure 3: Even works with margins are default
fig3 = fig2.update_layout(margin=None)
fig3.show()
fig3.write_image("plot3.png", engine="kaleido")
with open("plot3_schema.json.txt", "wt") as f:
f.write(json.dumps(fig3.layout.to_plotly_json(), indent=2))
# Figure 4: Works if you manually move the title down; but that's not the point. It should be anchored to the top of the `container` already.
fig4 = fig2.update_layout(
margin={"t": 40, "b": 10, "l": 10, "r": 10},
title_y=0.9,
)
fig4.show()
fig4.write_image("plot4.png", engine="kaleido")
with open("plot4_schema.json.txt", "wt") as f:
f.write(json.dumps(fig4.layout.to_plotly_json(), indent=2))
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
从 issue 中完整且可复现的 Python 脚本开始,尤其关注 fig1–fig4 的 update_layout 调用以及随附的 plot1_schema.json.txt 至 plot4_schema.json.txt 文件。比较单行标题和多行标题的行为与 schema;当两行标题锚定在容器顶部时仍能完全显示,即视为完成。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- python
- 领域
- data-visualization
- Issue 类型
- 缺陷
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 35/100