Skip to content

DOC: Improve multiline example #31708

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
timhoffm wants to merge 1 commit into
base: main
Choose a base branch
from
+54 −30
Open

DOC: Improve multiline example #31708

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 54 additions & 30 deletions galleries/examples/text_labels_and_annotations/multiline.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,45 +1,69 @@
"""
=========
Multiline
=========
==============
Multiline text
==============

Texts may contain newlines to create multiline text.

The text alignment of the individual lines can be controlled by the
``multialignment`` parameter. If not set, the alignment of the lines is inferred from
the ``horizontalalignment`` and ``verticalalignment`` parameters, which primarily
control the alignment of the bounding box of the text to its anchor point; e.g. if the
text has the anchor point to its right, all text lines will be aligned to the right
so that they pick up that anchor point.

When using mutli-line labels, it is recommended to use a layout manager (e.g.
``layout="constrained"``) to ensure that there is enough space for the labels..
"""
import matplotlib.pyplot as plt
import numpy as np

fig, (ax0, ax1) = plt.subplots(ncols=2, figsize=(7, 4))
fig, ax = plt.subplots(layout="constrained")

ax.bar(range(6), [0.3, 0.5, 0.8, 1.5, 2.5, 8], alpha=0.3)

ax.set_ylabel('labels are centered,\nso is their multi-line text by default')
ax.set_xlabel('xlabel with\nmultialignment="left"', multialignment="left")

ax0.set_aspect(1)
ax0.plot(np.arange(10))
ax0.set_xlabel('this is an xlabel\n(with newlines!)')
ax0.set_ylabel('this is vertical\ntest', multialignment='center')
ax0.text(2, 7, 'this is\nyet another test',
rotation=45,
horizontalalignment='center',
verticalalignment='top',
multialignment='center')
ax.text(
4.5, 6,
'these lines\n'
'are right aligned\n'
'because of horizontalalignment',
horizontalalignment='right',
)

ax.text(
4.5, 4,
'but\n'
'we can override this\n'
'with an explicit multialingment="left"',
horizontalalignment='right',
multialignment='left',
)

plt.show()

ax0.grid()

# %%
# Each line has the same height irrespective of the used characters unless
# there is math text involved, which may need more vertical space

ax1.text(0.29, 0.4, "Mat\nTTp\n123", size=18,
va="baseline", ha="right", multialignment="left",
bbox=dict(fc="none"))
fig, ax = plt.subplots()

ax1.text(0.34, 0.4, "Mag\nTTT\n123", size=18,
va="baseline", ha="left", multialignment="left",
bbox=dict(fc="none"))
ax.text(0.1, 0.4, "Mat\nTTp\n123", size=18,
va="baseline", bbox=dict(fc="none", ec="tab:orange"))

ax1.text(0.95, 0.4, "Mag\nTTT$^{A^A}$\n123", size=18,
va="baseline", ha="right", multialignment="left",
bbox=dict(fc="none"))
ax.text(0.3, 0.4, "Mag\nTTT\n123", size=18,
va="baseline", bbox=dict(fc="none", ec="tab:orange"))

ax1.set_xticks([0.2, 0.4, 0.6, 0.8, 1.],
labels=["Jan\n2009", "Feb\n2009", "Mar\n2009", "Apr\n2009",
"May\n2009"])
ax.text(0.5, 0.4, "Mag\nTTT$^{A^A}$\n123", size=18,
va="baseline", bbox=dict(fc="none", ec="tab:orange"))

ax1.axhline(0.4)
ax1.set_title("test line spacing for multiline text")
ax.axhline(0.4)
ax.set_title("test line spacing for multiline text")
ax.set_xlim(0, 0.7)
ax.yaxis.minorticks_on()
ax.yaxis.set_tick_params(which="minor", grid_color="0.9")
ax.grid(which="both")

fig.subplots_adjust(bottom=0.25, top=0.75)
plt.show()
Loading