matplotlib.patches.StepPatch — Matplotlib 3.10.1 documentation (original) (raw)
class matplotlib.patches.StepPatch(values, edges, *, orientation='vertical', baseline=0, **kwargs)[source]#
Bases: PathPatch
A path patch describing a stepwise constant function.
By default, the path is not closed and starts and stops at baseline value.
Parameters:
valuesarray-like
The step heights.
edgesarray-like
The edge positions, with len(edges) == len(vals) + 1, between which the curve takes on vals values.
orientation{'vertical', 'horizontal'}, default: 'vertical'
The direction of the steps. Vertical means that values are along the y-axis, and edges are along the x-axis.
baselinefloat, array-like or None, default: 0
The bottom value of the bounding edges or whenfill=True, position of lower edge. If fill is True or an array is passed to baseline, a closed path is drawn.
**kwargs
Patch properties:
Get StepPatch values, edges and baseline as namedtuple.
set(*, agg_filter=, alpha=, animated=, antialiased=, capstyle=, clip_box=, clip_on=, clip_path=, color=, data=, edgecolor=, facecolor=, fill=, gid=, hatch=, hatch_linewidth=, in_layout=, joinstyle=, label=, linestyle=, linewidth=, mouseover=, path=, path_effects=, picker=, rasterized=, sketch_params=, snap=, transform=, url=, visible=, zorder=)[source]#
Set multiple properties at once.
Supported properties are
set_data(values=None, edges=None, baseline=None)[source]#
Set StepPatch values, edges and baseline.
Parameters:
values1D array-like or None
Will not update values, if passing None
edges1D array-like, optional
baselinefloat, 1D array-like or None