matplotlib.patches.Patch #

classe 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 ]#

Socles :Artist

Un patch est un artiste 2D avec une couleur de face et une couleur de bord.

Si edgecolor , facecolor , linewidth ou antialiased est None , ils utilisent par défaut leur paramètre rc params .

Les propriétés kwarg suivantes sont prises en charge

Propriété	La description
`agg_filter`	une fonction de filtre, qui prend un tableau flottant (m, n, 3) et une valeur dpi, et renvoie un tableau (m, n, 3) et deux décalages à partir du coin inférieur gauche de l'image
`alpha`	inconnue
`animated`	bourdonner
`antialiased`ou aa	booléen ou Aucun
`capstyle`	`CapStyle`ou {'bout', 'en saillie', 'rond'}
`clip_box`	`Bbox`
`clip_on`	bourdonner
`clip_path`	Patch ou (chemin, transformation) ou aucun
`color`	Couleur
`edgecolor`ou ce	couleur ou Aucun
`facecolor`ou FC	couleur ou Aucun
`figure`	`Figure`
`fill`	bourdonner
`gid`	chaîne
`hatch`	{'/', '\', '\|', '-', '+', 'x', 'o', 'O', '.', '*'}
`in_layout`	bourdonner
`joinstyle`	`JoinStyle`ou {'onglet', 'rond', 'biseau'}
`label`	objet
`linestyle`ou ls	{'-', '--', '-.', ':', '', (décalage, on-off-seq), ...}
`linewidth`ou lw	flottant ou Aucun
`mouseover`	bourdonner
`path_effects`	`AbstractPathEffect`
`picker`	Aucun ou bool ou flottant ou appelable
`rasterized`	bourdonner
`sketch_params`	(échelle : flottant, longueur : flottant, caractère aléatoire : flottant)
`snap`	booléen ou Aucun
`transform`	`Transform`
`url`	chaîne
`visible`	bourdonner
`zorder`	flotteur

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

Testez si l'événement de souris s'est produit dans le patch.

Retours :

(bool, dictée vide)

contient_point ( point , rayon = Aucun ) [source] #

Retourne si le point donné est à l'intérieur du patch.

Paramètres :

point (flottant, flottant): Le point (x, y) à vérifier, dans les coordonnées cibles de self.get_transform(). Il s'agit des coordonnées d'affichage des patchs ajoutés à une figure ou à des axes.
flotteur de rayon , facultatif: Ajoutez une marge supplémentaire sur le patch dans les coordonnées cibles de self.get_transform(). Voir Path.contains_pointpour plus de détails.

Retours :

bourdonner

Remarques

L'utilisation correcte de cette méthode dépend de la transformation du patch. Les patchs isolés n'ont pas de transformation. Dans ce cas, les coordonnées de création du patch et les coordonnées du point correspondent. L'exemple suivant vérifie que le centre d'un cercle est à l'intérieur du cercle

>>> center = 0, 0
>>> c = Circle(center, radius=1)
>>> c.contains_point(center)
True

La convention de vérification par rapport au patch transformé découle du fait que cette méthode est principalement utilisée pour vérifier si les coordonnées d'affichage (par exemple à partir d'événements de souris) se trouvent dans le patch. Si vous souhaitez effectuer la vérification ci-dessus avec des coordonnées de données, vous devez d'abord les transformer correctement :

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

contient_points ( points , rayon = Aucun ) [source] #

Retourne si les points donnés sont à l'intérieur du patch.

Paramètres :

tableau de points (N, 2): Les points à vérifier, dans les coordonnées cibles de self.get_transform(). Il s'agit des coordonnées d'affichage des patchs ajoutés à une figure ou à des axes. Les colonnes contiennent des valeurs x et y.
flotteur de rayon , facultatif: Ajoutez une marge supplémentaire sur le patch dans les coordonnées cibles de self.get_transform(). Voir Path.contains_pointpour plus de détails.

Retours :

longueur-N tableau booléen

Remarques

L'utilisation correcte de cette méthode dépend de la transformation du patch. Voir les notes sur Patch.contains_point.

draw ( moteur de rendu ) [source] #

Dessinez l'artiste (et ses enfants) à l'aide du moteur de rendu donné.

Cela n'a aucun effet si l'artiste n'est pas visible ( Artist.get_visible renvoie Faux).

Paramètres :

sous-classe de moteur de rendu .RendererBase

Remarques

Cette méthode est remplacée dans les sous-classes Artist.

remplissage de propriété #: Retourne si le patch est rempli.

get_aa ( ) [source] #: Alias pour get_antialiased.

get_antialiased ( ) [source] #: Indique si l'anticrénelage est utilisé pour le dessin.

get_capstyle ( ) [source] #: Retournez le style majuscule.

get_data_transform ( ) [source] #: Renvoie les Transformcoordonnées des données de mappage aux coordonnées physiques.

get_ec ( ) [source] #: Alias pour get_edgecolor.

get_edgecolor ( ) [source] #: Renvoie la couleur du bord.

get_extents ( ) [source] #: Renvoie les Patchétendues alignées sur l'axe de sous la forme d'un Bbox.

get_facecolor ( ) [source] #: Renvoie la couleur du visage.

get_fc ( ) [source] #: Alias pour get_facecolor.

get_fill ( ) [source] #: Retourne si le patch est rempli.

get_hatch ( ) [source] #: Renvoyez le motif de hachures.

get_joinstyle ( ) [source] #: Renvoie le style de jointure.

get_linestyle ( ) [source] #: Renvoie le style de ligne.

get_linewidth ( ) [source] #: Renvoie la largeur de la ligne en points.

get_ls ( ) [source] #: Alias pour get_linestyle.

get_lw ( ) [source] #: Alias pour get_linewidth.

get_patch_transform ( ) [source] #

Renvoie les Transformcoordonnées du patch de mappage d'instance aux coordonnées de données.

Par exemple, on peut définir un patch d'un cercle qui représente un rayon de 5 en fournissant des coordonnées pour un cercle unitaire, et une transformation qui redimensionne les coordonnées (la coordonnée du patch) de 5.

get_path ( ) [source] #: Renvoie le chemin de ce patch.

get_transform ( ) [source] #: Renvoyez le Transformappliqué au Patch.

get_verts ( ) [source] #

Renvoie une copie des sommets utilisés dans ce patch.

Si le patch contient des courbes de Bézier, les courbes seront interpolées par des segments de ligne. Pour accéder aux courbes en tant que courbes, utilisez get_path.

get_window_extent ( moteur de rendu = Aucun ) [source] #

Obtenez la boîte englobante de l'artiste dans l'espace d'affichage.

La largeur et la hauteur de la boîte englobante sont non négatives.

Les sous-classes doivent être remplacées pour être incluses dans le calcul « serré » de la boîte englobante. La valeur par défaut est de renvoyer une boîte englobante vide à 0, 0.

Soyez prudent lorsque vous utilisez cette fonction, les résultats ne seront pas mis à jour si l'étendue de la fenêtre d'artiste de l'artiste change. L'étendue peut changer en raison de toute modification de la pile de transformation, telle que la modification des limites des axes, de la taille de la figure ou du canevas utilisé (comme cela se fait lors de l'enregistrement d'une figure). Cela peut entraîner un comportement inattendu où les figures interactives s'afficheront correctement à l'écran, mais ne seront pas enregistrées correctement.

set ( * , agg_filter=<UNSET> , alpha=<UNSET> , animé=<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> ,style de ligne=<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] #

Définissez plusieurs propriétés à la fois.

Les propriétés prises en charge sont

Propriété

La description

agg_filter

une fonction de filtre, qui prend un tableau flottant (m, n, 3) et une valeur dpi, et renvoie un tableau (m, n, 3) et deux décalages à partir du coin inférieur gauche de l'image

alpha

inconnue

animated

bourdonner

antialiased

booléen ou Aucun

capstyle

CapStyleou {'bout', 'en saillie', 'rond'}

clip_box

Bbox

clip_on

bourdonner

clip_path

Patch ou (chemin, transformation) ou aucun

color

Couleur

edgecolor

couleur ou Aucun

facecolor

couleur ou Aucun

figure

Figure

fill

bourdonner

gid

chaîne

hatch

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

in_layout

bourdonner

joinstyle

JoinStyleou {'onglet', 'rond', 'biseau'}

label

objet

linestyle

{'-', '--', '-.', ':', '', (décalage, on-off-seq), ...}

linewidth

flottant ou Aucun

mouseover

bourdonner

path_effects

AbstractPathEffect

picker

Aucun ou bool ou flottant ou appelable

rasterized

bourdonner

sketch_params

(échelle : flottant, longueur : flottant, caractère aléatoire : flottant)

snap

booléen ou Aucun

transform

Transform

url

chaîne

visible

bourdonner

zorder

flotteur

set_aa ( aa ) [source] #: Alias pour set_antialiased.

set_alpha ( alpha ) [source] #

Définissez la valeur alpha utilisée pour la fusion - non prise en charge sur tous les backends.

Paramètres :

Scalaire alpha ou Aucun: alpha doit être compris entre 0 et 1 inclus.

set_antialiased ( aa ) [source] #

Définissez s'il faut utiliser le rendu anticrénelé.

Paramètres :

aa bool ou Aucun

set_capstyle ( s ) [source] #

Définissez le CapStyle.

Le capstyle par défaut est 'round' pour FancyArrowPatchet 'butt' pour tous les autres patchs.

Paramètres :

s CapStyleou {'bout', 'en saillie', 'rond'}

set_color ( c ) [source] #

Définissez à la fois la couleur de bord et la couleur de face.

Paramètres :

c couleur

Voir également

Patch.set_facecolor,Patch.set_edgecolor: Pour régler individuellement la couleur des bords ou des faces.

set_ec ( couleur ) [source] #: Alias pour set_edgecolor.

set_edgecolor ( couleur ) [source] #

Définissez la couleur du bord du patch.

Paramètres :

couleur couleur ou Aucune

set_facecolor ( couleur ) [source] #

Définissez la couleur de la face du patch.

Paramètres :

couleur couleur ou Aucune

set_fc ( couleur ) [source] #: Alias pour set_facecolor.

set_fill ( b ) [source] #

Définissez s'il faut remplir le patch.

Paramètres :

b bool

set_hatch ( hachure ) [source] #

Définissez le motif de hachure.

l' écoutille peut être l'une des suivantes :

/   - diagonal hatching
\   - back diagonal
|   - vertical
-   - horizontal
+   - crossed
x   - crossed diagonal
o   - small circle
O   - large circle
.   - dots
*   - stars

Les lettres peuvent être combinées, auquel cas toutes les hachures spécifiées sont effectuées. Si la même lettre se répète, cela augmente la densité des hachures de ce motif.

Le hachurage est pris en charge uniquement dans les backends PostScript, PDF, SVG et Agg.

Paramètres :

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

set_joinstyle ( s ) [source] #

Définissez le JoinStyle.

Le style de jointure par défaut est 'round' pour FancyArrowPatchet 'mitre' pour tous les autres patchs.

Paramètres :

s JoinStyleou {'onglet', 'rond', 'biseau'}

set_linestyle ( ls ) [source] #

Définissez le style de ligne du patch.

style de ligne	la description
`'-'`ou`'solid'`	ligne continue
`'--'`ou`'dashed'`	ligne pointillée
`'-.'`ou`'dashdot'`	ligne pointillée
`':'`ou`'dotted'`	ligne pointillée
`'none'`, `'None'`, , ou`' '''`	ne rien dessiner