matplotlib.patches.Shadow

class matplotlib.patches.Shadow(patch, ox, oy, props=<deprecated parameter>, **kwargs)

Bases: matplotlib.patches.Patch

Create a shadow of the given patch.

By default, the shadow will have the same face color as the patch, but darkened.

Parameters:

patchPatch

The patch to create the shadow for.

ox, oyfloat

The shift of the shadow in data coordinates, scaled by a factor of dpi/72.

propsdict

deprecated (use kwargs instead) Properties of the shadow patch.

**kwargs

Properties of the shadow patch. Supported keys are:

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

__init__(patch, ox, oy, props=<deprecated parameter>, **kwargs)

Create a shadow of the given patch.

By default, the shadow will have the same face color as the patch, but darkened.

Parameters:

patchPatch

The patch to create the shadow for.

ox, oyfloat

The shift of the shadow in data coordinates, scaled by a factor of dpi/72.

propsdict

deprecated (use kwargs instead) Properties of the shadow patch.

**kwargs

Properties of the shadow patch. Supported keys are:

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

__module__ = 'matplotlib.patches'

__str__()

Return str(self).

draw(renderer)

Draw the Artist (and its children) using the given renderer.

This has no effect if the artist is not visible (Artist.get_visible returns False).

Parameters:

rendererRendererBase subclass.

Notes

This method is overridden in the Artist subclasses.

get_patch_transform()

Return the Transform instance mapping patch coordinates to data coordinates.

For example, one may define a patch of a circle which represents a radius of 5 by providing coordinates for a unit circle, and a transform which scales the coordinates (the patch coordinate) by 5.

get_path()

Return the path of this patch.

property props

Examples using matplotlib.patches.Shadow

Demo Text Path

SVG Filter Pie