gsplot.Theme#

class Theme(*, figure_facecolor=None, axes_facecolor=None, text_color=None, spine_color=None, tick_color=None, grid=None, grid_color=None, grid_alpha=None)#

Bases: object

Immutable explicit Figure/Axes appearance values.

Parameters:

  • figure_facecolor (str | tuple[float, float, float] | tuple[float, float, float, float] | None) – Optional Figure and Axes patch colors.

  • axes_facecolor (str | tuple[float, float, float] | tuple[float, float, float, float] | None) – Optional Figure and Axes patch colors.

  • text_color (str | tuple[float, float, float] | tuple[float, float, float, float] | None) – Optional explicit artist colors.

  • spine_color (str | tuple[float, float, float] | tuple[float, float, float, float] | None) – Optional explicit artist colors.

  • tick_color (str | tuple[float, float, float] | tuple[float, float, float, float] | None) – Optional explicit artist colors.

  • grid (bool | None) – Optional grid visibility flag.

  • grid_color (str | tuple[float, float, float] | tuple[float, float, float, float] | None) – Optional grid color and alpha in the unit interval.

  • grid_alpha (float | None) – Optional grid color and alpha in the unit interval.

Notes

Instances are frozen, validate all colors, and never modify global Matplotlib rcParams. Use gsplot.set_theme() on an explicit Figure or Axes.

Examples

>>> import gsplot as gs
>>> theme = gs.Theme(axes_facecolor="white", grid=True)
>>> theme.grid
True
__init__(*, figure_facecolor=None, axes_facecolor=None, text_color=None, spine_color=None, tick_color=None, grid=None, grid_color=None, grid_alpha=None)#
Parameters:

  • figure_facecolor (str | tuple[float, float, float] | tuple[float, float, float, float] | None)

  • axes_facecolor (str | tuple[float, float, float] | tuple[float, float, float, float] | None)

  • text_color (str | tuple[float, float, float] | tuple[float, float, float, float] | None)

  • spine_color (str | tuple[float, float, float] | tuple[float, float, float, float] | None)

  • tick_color (str | tuple[float, float, float] | tuple[float, float, float, float] | None)

  • grid (bool | None)

  • grid_color (str | tuple[float, float, float] | tuple[float, float, float, float] | None)

  • grid_alpha (float | None)

Return type:

None

Methods

__init_subclass__

This method is called when a class is subclassed.

__new__(**kwargs)

__subclasshook__

Abstract classes can override this to customize issubclass().