You are reading an old version of the documentation (v2.1.1). For the latest version see https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.suptitle.html
matplotlib
Fork me on GitHub


Travis-CI:

Table Of Contents

This Page

matplotlib.pyplot.suptitle

matplotlib.pyplot.suptitle(*args, **kwargs)

Add a centered title to the figure.

kwargs are matplotlib.text.Text properties. Using figure coordinates, the defaults are:

x : 0.5
The x location of the text in figure coords
y : 0.98
The y location of the text in figure coords
horizontalalignment : ‘center’
The horizontal alignment of the text
verticalalignment : ‘top’
The vertical alignment of the text

If the fontproperties keyword argument is given then the rcParams defaults for fontsize (figure.titlesize) and fontweight (figure.titleweight) will be ignored in favour of the FontProperties defaults.

A matplotlib.text.Text instance is returned.

Example:

fig.suptitle('this is the figure title', fontsize=12)

Examples using matplotlib.pyplot.suptitle