smpl.plot.suptitle¶
- smpl.plot.suptitle(t, **kwargs)[source]¶
Add a centered suptitle to the figure.
Parameters¶
- tstr
The suptitle 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: :rc:`figure.titlesize`
The font size of the text. See .Text.set_size for possible values.
- fontweight, weightdefault: :rc:`figure.titleweight`
The font weight of the text. See .Text.set_weight for possible values.
Returns¶
- text
The .Text instance of the suptitle.
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 the .FontProperties defaults. :rc:`figure.titlesize` and :rc:`figure.titleweight` are ignored in this case.
- **kwargs
Additional kwargs are matplotlib.text.Text properties.