Skip to content

Commit 5e6fca8

Browse files
committed
add detail to doc string in Line3DCollection
1 parent 24bb51c commit 5e6fca8

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

lib/mpl_toolkits/mplot3d/art3d.py

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -444,6 +444,38 @@ 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+
segments : list of (N, 3) array-like
451+
A sequence ``[line0, line1, ...]`` where each line is a (N, 3)-shape
452+
array-like containing points::
453+
454+
line0 = [(x0, y0, z0), (x1, y1, z1), ...]
455+
456+
Each line can contain a different number of points.
457+
linewidths : float or list of float, default: :rc:`lines.linewidth`
458+
The width of each line in points.
459+
colors : :mpltype:`color` or list of color, default: :rc:`lines.color`
460+
A sequence of RGBA tuples (e.g., arbitrary color strings, etc, not
461+
allowed).
462+
antialiaseds : bool or list of bool, default: :rc:`lines.antialiased`
463+
Whether to use antialiasing for each line.
464+
zorder : float, default: 2
465+
zorder of the lines once drawn.
466+
467+
facecolors : :mpltype:`color` or list of :mpltype:`color`, default: 'none'
468+
When setting *facecolors*, each line is interpreted as a boundary
469+
for an area, implicitly closing the path from the last point to the
470+
first point. The enclosed area is filled with *facecolor*.
471+
In order to manually specify what should count as the "interior" of
472+
each line, please use `.PathCollection` instead, where the
473+
"interior" can be specified by appropriate usage of
474+
`~.path.Path.CLOSEPOLY`.
475+
476+
**kwargs
477+
Forwarded to `.Collection`.
478+
"""
447479

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

0 commit comments

Comments
 (0)