Wrappers and Shorthand Keys#

These factory functions provide a concise, keyword-driven way to build config objects without importing the dataclass names directly. All are available from the top-level plotez namespace.

Wrapper Functions#

Each function has a short alias that can be used interchangeably:

Long-form function

Short alias

line_plot_configuration

lpc

error_plot_configuration

epc

error_band_configuration

ebc

scatter_plot_configuration

spc

histogram_config

hgc
plotez.line_plot_configuration(c=None, lw=None, ls=None, alpha=None, marker=None, ms=None, mfc=None, mec=None, mew=None, **kwargs)[source]#

Create a configuration object for line plots.

Parameters:

  • c (str | list[str] | None) – Line color.

  • lw (int | float | list[int | float] | None) – Line width.

  • ls (str | list[str] | None) – Line style (e.g., ‘-’, ‘–’, ‘-.’, ‘:’).

  • alpha (int | float | list[int | float] | None) – Transparency level (0.0 to 1.0).

  • marker (str | list[str] | None) – Marker style (e.g., ‘o’, ‘s’, ‘^’).

  • ms (int | float | list[int | float] | None) – Marker size.

  • mfc (str | list[str] | None) – Marker face color.

  • mec (str | list[str] | None) – Marker-edge color.

  • mew (int | float | list[int | float] | None) – Marker-edge width.

  • **kwargs – Additional keyword arguments passed to the underlying plot function.

Returns:

Configuration object for line plots.

Return type:

LinePlotConfig

plotez.error_plot_configuration(c=None, lw=None, ls=None, alpha=None, ecolor=None, elinewidth=None, marker=None, ms=None, mfc=None, mec=None, capsize=None, capthick=None, errorevery=None, **kwargs)[source]#

Create a configuration object for error bar plots.

Parameters:

  • c (str | None) – Line color.

  • lw (int | float | None) – Line width.

  • ls (str | None) – Line style (e.g., ‘-’, ‘–’, ‘-.’, ‘:’).

  • alpha (int | float | None) – Transparency level (0.0 to 1.0).

  • ecolor (str | None) – Error bar color.

  • elinewidth (int | float | None) – Error bar line width.

  • marker (str | None) – Marker style (e.g., ‘o’, ‘s’, ‘^’).

  • ms (int | float | None) – Marker size.

  • mfc (str | None) – Marker face color.

  • mec (str | None) – Marker edge color.

  • capsize (int | float | None) – Length of the error bar caps in points.

  • capthick (int | float | None) – Thickness of error bar caps.

  • errorevery (int | tuple | None) – Draw error bars on a subset of data points.

  • **kwargs – Additional keyword arguments passed to the underlying errorbar function.

Returns:

Configuration object for error bar plots.

Return type:

ErrorPlotConfig

plotez.error_band_configuration(c=None, alpha=0.25, lw=None, ec=None, ls=None, hatch=None, interpolate=None, step=None, **kwargs)[source]#

Create a configuration object for error bands.

Parameters:

  • c (str | None) – Fill color for the error band.

  • alpha (int | float) – Transparency level (0.0 to 1.0).

  • lw (int | float | None) – Edge line width.

  • ec (str | None) – Edge color.

  • ls (str | None) – Edge line style (e.g., ‘-’, ‘–’, ‘-.’, ‘:’).

  • hatch (Literal['/', '\\', '|', '-', '+', 'x', 'o', 'O', '.', '*'] | list[~typing.Literal['/', '\\', '|', '-', '+', 'x', 'o', 'O', '.', '*']] | None) – Hatching pattern (e.g., ‘/’, ‘|’, ‘-’, ‘+’, ‘x’).

  • interpolate (bool | None) – Whether to interpolate the error band.

  • step (str | Literal['pre', 'post', 'mid'] | None) – Step mode for the band (e.g., ‘pre’, ‘post’, ‘mid’).

  • **kwargs – Additional keyword arguments passed to the underlying fill function.

Returns:

Configuration object for error bands.

Return type:

ErrorBandConfig

plotez.scatter_plot_configuration(c=None, s=None, alpha=None, marker=None, cmap=None, ec=None, fc=None, **kwargs)[source]#

Create a configuration object for scatter plots.

Parameters:

  • c (str | list[str] | None) – Marker color(s).

  • s (int | float | list[int | float] | None) – Marker size(s) in points squared.

  • alpha (int | float | list[int | float] | None) – Transparency level (0.0 to 1.0).

  • marker (str | list[str] | None) – Marker style (e.g., ‘o’, ‘s’, ‘^’).

  • cmap (str | list[str] | None) – Colormap name or object.

  • ec (str | list[str] | None) – Edge color(s).

  • fc (str | list[str] | None) – Face color(s).

  • **kwargs – Additional keyword arguments passed to the underlying scatter function.

Returns:

Configuration object for scatter plots.

Return type:

ScatterPlotConfig

plotez.histogram_config(bins=None, density=None, histtype=None, color=None, alpha=None, edgecolor=None, facecolor=None, linewidth=None, orientation=None, cumulative=None, hatch=None, **kwargs)[source]#

Create a HistogramConfig instance with the given parameters.

Parameters:

  • bins (int | None)

  • density (bool | None)

  • histtype (str | None)

  • color (str | None)

  • alpha (int | float | None)

  • edgecolor (str | None)

  • facecolor (str | None)

  • linewidth (int | float | None)

  • orientation (str | None)

  • cumulative (bool | None)

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

Shorthand Key Reference#

All populate() class methods and wrapper functions accept shorthand aliases in place of full matplotlib parameter names.

Line and Error-Bar Parameters#

Alias

Full parameter name

ls

linestyle

lw

linewidth

c

color

ms

markersize

mec

markeredgecolor

mfc

markerfacecolor

mew

markeredgewidth

Error-Bar-Only Parameters#

ErrorPlotConfig and epc also accept:

Alias

Full parameter name

ecolor

ecolor

elinewidth

elinewidth

capsize

capsize

capthick

capthick

Scatter Parameters#

Alias

Full parameter name

c

color

s

size

ec

edgecolors

fc

facecolors

Error Band Parameters#

Alias

Full parameter name

c

color

ec

edgecolor

lw

linewidth

ls

linestyle

hatch, interpolate, and step pass through under their own names.

Histogram Parameters#

Alias

Full parameter name

c

color

lw

linewidth

ec

edgecolor

bins, density, histtype, alpha, facecolor, orientation, cumulative, and hatch pass through under their own names.