mpl_toolkits.mplot3d.art3d.Path3DCollection¶
-
class
mpl_toolkits.mplot3d.art3d.
Path3DCollection
(*args, zs=0, zdir='z', depthshade=True, **kwargs)[source]¶ Bases:
matplotlib.collections.PathCollection
A collection of 3D paths.
Create a collection of flat 3D paths with its normal vector pointed in zdir direction, and located at zs on the zdir axis. 'zs' can be a scalar or an array-like of the same length as the number of paths in the collection.
Constructor arguments are the same as for
PathCollection
. In addition, keywords zs=0 and zdir='z' are available.Also, the keyword argument depthshade is available to indicate whether or not to shade the patches in order to give the appearance of depth (default is True). This is typically desired in scatter plots.
-
__init__
(self, *args, zs=0, zdir='z', depthshade=True, **kwargs)[source]¶ Create a collection of flat 3D paths with its normal vector pointed in zdir direction, and located at zs on the zdir axis. 'zs' can be a scalar or an array-like of the same length as the number of paths in the collection.
Constructor arguments are the same as for
PathCollection
. In addition, keywords zs=0 and zdir='z' are available.Also, the keyword argument depthshade is available to indicate whether or not to shade the patches in order to give the appearance of depth (default is True). This is typically desired in scatter plots.
-
__module__
= 'mpl_toolkits.mplot3d.art3d'¶
-
draw
(self, renderer)[source]¶ Draw the Artist (and its children) using the given renderer.
This has no effect if the artist is not visible (
Artist.get_visible
returns False).Parameters: - renderer
RendererBase
subclass.
Notes
This method is overridden in the Artist subclasses.
- renderer
-
set_depthshade
(self, depthshade)[source]¶ Set whether depth shading is performed on collection members.
Parameters: - depthshadebool
Whether to shade the patches in order to give the appearance of depth.
-
set_linewidth
(self, lw)[source]¶ Set the linewidth(s) for the collection. lw can be a scalar or a sequence; if it is a sequence the patches will cycle through the sequence
Parameters: - lwfloat or list of floats
-