plotly / plotly/plotly.py

Title moves off-page when adding new line with `<br>`

Ouverte
#4,309 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

bug P3
Langage dominant
Python
Étoiles
18.8k
Forks
2.8k
Merge moyen
16 h 26 min
PR mergées (30 j)
21

Description

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()

plot1

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()

plot2

It will even have the same problem when I leave the margins as their default values.

fig3 = fig2.update_layout(margin=None)
fig3.show()

plot3

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()

plot4

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))

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par le script Python complet et reproductible de l’issue, en particulier les appels à update_layout de fig1–fig4 et les fichiers joints plot1_schema.json.txt à plot4_schema.json.txt. Comparez le comportement et les schémas des titres sur une seule ligne et sur plusieurs lignes ; le travail est considéré comme terminé lorsqu’un titre sur deux lignes reste entièrement visible lorsqu’il est ancré en haut du conteneur.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
data-visualization
Type d'issue
Bug
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.