graphinglib.SmartFigureWCS.set_visual_params

SmartFigureWCS.set_visual_params(reset: bool = False, figure_face_color: str | None = None, axes_face_color: str | None = None, axes_edge_color: str | None = None, x_axis_label_color: str | None = None, y_axis_label_color: str | None = None, axes_label_pad: float | None = None, axes_line_width: float | None = None, color_cycle: list[str] | None = None, legend_face_color: str | None = None, legend_edge_color: str | None = None, legend_font_size: float | None = None, legend_handle_length: float | None = None, legend_handle_text_pad: float | None = None, font_family: str | None = None, font_size: float | None = None, font_weight: str | None = None, title_font_size: float | None = None, title_font_weight: str | None = None, text_color: str | None = None, use_latex: bool | None = None, hidden_spines: Iterable[Literal['right', 'left', 'top', 'bottom']] | None = None) → Self

Customize the visual style of the SmartFigure.

Any parameter that is not specified (None) will be set to the default value for the specified figure_style.

Parameters:

resetbool, optional

If True, resets all previously set visual parameters to their default values for the specified figure_style before applying the new parameters. Defaults to False.

figure_face_colorstr, optional

The color of the figure face.

axes_face_colorstr, optional

The color of the axes face.

axes_edge_colorstr, optional

The color of the axes edge.

x_axis_label_colorstr, optional

The color of the x axis label.

y_axis_label_colorstr, optional

The color of the y axis label.

axes_label_padfloat, optional

The padding between the axes labels and the axes. Typical range is 2 to 12.

axes_line_widthfloat, optional

The width of the axes lines. Typical range is 0.5 to 3.

color_cyclelist[str], optional

A list of colors to use for the color cycle.

legend_face_colorstr, optional

The color of the legend face.

legend_edge_colorstr, optional

The color of the legend edge.

legend_font_sizefloat, optional

The font size of the legend. Typical range is 8 to 20.

legend_handle_lengthfloat, optional

The length of the legend handles. Typical range is 1 to 4.

legend_handle_text_padfloat, optional

The padding between the legend handles and the legend text. Typical range is 0.2 to 1.5.

font_familystr, optional

The font family to use.

font_sizefloat, optional

The font size to use. Typical range is 8 to 20.

font_weightstr, optional

The font weight to use. Values include "normal", "bold", "light", "ultralight", "heavy", and "black".

title_font_sizefloat, optional

The font size of the title. Typical range is 10 to 24.

title_font_weightstr, optional

The font weight of the title. Values include "normal", "bold", "light", "ultralight", "heavy", and "black".

text_colorstr, optional

The color of the text.

use_latexbool, optional

Whether or not to use latex.

hidden_spinesIterable[Literal[“right”, “left”, “top”, “bottom”]], optional

The spines to hide. If specified, the corresponding spines will be hidden in the figure. This corresponds to the lines that form the borders of the plot. Values are "right", "left", "top", and "bottom".

Returns:

Self

For convenience, the same SmartFigure with the updated visual parameters.

Notes

Color parameters accept Matplotlib color formats: named colors ("blue"), short color strings ("b"), hex strings ("#0000ff"), grayscale strings ("0.5"), and RGB/RGBA tuples with values between 0 and 1 ((0, 0, 1) or (0, 0, 1, 0.5)).