mpl_toolkits.mplot3d.art3d.PathPatch3D

class mpl_toolkits.mplot3d.art3d.PathPatch3D(path, *, zs=(), zdir='z', axlim_clip=False, **kwargs)

Bases: Patch3D

3D PathPatch object.

Parameters:

path

zsfloat

The location along the zdir axis in 3D space to position the path patch.

zdir{'x', 'y', 'z', 3-tuple}

Plane to plot path patch orthogonal to. Default: 'z'. See get_dir_vector for a description of the values.

axlim_clipbool, default: False

Whether to hide path patches with a point outside the axes view limits.

do_3d_projection()

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, capstyle=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, fill=<UNSET>, gid=<UNSET>, hatch=<UNSET>, hatch_linewidth=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, zorder=<UNSET>)

Set multiple properties at once.

Supported properties are

Property	Description
3d_properties	unknown
agg_filter	a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array and two offsets from the bottom left corner of the image
alpha	scalar or None
animated	bool
antialiased or aa	bool or None
capstyle	CapStyle or {'butt', 'projecting', 'round'}
clip_box	BboxBase or None
clip_on	bool
clip_path	Patch or (Path, Transform) or None
color	color
edgecolor or ec	color or None
facecolor or fc	color or None
figure	Figure or SubFigure
fill	bool
gid	str
hatch	{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
hatch_linewidth	unknown
in_layout	bool
joinstyle	JoinStyle or {'miter', 'round', 'bevel'}
label	object
linestyle or ls	{'-', '--', '-.', ':', '', (offset, on-off-seq), ...}
linewidth or lw	float or None
mouseover	bool
path_effects	list of AbstractPathEffect
picker	None or bool or float or callable
rasterized	bool
sketch_params	(scale: float, length: float, randomness: float)
snap	bool or None
transform	Transform
url	str
visible	bool
zorder	float

set_3d_properties(path, zs=0, zdir='z', axlim_clip=False)

Set the z position and direction of the path patch.

Parameters:

path

zsfloat

The location along the zdir axis in 3D space to position the path patch.

zdir{'x', 'y', 'z', 3-tuple}

Plane to plot path patch orthogonal to. Default: 'z'. See get_dir_vector for a description of the values.

axlim_clipbool, default: False

Whether to hide path patches with a point outside the axes view limits.

Examples using mpl_toolkits.mplot3d.art3d.PathPatch3D

Draw flat objects in 3D plot

Draw flat objects in 3D plot