You are reading documentation for the unreleased version of Matplotlib. Try searching for the released version of this page instead?
Version 2.1.1.post1076+g937889f
matplotlib
Fork me on GitHub

This Page

matplotlib.axes.Axes.set_clip_path

Axes.set_clip_path(path, transform=None)

Set the artist’s clip path, which may be:

  • a Patch (or subclass) instance; or
  • a Path instance, in which case a Transform instance, which will be applied to the path before using it for clipping, must be provided; or
  • None, to remove a previously set clipping path.

For efficiency, if the path happens to be an axis-aligned rectangle, this method will set the clipping box to the corresponding rectangle and set the clipping path to None.

ACCEPTS: [(Path, Transform) | Patch | None]