Bases: Artist
A patch is a 2D artist with a face color and an edge color.
If any of edgecolor, facecolor, linewidth, or antialiased are None, they default to their rc params setting.
The following kwarg properties are supported
Test whether the mouse event occurred in the patch.
MouseEvent
Where the user clicked.
Additional margin on the patch in target coordinates of Patch.get_transform. See Path.contains_point for further details.
If None, the default value depends on the state of the object:
If Artist.get_picker is a number, the default is that value. This is so that picking works as expected.
Otherwise if the edge color has a non-zero alpha, the default is half of the linewidth. This is so that all the colored pixels are "in" the patch.
Finally, if the edge has 0 alpha, the default is 0. This is so that patches without a stroked edge do not have points outside of the filled region report as "in" due to an invisible edge.
Return whether the given point is inside the patch.
The point (x, y) to check, in target coordinates of .Patch.get_transform(). These are display coordinates for patches that are added to a figure or Axes.
Additional margin on the patch in target coordinates of Patch.get_transform. See Path.contains_point for further details.
If None, the default value depends on the state of the object:
If Artist.get_picker is a number, the default is that value. This is so that picking works as expected.
Otherwise if the edge color has a non-zero alpha, the default is half of the linewidth. This is so that all the colored pixels are "in" the patch.
Finally, if the edge has 0 alpha, the default is 0. This is so that patches without a stroked edge do not have points outside of the filled region report as "in" due to an invisible edge.
Notes
The proper use of this method depends on the transform of the patch. Isolated patches do not have a transform. In this case, the patch creation coordinates and the point coordinates match. The following example checks that the center of a circle is within the circle
>>> center = 0, 0 >>> c = Circle(center, radius=1) >>> c.contains_point(center) True
The convention of checking against the transformed patch stems from the fact that this method is predominantly used to check if display coordinates (e.g. from mouse events) are within the patch. If you want to do the above check with data coordinates, you have to properly transform them first:
>>> center = 0, 0 >>> c = Circle(center, radius=3) >>> plt.gca().add_patch(c) >>> transformed_interior_point = c.get_data_transform().transform((0, 2)) >>> c.contains_point(transformed_interior_point) True
Return whether the given points are inside the patch.
The points to check, in target coordinates of self.get_transform(). These are display coordinates for patches that are added to a figure or Axes. Columns contain x and y values.
Additional margin on the patch in target coordinates of Patch.get_transform. See Path.contains_point for further details.
If None, the default value depends on the state of the object:
If Artist.get_picker is a number, the default is that value. This is so that picking works as expected.
Otherwise if the edge color has a non-zero alpha, the default is half of the linewidth. This is so that all the colored pixels are "in" the patch.
Finally, if the edge has 0 alpha, the default is 0. This is so that patches without a stroked edge do not have points outside of the filled region report as "in" due to an invisible edge.
Notes
The proper use of this method depends on the transform of the patch. See the notes on Patch.contains_point.
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).
RendererBase subclass.
Notes
This method is overridden in the Artist subclasses.
Return whether the patch is filled.
Alias for get_antialiased.
Return whether antialiasing is used for drawing.
Return the capstyle.
Return the Transform mapping data coordinates to physical coordinates.
Alias for get_edgecolor.
Return the edge color.
Return the face color.
Alias for get_facecolor.
Return whether the patch is filled.
Return the hatching pattern.
Return the hatch linewidth.
Return the hatch color.
Return the joinstyle.
Return the linestyle.
Return the line width in points.
Alias for get_linestyle.
Alias for get_linewidth.
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.
Return the path of this patch.
Return a copy of the vertices used in this patch.
If the patch contains Bézier curves, the curves will be interpolated by line segments. To access the curves as curves, use get_path.
Get the artist's bounding box in display space, ignoring clipping.
The bounding box's width and height are non-negative.
Subclasses should override for inclusion in the bounding box "tight" calculation. Default is to return an empty bounding box at 0, 0.
Warning
The extent can change due to any changes in the transform stack, such as changing the Axes limits, the figure size, the canvas used (as is done when saving a figure), or the DPI.
Relying on a once-retrieved window extent can lead to unexpected behavior in various cases such as interactive figures being resized or moved to a screen with different dpi, or figures that look fine on screen render incorrectly when saved to file.
To get accurate results you may need to manually call savefig or draw_without_rendering to have Matplotlib compute the rendered size.
RendererBase, optional
Renderer used to draw the figure (i.e. fig.canvas.get_renderer()).
Set multiple properties at once.
Supported properties are
Alias for set_antialiased.
Set the alpha value used for blending - not supported on all backends.
alpha must be within the 0-1 range, inclusive.
Set whether to use antialiased rendering.
Set the CapStyle.
The default capstyle is 'round' for FancyArrowPatch and 'butt' for all other patches.
CapStyle or {'butt', 'projecting', 'round'}
Set both the edgecolor and the facecolor.
Alias for set_edgecolor.
Set the patch edge color.
Set the patch face color.
Alias for set_facecolor.
Set whether to fill the patch.
Set the hatching pattern.
hatch can be one of:
/ - diagonal hatching \ - back diagonal | - vertical - - horizontal + - crossed x - crossed diagonal o - small circle O - large circle . - dots * - stars
Letters can be combined, in which case all the specified hatchings are done. If same letter repeats, it increases the density of hatching of that pattern.
Set the hatch linewidth.
Set the patch hatch color.
Set the JoinStyle.
The default joinstyle is 'round' for FancyArrowPatch and 'miter' for all other patches.
JoinStyle or {'miter', 'round', 'bevel'}
Set the patch linestyle.
Alternatively a dash tuple of the following form can be provided:
where onoffseq is an even length tuple of on and off ink in points.
The line style.
Set the patch linewidth in points.
Alias for set_linestyle.
Alias for set_linewidth.
Copy properties from other to self.
matplotlib.patches.Patch#
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4