matplotlib.pyplot.suptitle — Matplotlib 3.10.1 documentation (original) (raw)
matplotlib.pyplot.suptitle(t, **kwargs)[source]#
Add a centered super title to the figure.
Parameters:
tstr
The super title text.
xfloat, default: 0.5
The x location of the text in figure coordinates.
yfloat, default: 0.98
The y location of the text in figure coordinates.
horizontalalignment, ha{'center', 'left', 'right'}, default: center
The horizontal alignment of the text relative to (x, y).
verticalalignment, va{'top', 'center', 'bottom', 'baseline'}, default: top
The vertical alignment of the text relative to (x, y).
fontsize, sizedefault: [rcParams["figure.titlesize"]](../../users/explain/customizing.html?highlight=figure.titlesize#matplotlibrc-sample) (default: 'large')
The font size of the text. See Text.set_size for possible values.
fontweight, weightdefault: [rcParams["figure.titleweight"]](../../users/explain/customizing.html?highlight=figure.titleweight#matplotlibrc-sample) (default: 'normal')
The font weight of the text. See Text.set_weight for possible values.
Returns:
text
The Text instance of the super title.
Other Parameters:
fontpropertiesNone or dict, optional
A dict of font properties. If fontproperties is given the default values for font size and weight are taken from theFontProperties defaults. [rcParams["figure.titlesize"]](../../users/explain/customizing.html?highlight=figure.titlesize#matplotlibrc-sample) (default: 'large') and[rcParams["figure.titleweight"]](../../users/explain/customizing.html?highlight=figure.titleweight#matplotlibrc-sample) (default: 'normal') are ignored in this case.
**kwargs
Additional kwargs are matplotlib.text.Text properties.
Notes