mpl_toolkits.mplot3d.art3d.Patch3D#

class mpl_toolkits.mplot3d.art3d.Patch3D(*args, zs=(), zdir='z', **kwargs)[source]#

Bases: Patch

3D patch object.

Parameters:
verts
zsfloat

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

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

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

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>, 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

scalar or None

animated

bool

antialiased or aa

bool or None

capstyle

CapStyle or {'butt', 'projecting', 'round'}

clip_box

Bbox

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

fill

bool

gid

str

hatch

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

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

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

Set the z position and direction of the patch.

Parameters:
verts
zsfloat

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

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

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