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
(
self,
*args,
zs=0,
zdir="z",
depthshade=None,
depthshade_minalpha=None,
axlim_clip=False,
**kwargs
)
| 760 | """ |
| 761 | |
| 762 | def __init__( |
| 763 | self, |
| 764 | *args, |
| 765 | zs=0, |
| 766 | zdir="z", |
| 767 | depthshade=None, |
| 768 | depthshade_minalpha=None, |
| 769 | axlim_clip=False, |
| 770 | **kwargs |
| 771 | ): |
| 772 | """ |
| 773 | Create a collection of flat 3D patches with its normal vector |
| 774 | pointed in *zdir* direction, and located at *zs* on the *zdir* |
| 775 | axis. 'zs' can be a scalar or an array-like of the same length as |
| 776 | the number of patches in the collection. |
| 777 | |
| 778 | Constructor arguments are the same as for |
| 779 | :class:`~matplotlib.collections.PatchCollection`. In addition, |
| 780 | keywords *zs=0* and *zdir='z'* are available. |
| 781 | |
| 782 | The keyword argument *depthshade* is available to |
| 783 | indicate whether or not to shade the patches in order to |
| 784 | give the appearance of depth (default is *True*). |
| 785 | This is typically desired in scatter plots. |
| 786 | |
| 787 | *depthshade_minalpha* sets the minimum alpha value applied by |
| 788 | depth-shading. |
| 789 | """ |
| 790 | if depthshade is None: |
| 791 | depthshade = rcParams['axes3d.depthshade'] |
| 792 | if depthshade_minalpha is None: |
| 793 | depthshade_minalpha = rcParams['axes3d.depthshade_minalpha'] |
| 794 | self._depthshade = depthshade |
| 795 | self._depthshade_minalpha = depthshade_minalpha |
| 796 | super().__init__(*args, **kwargs) |
| 797 | self.set_3d_properties(zs, zdir, axlim_clip) |
| 798 | |
| 799 | def get_depthshade(self): |
| 800 | return self._depthshade |
nothing calls this directly
no test coverage detected