You are reading an old version of the documentation (v2.2.0). For the latest version see https://matplotlib.org/stable/api/_as_gen/matplotlib.artist.Artist.get_sketch_params.html
Version 2.2.0
matplotlib
Fork me on GitHub

This Page

matplotlib.artist.Artist.get_sketch_params

Artist.get_sketch_params()

Returns the sketch parameters for the artist.

Returns:

sketch_params : tuple or None

A 3-tuple with the following elements:

  • scale: The amplitude of the wiggle perpendicular to the source line.
  • length: The length of the wiggle along the line.
  • randomness: The scale factor by which the length is shrunken or expanded.

May return None if no sketch parameters were set.