# mpl_toolkits.mplot3d.art3d.Patch3DCollection¶

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

A collection of 3D patches.

Create a collection of flat 3D patches 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 patches in the collection.

Constructor arguments are the same as for PatchCollection. 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 patches 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 patches in the collection.

Constructor arguments are the same as for PatchCollection. 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(self, renderer=<deprecated parameter>)[source]
get_depthshade(self)[source]
get_edgecolor(self)[source]
get_facecolor(self)[source]
set_3d_properties(self, zs, zdir)[source]
set_depthshade(self, 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_sort_zpos(self, val)[source]

Set the position to use for z-sorting.