graphinglib.SmartFigureWCS.set_text_padding_params

SmartFigureWCS.set_text_padding_params(reset: bool = False, x_label_pad: float | None = None, y_label_pad: float | None = None, title_pad: float | None = None, sub_x_labels_pad: Iterable[float] | None = None, sub_y_labels_pad: Iterable[float] | None = None, subtitles_pad: Iterable[float] | None = None) → Self

Sets the padding parameters for the figure’s text elements. These parameters are used to set the padding between the axes and the labels and titles.

Parameters:

resetbool, optional

If True, resets all previously set text padding parameters to their default values before applying the new parameters. Defaults to False.

x_label_pad, y_label_padfloat, optional

Padding between the main x-axis or y-axis label and the respective axis.

title_padfloat, optional

Padding between the main title and the top of the axes.

sub_x_labels_pad, sub_y_labels_padIterable[float], optional

Padding for each subfigure’s x-axis and y-axis labels.

subtitles_padIterable[float], optional

Padding for each subfigure’s subtitle.

Returns:

Self

For convenience, the same SmartFigure with the updated text padding parameters.