gsplot.style_axes#

style_axes(target, spec)#

Apply one validated AxisSpec to explicit Axes targets.

Parameters:

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

  • spec (AxisSpec) – Immutable labels, limits, scales, ticks, and padding.

Returns:

The supplied Axes objects are styled in place.

Return type:

None

Raises:

LayoutError – If the target, specification, scale domain, or value is invalid.

Examples

>>> import gsplot as gs
>>> figure, ax = gs.subplots()
>>> gs.style_axes(ax, gs.AxisSpec(xlabel="time", ylabel="value"))
>>> ax.get_xlabel()
'time'
>>> figure.clear()