mpl_toolkits.mplot3d.art3d.Path3DCollection

class mpl_toolkits.mplot3d.art3d.Path3DCollection(*args, zs=0, zdir='z', depthshade=True, **kwargs)

Bases: 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.

do_3d_projection()

draw(renderer)

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:

rendererRendererBase subclass.

Notes

This method is overridden in the Artist subclasses.

get_depthshade()

get_edgecolor()

get_facecolor()

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, depthshade=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<UNSET>, paths=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, sizes=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, sort_zpos=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<UNSET>, visible=<UNSET>, zorder=<UNSET>)

Set multiple properties at once.

Supported properties are

Property	Description
3d_properties	unknown
agg_filter	a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array and two offsets from the bottom left corner of the image
alpha	array-like or scalar or None
animated	bool
antialiased or aa or antialiaseds	bool or list of bools
array	array-like or None
capstyle	CapStyle or {'butt', 'projecting', 'round'}
clim	(vmin: float, vmax: float)
clip_box	Bbox
clip_on	bool
clip_path	Patch or (Path, Transform) or None
cmap	Colormap or str or None
color	color or list of rgba tuples
depthshade	bool
edgecolor or ec or edgecolors	color or list of colors or 'face'
facecolor or facecolors or fc	color or list of colors
figure	Figure
gid	str
hatch	{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
in_layout	bool
joinstyle	JoinStyle or {'miter', 'round', 'bevel'}
label	object
linestyle or dashes or linestyles or ls	str or tuple or list thereof
linewidth or linewidths or lw	unknown
mouseover	bool
norm	Normalize or str or None
offset_transform or transOffset	unknown
offsets	(N, 2) or (2,) array-like
path_effects	AbstractPathEffect
paths	unknown
picker	None or bool or float or callable
pickradius	unknown
rasterized	bool
sizes	unknown
sketch_params	(scale: float, length: float, randomness: float)
snap	bool or None
sort_zpos	unknown
transform	Transform
url	str
urls	list of str or None
visible	bool
zorder	float

set_3d_properties(zs, zdir)

set_depthshade(depthshade)

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(lw)

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

set_sizes(sizes, dpi=72.0)

Set the sizes of each member of the collection.

Parameters:

sizesndarray or None

The size to set for each element of the collection. The value is the 'area' of the element.

dpifloat, default: 72

The dpi of the canvas.

set_sort_zpos(val)

Set the position to use for z-sorting.