matplotlib.figure.SubFigure.supxlabel#

SubFigure.supxlabel(t, **kwargs)[source]#

Add a centered super xlabel to the figure.

Parameters:

tstr

The super xlabel text.

xfloat, default: 0.5

The x location of the text in figure coordinates.

yfloat, default: 0.01

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: bottom

The vertical alignment of the text relative to (x, y).

fontsize, sizedefault: rcParams["figure.labelsize"] (default: 'large')

The font size of the text. See Text.set_size for possible values.

fontweight, weightdefault: rcParams["figure.labelweight"] (default: 'normal')

The font weight of the text. See Text.set_weight for possible values.

Returns:

text

The Text instance of the super xlabel.

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. rcParams["figure.labelsize"] (default: 'large') and rcParams["figure.labelweight"] (default: 'normal') are ignored in this case.

**kwargs

Additional kwargs are matplotlib.text.Text properties.