From fd23bb2388c3d88e116947a8488e928f47894288 Mon Sep 17 00:00:00 2001 From: Ian Hunt-Isaak Date: Wed, 24 Feb 2021 15:39:29 -0500 Subject: [PATCH] add docstring for set_3d_properties --- lib/mpl_toolkits/mplot3d/art3d.py | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/lib/mpl_toolkits/mplot3d/art3d.py b/lib/mpl_toolkits/mplot3d/art3d.py index 822ff79fcc24..18148bf4dcae 100644 --- a/lib/mpl_toolkits/mplot3d/art3d.py +++ b/lib/mpl_toolkits/mplot3d/art3d.py @@ -464,6 +464,17 @@ def set_sort_zpos(self, val): self.stale = True def set_3d_properties(self, zs, zdir): + """ + Update the z values of the offsets. If there are more XY points in + the offsets than there are Z points then points without a Z offset + will not be drawn. + + Parameters + ---------- + zs : array-like + The new z values for the offsets. + zdir : {'x', 'y', 'z'} + """ # Force the collection to initialize the face and edgecolors # just in case it is a scalarmappable with a colormap. self.update_scalarmappable()