mpl_toolkits.mplot3d.art3d.Patch3D#

classmpl_toolkits.mplot3d.art3d.Patch3D(*args,zs=(),zdir='z',axlim_clip=False,**kwargs)[source]#

Bases:Patch

3D patch object.

Parameters:
verts
zsfloat

The location along thezdir axis in 3D space to position thepatch.

zdir{'x', 'y', 'z'}

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

axlim_clipbool, default: False

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

do_3d_projection()[source]#
get_path()[source]#

Return the path of this patch.

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>)[source]#

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

float or None

animated

bool

antialiased oraa

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 orec

color or None

facecolor orfc

color or None

figure

Figure orSubFigure

fill

bool

gid

str

hatch

{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

hatch_linewidth

unknown

in_layout

bool

joinstyle

JoinStyle or {'miter', 'round', 'bevel'}

label

object

linestyle orls

{'-', '--', '-.', ':', '', (offset, on-off-seq), ...}

linewidth orlw

float or None

mouseover

bool

path_effects

list ofAbstractPathEffect

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(verts,zs=0,zdir='z',axlim_clip=False)[source]#

Set thez position and direction of the patch.

Parameters:
verts
zsfloat

The location along thezdir axis in 3D space to position thepatch.

zdir{'x', 'y', 'z'}

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

axlim_clipbool, default: False

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