matplotlib.artist.kwdoc

matplotlib.artist.kwdoc(artist) [source]

Inspect an Artist class and return information about its settable properties and their current values.

It use the class ArtistInspector.

Parameters:
artist : Artist or an iterable of Artists
Returns:
string

Returns a string with a list or rst table with the settable properties of the artist. The formating depends on the value of rcParams["docstring.hardcopy"]. False result in a list that is intended for easy reading as a docstring and True result in a rst table intended for rendering the documentation with sphinx.

© 2012–2018 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.0.0/api/_as_gen/matplotlib.artist.kwdoc.html