matplotlib.pyplot.stairs

matplotlib.pyplot.stairs(values, edges=None, *, orientation='vertical', baseline=0, fill=False, data=None, **kwargs)[source]

A stepwise constant function as a line with bounding edges or a filled plot.

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 when fill=True, position of lower edge. If fill is True or an array is passed to baseline, a closed path is drawn.

fillbool, default: False

Whether the area under the step curve should be filled.

Returns:
StepPatchmatplotlib.patches.StepPatch
Other Parameters:
**kwargs

StepPatch properties

Notes

Note

In addition to the above described arguments, this function can take a data keyword argument. If such a data argument is given, every other argument can also be string s, which is interpreted as data[s] (unless this raises an exception).

Objects passed as data must support item access (data[s]) and membership test (s in data).

Examples using matplotlib.pyplot.stairs