vispipe.plot_backend.MPL_Figure.set_xlabel#

MPL_Figure.set_xlabel(xlabel, labelpad=None, *, loc=None, ax=None, **kwargs)#

Sets the label of the xaxis.

Parameters:
  • xlabel (str | None) – The label that will be placed on the xaxis.

  • labelpad (float | None) – The padding in points of the label from the xaxis.

  • loc (str | None) – The position of the label.

  • ax (Axes | None) – Axes to plot onto. If None self.gca() is called.

  • **kwargs – Keyword arguments used by ax.set_xlabel().

Return type:

Text

Returns:

A matplotlib.text.Text object.