# mpl_toolkits.mplot3d.art3d.Path3DCollection¶

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

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__(*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'
do_3d_projection(renderer=<deprecated parameter>)[source]
draw(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: rendererRendererBase subclass.

Notes

This method is overridden in the Artist subclasses.

get_depthshade()[source]
get_edgecolor()[source]
get_facecolor()[source]
set_3d_properties(zs, zdir)[source]
set_depthshade(depthshade)[source]

Set whether depth shading is performed on collection members.

Parameters: depthshadeboolWhether to shade the patches in order to give the appearance of depth.
set_linewidth(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
set_sizes(sizes, dpi=72.0)[source]

Set the sizes of each member of the collection.

Parameters: sizesndarray or NoneThe size to set for each element of the collection. The value is the 'area' of the element. dpifloat, default: 72The dpi of the canvas.
set_sort_zpos(val)[source]

Set the position to use for z-sorting.