matplotlib.patches.Patch#

class matplotlib.patches.Patch(*, edgecolor=None, facecolor=None, color=None, linewidth=None, linestyle=None, antialiased=None, hatch=None, fill=True, capstyle=None, joinstyle=None, **kwargs)[source]#

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

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 and two offsets from the bottom left corner of the image

alpha

unknown

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

contains(mouseevent, radius=None)[source]#

Test whether the mouse event occurred in the patch.

Returns:
(bool, empty dict)
contains_point(point, radius=None)[source]#

Return whether the given point is inside the patch.

Parameters:
point(float, float)

The point (x, y) to check, in target coordinates of self.get_transform(). These are display coordinates for patches that are added to a figure or axes.

radiusfloat, optional

Additional margin on the patch in target coordinates of self.get_transform(). See Path.contains_point for further details.

Returns:
bool

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=1)
>>> plt.gca().add_patch(c)
>>> transformed_center = c.get_transform().transform(center)
>>> c.contains_point(transformed_center)
True
contains_points(points, radius=None)[source]#

Return whether the given points are inside the patch.

Parameters:
points(N, 2) array

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.

radiusfloat, optional

Additional margin on the patch in target coordinates of self.get_transform(). See Path.contains_point for further details.

Returns:
length-N bool array

Notes

The proper use of this method depends on the transform of the patch. See the notes on Patch.contains_point.

draw(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.

property fill#

Return whether the patch is filled.

get_aa()[source]#

Alias for get_antialiased.

get_antialiased()[source]#

Return whether antialiasing is used for drawing.

get_capstyle()[source]#

Return the capstyle.

get_data_transform()[source]#

Return the Transform mapping data coordinates to physical coordinates.

get_ec()[source]#

Alias for get_edgecolor.

get_edgecolor()[source]#

Return the edge color.

get_extents()[source]#

Return the Patch's axis-aligned extents as a Bbox.

get_facecolor()[source]#

Return the face color.

get_fc()[source]#

Alias for get_facecolor.

get_fill()[source]#

Return whether the patch is filled.

get_hatch()[source]#

Return the hatching pattern.

get_joinstyle()[source]#

Return the joinstyle.

get_linestyle()[source]#

Return the linestyle.

get_linewidth()[source]#

Return the line width in points.

get_ls()[source]#

Alias for get_linestyle.

get_lw()[source]#

Alias for get_linewidth.

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

Return the path of this patch.

get_transform()[source]#

Return the Transform applied to the Patch.

get_verts()[source]#

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_window_extent(renderer=None)[source]#

Get the artist's bounding box in display space.

The bounding box' width and height are nonnegative.

Subclasses should override for inclusion in the bounding box "tight" calculation. Default is to return an empty bounding box at 0, 0.

Be careful when using this function, the results will not update if the artist window extent of the artist changes. The extent can change due to any changes in the transform stack, such as changing the axes limits, the figure size, or the canvas used (as is done when saving a figure). This can lead to unexpected behavior where interactive figures will look fine on the screen, but will save incorrectly.

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

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

unknown

animated

bool

antialiased

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

color or None

facecolor

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

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

linewidth

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

Alias for set_antialiased.

set_alpha(alpha)[source]#

Set the alpha value used for blending - not supported on all backends.

Parameters:
alphascalar or None

alpha must be within the 0-1 range, inclusive.

set_antialiased(aa)[source]#

Set whether to use antialiased rendering.

Parameters:
aabool or None
set_capstyle(s)[source]#

Set the CapStyle.

The default capstyle is 'round' for FancyArrowPatch and 'butt' for all other patches.

Parameters:
sCapStyle or {'butt', 'projecting', 'round'}
set_color(c)[source]#

Set both the edgecolor and the facecolor.

Parameters:
ccolor

See also

Patch.set_facecolor, Patch.set_edgecolor

For setting the edge or face color individually.

set_ec(color)[source]#

Alias for set_edgecolor.

set_edgecolor(color)[source]#

Set the patch edge color.

Parameters:
colorcolor or None
set_facecolor(color)[source]#

Set the patch face color.

Parameters:
colorcolor or None
set_fc(color)[source]#

Alias for set_facecolor.

set_fill(b)[source]#

Set whether to fill the patch.

Parameters:
bbool
set_hatch(hatch)[source]#

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.

Hatching is supported in the PostScript, PDF, SVG and Agg backends only.

Parameters:
hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
set_joinstyle(s)[source]#

Set the JoinStyle.

The default joinstyle is 'round' for FancyArrowPatch and 'miter' for all other patches.

Parameters:
sJoinStyle or {'miter', 'round', 'bevel'}
set_linestyle(ls)[source]#

Set the patch linestyle.

linestyle

description

'-' or 'solid'

solid line

'--' or 'dashed'

dashed line

'-.' or 'dashdot'

dash-dotted line

':' or 'dotted'

dotted line

'none', 'None', ' ', or ''

draw nothing

Alternatively a dash tuple of the following form can be provided:

(offset, onoffseq)

where onoffseq is an even length tuple of on and off ink in points.

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

The line style.

set_linewidth(w)[source]#

Set the patch linewidth in points.

Parameters:
wfloat or None
set_ls(ls)[source]#

Alias for set_linestyle.

set_lw(w)[source]#

Alias for set_linewidth.

update_from(other)[source]#

Copy properties from other to self.

zorder = 1#

Examples using matplotlib.patches.Patch#

Curve with error band

Curve with error band

Curve with error band
Stairs Demo

Stairs Demo

Stairs Demo
Clipping images with patches

Clipping images with patches

Clipping images with patches
Image demo

Image demo

Image demo
Axes box aspect

Axes box aspect

Axes box aspect
Controlling view limits using margins and sticky_edges

Controlling view limits using margins and sticky_edges

Controlling view limits using margins and sticky_edges
Axes Zoom Effect

Axes Zoom Effect

Axes Zoom Effect
Boxplots

Boxplots

Boxplots
Plot a confidence ellipse of a two-dimensional dataset

Plot a confidence ellipse of a two-dimensional dataset

Plot a confidence ellipse of a two-dimensional dataset
Creating boxes from error bars using PatchCollection

Creating boxes from error bars using PatchCollection

Creating boxes from error bars using PatchCollection
Bar of pie

Bar of pie

Bar of pie
Scale invariant angle label

Scale invariant angle label

Scale invariant angle label
Angle annotations on bracket arrows

Angle annotations on bracket arrows

Angle annotations on bracket arrows
Annotating Plots

Annotating Plots

Annotating Plots
Composing Custom Legends

Composing Custom Legends

Composing Custom Legends
AnnotationBbox demo

AnnotationBbox demo

AnnotationBbox demo
Using a text as a Path

Using a text as a Path

Using a text as a Path
Text Rotation Mode

Text Rotation Mode

Text Rotation Mode
Text alignment

Text alignment

Text alignment
List of named colors

List of named colors

List of named colors
Arrow guide

Arrow guide

Arrow guide
Reference for Matplotlib artists

Reference for Matplotlib artists

Reference for Matplotlib artists
Compound path

Compound path

Compound path
Dolphins

Dolphins

Dolphins
Mmh Donuts!!!

Mmh Donuts!!!

Mmh Donuts!!!
Ellipse Demo

Ellipse Demo

Ellipse Demo
Drawing fancy boxes

Drawing fancy boxes

Drawing fancy boxes
Hatch demo

Hatch demo

Hatch demo
Hatch style reference

Hatch style reference

Hatch style reference
Circles, Wedges and Polygons

Circles, Wedges and Polygons

Circles, Wedges and Polygons
PathPatch object

PathPatch object

PathPatch object
Bezier Curve

Bezier Curve

Bezier Curve
ggplot style sheet

ggplot style sheet

ggplot style sheet
Grayscale style sheet

Grayscale style sheet

Grayscale style sheet
Style sheets reference

Style sheets reference

Style sheets reference
Inset locator demo

Inset locator demo

Inset locator demo
Anatomy of a figure

Anatomy of a figure

Anatomy of a figure
Firefox

Firefox

Firefox
Integral as the area under a curve

Integral as the area under a curve

Integral as the area under a curve
Multiple axes animation

Multiple axes animation

Multiple axes animation
Looking Glass

Looking Glass

Looking Glass
Path editor

Path editor

Path editor
Pick event demo

Pick event demo

Pick event demo
Poly Editor

Poly Editor

Poly Editor
Trifinder Event Demo

Trifinder Event Demo

Trifinder Event Demo
Viewlims

Viewlims

Viewlims
Anchored Artists

Anchored Artists

Anchored Artists
Changing colors of lines intersecting a box

Changing colors of lines intersecting a box

Changing colors of lines intersecting a box
Custom projection

Custom projection

Custom projection
Building histograms using Rectangles and PolyCollections

Building histograms using Rectangles and PolyCollections

Building histograms using Rectangles and PolyCollections
Matplotlib logo

Matplotlib logo

Matplotlib logo
Packed-bubble chart

Packed-bubble chart

Packed-bubble chart
SVG filter pie

SVG filter pie

SVG filter pie
TickedStroke patheffect

TickedStroke patheffect

TickedStroke patheffect
Draw flat objects in 3D plot

Draw flat objects in 3D plot

Draw flat objects in 3D plot
Hinton diagrams

Hinton diagrams

Hinton diagrams
Radar chart (aka spider or star chart)

Radar chart (aka spider or star chart)

Radar chart (aka spider or star chart)
SkewT-logP diagram: using transforms and custom projections

SkewT-logP diagram: using transforms and custom projections

SkewT-logP diagram: using transforms and custom projections
Artist tests

Artist tests

Artist tests
Ellipse with units

Ellipse with units

Ellipse with units
Anchored Box04

Anchored Box04

Anchored Box04
Annotate Explain

Annotate Explain

Annotate Explain
Connect Simple01

Connect Simple01

Connect Simple01
Simple Annotate01

Simple Annotate01

Simple Annotate01
Menu

Menu

Menu
Artist tutorial

Artist tutorial

Artist tutorial
Legend guide

Legend guide

Legend guide
Path Tutorial

Path Tutorial

Path Tutorial
Transformations Tutorial

Transformations Tutorial

Transformations Tutorial
Specifying colors

Specifying colors

Specifying colors
Text properties and layout

Text properties and layout

Text properties and layout
Annotations

Annotations

Annotations