mpl_toolkits.mplot3d.art3d.patch_collection_2d_to_3d#

mpl_toolkits.mplot3d.art3d.patch_collection_2d_to_3d(col, zs=0, zdir='z', depthshade=None, axlim_clip=False, *args, depthshade_minalpha=None)[source]#

Convert a PatchCollection into a Patch3DCollection object (or a PathCollection into a Path3DCollection object).

Parameters:
colPatchCollection or PathCollection

The collection to convert.

zsfloat or array of floats

The location or locations to place the patches in the collection along the zdir axis. Default: 0.

zdir{'x', 'y', 'z'}

The axis in which to place the patches. Default: "z". See get_dir_vector for a description of the values.

depthshadebool, default: rcParams["axes3d.depthshade"] (default: True)

Whether to shade the patches to give a sense of depth.

axlim_clipbool, default: False

Whether to hide patches with a vertex outside the axes view limits.

Added in version 3.10.

depthshade_minalphafloat, default: rcParams["axes3d.depthshade_minalpha"] (default: 0.3)

Sets the minimum alpha value used by depth-shading.

Added in version 3.11.