gsplot.paper

paper(target, *, cycle=True)

Apply the frozen publication baseline to explicit Axes only.

Parameters:

• target (Axes | _AxesBase | Sequence[Axes | _AxesBase] | Mapping[Any, Axes | _AxesBase] | ndarray[tuple[int, ...], dtype[Any]]) – One Axes or a finite ordered Axes sequence, array, or mapping.

• cycle (bool) – Install the five-color paper property cycle. Populated Axes require False so an existing cycle is never restarted unpredictably.

Returns:

The supplied Axes are styled in place.

Return type:

None

Raises:

PlotError – If the target is invalid, cycle is not boolean, or cycle installation is requested for a populated Axes.

Notes

Styling is target-local and does not change global rcParams. Artists created directly through Matplotlib after this call retain Matplotlib’s creation-time defaults where no Axes-local retrofit exists.

Examples

>>> import gsplot as gs
>>> figure, ax = gs.subplots(style=None)
>>> gs.paper(ax)
>>> ax.get_facecolor()[:3]
(1.0, 1.0, 1.0)
>>> figure.clear()