Configuration Classes#

Reusable parameter objects for plot styling and behavior.

LinePlotConfig#

class plotez.LinePlotConfig(color=None, linewidth=None, linestyle=None, alpha=None, marker=None, markersize=None, markerfacecolor=None, markeredgecolor=None, markeredgewidth=None, _extra=<factory>)[source]#

Bases: object

Configuration class for line plots.

Parameters:
__repr__()[source]#

Pretty repr showing both explicit and extra params.

get_dict()[source]#

Get all parameters as dict for matplotlib.

Return type:

dict[str, Any]

classmethod populate(dictionary)[source]#

Create a LinePlotConfig instance from a dictionary, using a mapping for shorthand keys.

Parameters:

dictionary (dict[str, Any])

Return type:

LinePlotConfig

alpha: float | list[float] | None = None#
color: str | list[str] | None = None#
linestyle: str | list[str] | None = None#
linewidth: float | list[float] | None = None#
marker: str | list[str] | None = None#
markeredgecolor: str | list[str] | None = None#
markeredgewidth: float | list[float] | None = None#
markerfacecolor: str | list[str] | None = None#
markersize: float | list[float] | None = None#

ErrorPlotConfig#

class plotez.ErrorPlotConfig(color=None, linewidth=None, linestyle=None, alpha=None, ecolor=None, elinewidth=None, marker=None, markersize=None, markerfacecolor=None, markeredgecolor=None, capsize=None, capthick=None, errorevery=None, _extra=<factory>)[source]#

Bases: object

Configuration class for error bar plots.

Parameters:

  • color (str | None)

  • linewidth (float | None)

  • linestyle (str | None)

  • alpha (float | None)

  • ecolor (str | None)

  • elinewidth (float | None)

  • marker (str | None)

  • markersize (float | None)

  • markerfacecolor (str | None)

  • markeredgecolor (str | None)

  • capsize (float | None)

  • capthick (float | None)

  • errorevery (int | tuple | None)

  • _extra (dict[str, Any])

__repr__()[source]#

Pretty repr showing both explicit and extra params.

get_dict()[source]#

Get all parameters as dict for matplotlib.

Return type:

dict[str, Any]

classmethod populate(dictionary)[source]#

Create an ErrorPlotConfig instance from a dictionary, using a mapping for shorthand keys.

Parameters:

dictionary (dict[str, Any])

Return type:

ErrorPlotConfig

alpha: float | None = None#
capsize: float | None = None#
capthick: float | None = None#
color: str | None = None#
ecolor: str | None = None#
elinewidth: float | None = None#
errorevery: int | tuple | None = None#
linestyle: str | None = None#
linewidth: float | None = None#
marker: str | None = None#
markeredgecolor: str | None = None#
markerfacecolor: str | None = None#
markersize: float | None = None#

ErrorBandConfig#

class plotez.ErrorBandConfig(color=None, alpha=0.25, linewidth=None, edgecolor=None, linestyle=None, hatch=None, interpolate=None, step=None, _extra=<factory>)[source]#

Bases: object

Configuration class for error bands (shaded fill regions).

Parameters:
__repr__()[source]#

Return a string representation of the ErrorBandConfig instance.

get_dict()[source]#

Get all parameters as dict for matplotlib.

Return type:

dict[str, Any]

classmethod populate(dictionary)[source]#

Create an ErrorBandConfig instance from a dictionary, using a mapping for shorthand keys.

Parameters:

dictionary (dict[str, Any])

Return type:

ErrorBandConfig

alpha: float | list[float] = 0.25#
color: str | list[str] | None = None#
edgecolor: str | list[str] | None = None#
hatch: Literal['/', '\\', '|', '-', '+', 'x', 'o', 'O', '.', '*'] | list[Literal['/', '\\', '|', '-', '+', 'x', 'o', 'O', '.', '*']] | None = None#
interpolate: bool | None = None#
linestyle: str | list[str] | None = None#
linewidth: float | list[float] | None = None#
step: str | Literal['pre', 'post', 'mid'] | None = None#

ScatterPlotConfig#

class plotez.ScatterPlotConfig(color=None, s=None, alpha=None, marker=None, cmap=None, edgecolors=None, facecolors=None, _extra=<factory>)[source]#

Bases: object

Configuration class for scatter plots.

Parameters:
__repr__()[source]#

Pretty repr showing both explicit and extra params.

get_dict()[source]#

Get all parameters as dict for matplotlib.

Return type:

dict[str, Any]

classmethod populate(dictionary)[source]#

Create a ScatterPlotConfig instance from a dictionary, using a mapping for shorthand keys.

Parameters:

dictionary (dict[str, Any])

Return type:

ScatterPlotConfig

alpha: float | list[float] | None = None#
cmap: str | list[str] | None = None#
color: str | list[str] | None = None#
edgecolors: str | list[str] | None = None#
facecolors: str | list[str] | None = None#
marker: str | list[str] | None = None#
s: float | list[float] | None = None#

HistogramConfig#

class plotez.HistogramConfig(bins=None, density=None, histtype=None, color=None, alpha=None, edgecolor=None, facecolor=None, linewidth=None, orientation=None, cumulative=None, hatch=None, _extra=<factory>)[source]#

Bases: object

Configuration class for histogram plots.

Parameters:

  • bins (int | None)

  • density (bool | None)

  • histtype (str | None)

  • color (str | None)

  • alpha (float | None)

  • edgecolor (str | None)

  • facecolor (str | None)

  • linewidth (float | None)

  • orientation (str | None)

  • cumulative (bool | None)

  • hatch (Literal['/', '\\', '|', '-', '+', 'x', 'o', 'O', '.', '*'] | None)

  • _extra (dict[str, Any])

__repr__()[source]#

Pretty repr showing both explicit and extra params.

get_dict()[source]#

Get all parameters are dict for matplotlib.

Return type:

dict[str, Any]

classmethod populate(dictionary)[source]#

Create a HistogramConfig instance from a dictionary, using a mapping for shorthand keys.

Parameters:

dictionary (dict[str, Any])

alpha: float | None = None#
bins: int | None = None#
color: str | None = None#
cumulative: bool | None = None#
density: bool | None = None#
edgecolor: str | None = None#
facecolor: str | None = None#
hatch: Literal['/', '\\', '|', '-', '+', 'x', 'o', 'O', '.', '*'] | None = None#
histtype: str | None = None#
linewidth: float | None = None#
orientation: str | None = None#
On this page
Show Source