Skip to content

Commit 5ab47bb

Browse files
authored
Merge pull request matplotlib#29614 from marbled-toast/matplotlib#26739-3d-doc-string
2 parents b7e7663 + 9d7131e commit 5ab47bb

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

lib/mpl_toolkits/mplot3d/art3d.py

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -444,6 +444,30 @@ class Line3DCollection(LineCollection):
444444
def __init__(self, lines, axlim_clip=False, **kwargs):
445445
super().__init__(lines, **kwargs)
446446
self._axlim_clip = axlim_clip
447+
"""
448+
Parameters
449+
----------
450+
lines : list of (N, 3) array-like
451+
A sequence ``[line0, line1, ...]`` where each line is a (N, 3)-shape
452+
array-like containing points:: line0 = [(x0, y0, z0), (x1, y1, z1), ...]
453+
Each line can contain a different number of points.
454+
linewidths : float or list of float, default: :rc:`lines.linewidth`
455+
The width of each line in points.
456+
colors : :mpltype:`color` or list of color, default: :rc:`lines.color`
457+
A sequence of RGBA tuples (e.g., arbitrary color strings, etc, not
458+
allowed).
459+
antialiaseds : bool or list of bool, default: :rc:`lines.antialiased`
460+
Whether to use antialiasing for each line.
461+
facecolors : :mpltype:`color` or list of :mpltype:`color`, default: 'none'
462+
When setting *facecolors*, each line is interpreted as a boundary
463+
for an area, implicitly closing the path from the last point to the
464+
first point. The enclosed area is filled with *facecolor*.
465+
In order to manually specify what should count as the "interior" of
466+
each line, please use `.PathCollection` instead, where the
467+
"interior" can be specified by appropriate usage of
468+
`~.path.Path.CLOSEPOLY`.
469+
**kwargs : Forwarded to `.Collection`.
470+
"""
447471

448472
def set_sort_zpos(self, val):
449473
"""Set the position to use for z-sorting."""

0 commit comments

Comments
 (0)