Classe « FigureBase »

Méthode matplotlib.figure.FigureBase.supxlabel

Signature de la méthode supxlabel

def supxlabel(self, t, **kwargs) 

Description

supxlabel.__doc__

Add a centered supxlabel to the figure.

Parameters
----------
t : str
    The supxlabel text.
x : float, default: 0.5
    The x location of the text in figure coordinates.
y : float, 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, size : default: :rc:`figure.titlesize`
    The font size of the text. See `.Text.set_size` for possible
    values.
fontweight, weight : default: :rc:`figure.titleweight`
    The font weight of the text. See `.Text.set_weight` for possible
    values.

Returns
-------
text
    The `.Text` instance of the supxlabel.

Other Parameters
----------------
fontproperties : None 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.