Fix docs

scottshambaugh · kyracho · commit ab382228cc04 · 2024-10-10T22:00:19.000Z
Implement dynamic clipping to axes box for 3D plots

Make axlim_clip flag keyword only

Updates

test image

test image restore

Implement dynamic clipping to axes box for 3D plots

Make axlim_clip flag keyword only

Updates

test image

test image restore

Implement dynamic clipping to axes box for 3D plots

Make axlim_clip flag keyword only

Updates

test image

test image restore

Code review comments on 3D axlim clipping

Code review comments on 3D axlim clipping
diff --git a/doc/missing-references.json b/doc/missing-references.json
@@ -328,7 +328,7 @@
       "lib/matplotlib/quiver.py:docstring of matplotlib.quiver.Barbs:212",
       "lib/matplotlib/quiver.py:docstring of matplotlib.quiver.Quiver:251",
       "lib/mpl_toolkits/mplot3d/art3d.py:docstring of matplotlib.artist.Path3DCollection.set:46",
-      "lib/mpl_toolkits/mplot3d/art3d.py:docstring of matplotlib.artist.Poly3DCollection.set:44"
+      "lib/mpl_toolkits/mplot3d/art3d.py:docstring of matplotlib.artist.Poly3DCollection.set:45"
     ],
     "matplotlib.collections._MeshData.set_array": [
       "lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes._axes.Axes.pcolormesh:164",
diff --git a/doc/users/next_whats_new/3d_clip_to_axis_limits.rst b/doc/users/next_whats_new/3d_clip_to_axis_limits.rst
@@ -6,10 +6,10 @@ will clip the data to the axes view limits, hiding all data outside those
 bounds. This clipping will be dynamically applied in real time while panning
 and zooming.
 
-Please note that if one vertex of a line segment or 3D patch is clipped, the
-entire segment or patch will be hidden. Not being able to show partial lines
-or patches such that they are "smoothly" cut off at the boundaries of the view
-box is a limitation of the current renderer.
+Please note that if one vertex of a line segment or 3D patch is clipped, then
+the entire segment or patch will be hidden. Not being able to show partial
+lines or patches such that they are "smoothly" cut off at the boundaries of the
+view box is a limitation of the current renderer.
 
 .. plot::
     :include-source: true
diff --git a/galleries/users_explain/toolkits/mplot3d.rst b/galleries/users_explain/toolkits/mplot3d.rst
@@ -121,6 +121,8 @@ See `.Axes3D.fill_between` for API documentation.
    :target: /gallery/mplot3d/fillbetween3d.html
    :align: center
 
+.. versionadded:: 3.10
+
 .. _polygon3d:
 
 Polygon plots
diff --git a/lib/mpl_toolkits/mplot3d/axes3d.py b/lib/mpl_toolkits/mplot3d/axes3d.py
@@ -1903,6 +1903,8 @@ def text(self, x, y, z, s, zdir=None, *, axlim_clip=False, **kwargs):
             See `.get_dir_vector` for a description of the values.
         axlim_clip : bool, default: False
             Whether to hide text that is outside the axes view limits.
+
+            .. versionadded:: 3.10
         **kwargs
             Other arguments are forwarded to `matplotlib.axes.Axes.text`.
 
@@ -1935,6 +1937,8 @@ def plot(self, xs, ys, *args, zdir='z', axlim_clip=False, **kwargs):
             When plotting 2D data, the direction to use as z.
         axlim_clip : bool, default: False
             Whether to hide data that is outside the axes view limits.
+
+            .. versionadded:: 3.10
         **kwargs
             Other arguments are forwarded to `matplotlib.axes.Axes.plot`.
         """
@@ -2013,6 +2017,8 @@ def fill_between(self, x1, y1, z1, x2, y2, z2, *,
         axlim_clip : bool, default: False
             Whether to hide data that is outside the axes view limits.
 
+            .. versionadded:: 3.10
+
         **kwargs
             All other keyword arguments are passed on to `.Poly3DCollection`.
 
@@ -2158,6 +2164,8 @@ def plot_surface(self, X, Y, Z, *, norm=None, vmin=None,
         axlim_clip : bool, default: False
             Whether to hide patches with a vertex outside the axes view limits.
 
+            .. versionadded:: 3.10
+
         **kwargs
             Other keyword arguments are forwarded to `.Poly3DCollection`.
         """
@@ -2306,6 +2314,8 @@ def plot_wireframe(self, X, Y, Z, *, axlim_clip=False, **kwargs):
             Whether to hide lines and patches with vertices outside the axes
             view limits.
 
+            .. versionadded:: 3.10
+
         rcount, ccount : int
             Maximum number of samples used in each direction.  If the input
             data is larger, it will be downsampled (by slicing) to these
@@ -2453,6 +2463,8 @@ def plot_trisurf(self, *args, color=None, norm=None, vmin=None, vmax=None,
             The lightsource to use when *shade* is True.
         axlim_clip : bool, default: False
             Whether to hide patches with a vertex outside the axes view limits.
+
+            .. versionadded:: 3.10
         **kwargs
             All other keyword arguments are passed on to
             :class:`~mpl_toolkits.mplot3d.art3d.Poly3DCollection`
@@ -2596,6 +2608,8 @@ def contour(self, X, Y, Z, *args,
             position in a plane normal to *zdir*.
         axlim_clip : bool, default: False
             Whether to hide lines with a vertex outside the axes view limits.
+
+            .. versionadded:: 3.10
         data : indexable object, optional
             DATA_PARAMETER_PLACEHOLDER
 
@@ -2643,6 +2657,8 @@ def tricontour(self, *args,
             position in a plane normal to *zdir*.
         axlim_clip : bool, default: False
             Whether to hide lines with a vertex outside the axes view limits.
+
+            .. versionadded:: 3.10
         data : indexable object, optional
             DATA_PARAMETER_PLACEHOLDER
         *args, **kwargs
@@ -2700,6 +2716,8 @@ def contourf(self, X, Y, Z, *args,
             position in a plane normal to *zdir*.
         axlim_clip : bool, default: False
             Whether to hide lines with a vertex outside the axes view limits.
+
+            .. versionadded:: 3.10
         data : indexable object, optional
             DATA_PARAMETER_PLACEHOLDER
         *args, **kwargs
@@ -2740,6 +2758,8 @@ def tricontourf(self, *args, zdir='z', offset=None, axlim_clip=False, **kwargs):
             position in a plane normal to zdir.
         axlim_clip : bool, default: False
             Whether to hide lines with a vertex outside the axes view limits.
+
+            .. versionadded:: 3.10
         data : indexable object, optional
             DATA_PARAMETER_PLACEHOLDER
         *args, **kwargs
@@ -2798,6 +2818,8 @@ def add_collection3d(self, col, zs=0, zdir='z', autolim=True, *,
             Whether to update the data limits.
         axlim_clip : bool, default: False
             Whether to hide the scatter points outside the axes view limits.
+
+            .. versionadded:: 3.10
         """
         had_data = self.has_data()
 
@@ -2879,6 +2901,8 @@ def scatter(self, xs, ys,
             independently.
         axlim_clip : bool, default: False
             Whether to hide the scatter points outside the axes view limits.
+
+            .. versionadded:: 3.10
         data : indexable object, optional
             DATA_PARAMETER_PLACEHOLDER
         **kwargs
@@ -2938,6 +2962,8 @@ def bar(self, left, height, zs=0, zdir='z', *args,
             When plotting 2D data, the direction to use as z ('x', 'y' or 'z').
         axlim_clip : bool, default: False
             Whether to hide bars with points outside the axes view limits.
+
+            .. versionadded:: 3.10
         data : indexable object, optional
             DATA_PARAMETER_PLACEHOLDER
         **kwargs
@@ -3030,6 +3056,8 @@ def bar3d(self, x, y, z, dx, dy, dz, color=None,
         axlim_clip : bool, default: False
             Whether to hide the bars with points outside the axes view limits.
 
+            .. versionadded:: 3.10
+
         data : indexable object, optional
             DATA_PARAMETER_PLACEHOLDER
 
@@ -3188,6 +3216,8 @@ def quiver(self, X, Y, Z, U, V, W, *,
         axlim_clip : bool, default: False
             Whether to hide arrows with points outside the axes view limits.
 
+            .. versionadded:: 3.10
+
         data : indexable object, optional
             DATA_PARAMETER_PLACEHOLDER
 
@@ -3329,6 +3359,8 @@ def voxels(self, *args, facecolors=None, edgecolors=None, shade=True,
         axlim_clip : bool, default: False
             Whether to hide voxels with points outside the axes view limits.
 
+            .. versionadded:: 3.10
+
         **kwargs
             Additional keyword arguments to pass onto
             `~mpl_toolkits.mplot3d.art3d.Poly3DCollection`.
@@ -3577,6 +3609,8 @@ def errorbar(self, x, y, z, zerr=None, yerr=None, xerr=None, fmt='',
         axlim_clip : bool, default: False
             Whether to hide error bars that are outside the axes limits.
 
+            .. versionadded:: 3.10
+
         Returns
         -------
         errlines : list
@@ -3893,6 +3927,8 @@ def stem(self, x, y, z, *, linefmt='C0-', markerfmt='C0o', basefmt='C3-',
         axlim_clip : bool, default: False
             Whether to hide stems that are outside the axes limits.
 
+            .. versionadded:: 3.10
+
         data : indexable object, optional
             DATA_PARAMETER_PLACEHOLDER
 
