matplotlib.patches.Shadow
-
class matplotlib.patches.Shadow(patch, ox, oy, props=<deprecated parameter>, **kwargs)
[source] -
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
scalar or None animated
bool antialiased
or aaunknown capstyle
CapStyle
or {'butt', 'projecting', 'round'}clip_box
Bbox
clip_on
bool clip_path
Patch or (Path, Transform) or None color
color contains
unknown edgecolor
or eccolor or None or 'auto' facecolor
or fccolor 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 lwfloat or None 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
-
__init__(self, patch, ox, oy, props=<deprecated parameter>, **kwargs)
[source] -
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
scalar or None animated
bool antialiased
or aaunknown capstyle
CapStyle
or {'butt', 'projecting', 'round'}clip_box
Bbox
clip_on
bool clip_path
Patch or (Path, Transform) or None color
color contains
unknown edgecolor
or eccolor or None or 'auto' facecolor
or fccolor 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 lwfloat or None 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
-
-
__module__ = 'matplotlib.patches'
-
__str__(self)
[source] -
Return str(self).
-
draw(self, renderer)
[source] -
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(self)
[source] -
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(self)
[source] -
Return the path of this patch.
-
property props
-
Examples using matplotlib.patches.Shadow
© 2012–2021 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.4.1/api/_as_gen/matplotlib.patches.Shadow.html