matplotlib.patches.StepPatch

class matplotlib.patches.StepPatch(values, edges, *, orientation='vertical', baseline=0, **kwargs)[source]

Bases: matplotlib.patches.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 when fill=True, position of lower edge. If fill is True or an array is passed to baseline, a closed path is drawn. Other valid keyword arguments are: Property Description agg_filter a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array alpha scalar or None animated bool antialiased or aa unknown capstyle CapStyle or {'butt', 'projecting', 'round'} clip_box Bbox clip_on bool clip_path Patch or (Path, Transform) or None color color contains unknown edgecolor or ec color or None or 'auto' facecolor or fc color or None figure Figure fill bool gid str hatch {'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'} in_layout bool joinstyle JoinStyle or {'miter', 'round', 'bevel'} label object linestyle or ls {'-', '--', '-.', ':', '', (offset, on-off-seq), ...} linewidth or lw float or None path_effects AbstractPathEffect picker None or bool or float or callable rasterized bool sketch_params (scale: float, length: float, randomness: float) snap bool or None transform Transform url str visible bool zorder float

__init__(values, edges, *, orientation='vertical', baseline=0, **kwargs)[source]

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. Other valid keyword arguments are: Property Description agg_filter a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array alpha scalar or None animated bool antialiased or aa unknown capstyle CapStyle or {'butt', 'projecting', 'round'} clip_box Bbox clip_on bool clip_path Patch or (Path, Transform) or None color color contains unknown edgecolor or ec color or None or 'auto' facecolor or fc color or None figure Figure fill bool gid str hatch {'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'} in_layout bool joinstyle JoinStyle or {'miter', 'round', 'bevel'} label object linestyle or ls {'-', '--', '-.', ':', '', (offset, on-off-seq), ...} linewidth or lw float or None path_effects AbstractPathEffect picker None or bool or float or callable rasterized bool sketch_params (scale: float, length: float, randomness: float) snap bool or None transform Transform url str visible bool zorder float

__module__ = 'matplotlib.patches'

get_data()[source]

Get StepPatch values, edges and baseline as namedtuple.

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

Examples using matplotlib.patches.StepPatch

Stairs Demo