matplotlib.text

Classes pour inclure du texte dans une figure.

classe matplotlib.text. Text ( x = 0 , y = 0 , text = '' , * , color = None , verticalalignment = 'baseline' , horizontalalignment = 'left' , multialignment = None , fontproperties = None , rotation = None , linespacing = None , rotation_mode = Aucun, usetex = None , wrap = False , transform_rotates_text = False , parse_math = None , ** kwargs )

Socles :Artist

Gérer le stockage et le dessin de texte dans la fenêtre ou les coordonnées de données.

Créez une Textinstance à x , y avec une chaîne text .

Le texte est aligné par rapport au point d'ancrage ( x , y ) selon horizontalalignment(défaut : 'left') et verticalalignment (défaut : 'bottom'). Voir aussi Alignement du texte .

Bien que Text accepte l'argument de mot-clé 'label', par défaut, il n'est pas ajouté aux poignées d'une légende.

Les arguments de mots clés valides 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	scalaire ou Aucun
animated	bourdonner
backgroundcolor	Couleur
bbox	dict avec des propriétés pourpatches.FancyBboxPatch
clip_box	inconnue
clip_on	inconnue
clip_path	inconnue
colorou c	Couleur
figure	Figure
fontfamilyou famille	{FONTNAME, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}
fontpropertiesou police ou font_properties	font_manager.FontPropertiesou stroupathlib.Path
fontsizeou taille	flottant ou {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}
fontstretchou étirer	{une valeur numérique dans la plage 0-1000, 'ultra-condensé', 'extra-condensé', 'condensé', 'semi-condensé', 'normal', 'semi-élargi', 'élargi', 'extra-élargi ', 'ultra-élargi'}
fontstyleou style	{'normal', 'italique', 'oblique'}
fontvariantou variante	{'normal', 'petites majuscules'}
fontweightou poids	{une valeur numérique dans la plage 0-1000, 'ultralight', 'light', 'normal', 'regular', 'book', 'medium', 'roman', 'semibold', 'demibold', 'demi', 'gras', 'lourd', 'extra gras', 'noir'}
gid	chaîne
horizontalalignmentou ha	{'gauche', 'centre', 'droite'}
in_layout	bourdonner
label	objet
linespacing	flottant (multiple de la taille de la police)
math_fontfamily	chaîne
mouseover	bourdonner
multialignmentou maman	{'gauche', 'droite', 'centre'}
parse_math	bourdonner
path_effects	AbstractPathEffect
picker	Aucun ou bool ou flottant ou appelable
position	(flotter, flotter)
rasterized	bourdonner
rotation	flottant ou {'vertical', 'horizontal'}
rotation_mode	{Aucun, 'par défaut', 'ancre'}
sketch_params	(échelle : flottant, longueur : flottant, caractère aléatoire : flottant)
snap	booléen ou Aucun
text	objet
transform	Transform
transform_rotates_text	bourdonner
url	chaîne
usetex	booléen ou Aucun
verticalalignmentou va	{'bottom', 'baseline', 'center', 'center_baseline', 'top'}
visible	bourdonner
wrap	bourdonner
x	flotteur
y	flotteur
zorder	flotteur

contient ( mouseevent )

Renvoie si l'événement de souris s'est produit à l'intérieur de la boîte englobante alignée sur l'axe du texte.

draw ( moteur de rendu )

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.

get_bbox_patch ( )

Renvoie la bbox Patch, ou None si le patches.FancyBboxPatch n'est pas fait.

get_c ( )

Alias ​​pour get_color.

get_color ( )

Renvoie la couleur du texte.

get_family ( )

Alias ​​pour get_fontfamily.

get_font ( )

Alias ​​pour get_fontproperties.

get_font_properties ( )

Alias ​​pour get_fontproperties.

get_fontfamily ( )

Renvoie la liste des familles de polices utilisées pour la recherche de polices.

Voir également

font_manager.FontProperties.get_family

get_nom_police ( )

Renvoie le nom de la police sous forme de chaîne.

Voir également

font_manager.FontProperties.get_name

get_fontproperties ( )

Retournez le font_manager.FontProperties.

get_fontsize ( )

Renvoie la taille de la police sous forme d'entier.

Voir également

font_manager.FontProperties.get_size_in_points

get_fontstyle ( )

Renvoie le style de police sous forme de chaîne.

Voir également

font_manager.FontProperties.get_style

get_fontvariant ( )

Renvoie la variante de police sous forme de chaîne.

Voir également

font_manager.FontProperties.get_variant

get_fontweight ( )

Renvoie l'épaisseur de la police sous forme de chaîne ou de nombre.

Voir également

font_manager.FontProperties.get_weight

get_ha ( )

Alias ​​pour get_horizontalalignment.

get_horizontalalignment ( )

Renvoie l'alignement horizontal sous forme de chaîne. Sera l'un des 'gauche', 'centre' ou 'droite'.

get_math_fontfamily ( )

Renvoie le nom de la famille de polices pour le texte mathématique rendu par Matplotlib.

La valeur par défaut est rcParams["mathtext.fontset"](par défaut : 'dejavusans').

Voir également

set_math_fontfamily

get_name ( )

Alias ​​pour get_fontname.

get_parse_math ( )

Retourne si l'analyse mathtext est prise en compte pour this Text.

obtenir_position ( )

Renvoie la position (x, y) du texte.

get_prop_tup ( moteur de rendu = Aucun )

[ Obsolète ] Renvoie un tuple hachable de propriétés.

Non destiné à être lisible par l'homme, mais utile pour les backends qui souhaitent mettre en cache des informations dérivées sur le texte (par exemple, les mises en page) et ont besoin de savoir si le texte a changé.

Remarques

Obsolète depuis la version 3.5.

obtenir_rotation ( )

Renvoie l'angle du texte en degrés entre 0 et 360.

get_rotation_mode ( )

Renvoie le mode de rotation du texte.

get_size ( )

Alias ​​pour get_fontsize.

get_stretch ( )

Renvoie l'étirement de la police sous forme de chaîne ou de nombre.

Voir également

font_manager.FontProperties.get_stretch

get_style ( )

Alias ​​pour get_fontstyle.

get_text ( )

Renvoie la chaîne de texte.

get_transform_rotates_text ( )

Indique si les rotations de la transformation affectent la direction du texte.

get_unitless_position ( )

Renvoie la position sans unité (x, y) du texte.

get_usetex ( )

Retourne si cet Textobjet utilise TeX pour le rendu.

get_va ( )

Alias ​​pour get_verticalalignment.

get_variant ( )

Alias ​​pour get_fontvariant.

get_verticalalignment ( )

Renvoie l'alignement vertical sous forme de chaîne. Sera l'un des 'top', 'center', 'bottom', 'baseline' ou 'center_baseline'.

get_weight ( )

Alias ​​pour get_fontweight.

get_window_extent ( moteur de rendu = Aucun , dpi = Aucun )

Renvoie la Bboxlimite du texte, en unités d'affichage.

En plus d'être utilisé en interne, cela est utile pour spécifier des régions cliquables dans un fichier png sur une page Web.

Paramètres :

moteur de rendu Moteur de rendu, facultatif

Un moteur de rendu est nécessaire pour calculer la boîte englobante. Si l'artiste a déjà été dessiné, le moteur de rendu est mis en cache ; ainsi, il est seulement nécessaire de passer cet argument lors de l'appel get_window_extent avant le premier tirage. En pratique, il est généralement plus facile de déclencher un tirage en premier, par exemple en suivant draw_without_renderingou plt.show().

dpi flottant, facultatif

La valeur dpi pour le calcul de la bbox est par défaut self.figure.dpi( pas le rendu dpi); doit être défini, par exemple pour faire correspondre les régions avec un chiffre enregistré avec une valeur ppp personnalisée.

get_wrap ( )

Retourne si le texte peut être enveloppé.

set ( * , agg_filter=<UNSET> , alpha=<UNSET> , animé=<UNSET> , backgroundcolor=<UNSET> , bbox =<UNSET> , clip_box=<UNSET> , clip_on=<UNSET> , clip_path=<UNSET > , color=<UNSET> , fontfamily=<UNSET> , fontproperties=<UNSET> , fontsize=<UNSET> , fontstretch=<UNSET> , fontstyle=<UNSET> , fontvariant=<UNSET> , fontweight=<UNSET> , gid=<UNSET>, alignementhorizontal=<NON DÉFINI>, in_layout=<UNSET> , label=<UNSET> , linespacing=<UNSET> , math_fontfamily=<UNSET> , mouseover=<UNSET> , multialignment=<UNSET> , parse_math=<UNSET> , path_effects=<UNSET> , sélecteur =<UNSET> , position=<UNSET> , rasterized=<UNSET> , rotation=<UNSET> , rotation_mode=<UNSET> , sketch_params=<UNSET> , snap=<UNSET> , text=<UNSET> , transform=< UNSET> ,transform_rotates_text=<UNSET> ,url=<UNSET> , usetex=<UNSET> , verticalalignment=<UNSET> , visible=<UNSET> , wrap=<UNSET> , x=<UNSET> , y=<UNSET> , zorder=<UNSET> )

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	scalaire ou Aucun
animated	bourdonner
backgroundcolor	Couleur
bbox	dict avec des propriétés pourpatches.FancyBboxPatch
clip_box	inconnue
clip_on	inconnue
clip_path	inconnue
color	Couleur
figure	Figure
fontfamily	{FONTNAME, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}
fontproperties	font_manager.FontPropertiesou stroupathlib.Path
fontsize	flottant ou {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}
fontstretch	{une valeur numérique dans la plage 0-1000, 'ultra-condensé', 'extra-condensé', 'condensé', 'semi-condensé', 'normal', 'semi-élargi', 'élargi', 'extra-élargi ', 'ultra-élargi'}
fontstyle	{'normal', 'italique', 'oblique'}
fontvariant	{'normal', 'petites majuscules'}
fontweight	{une valeur numérique dans la plage 0-1000, 'ultralight', 'light', 'normal', 'regular', 'book', 'medium', 'roman', 'semibold', 'demibold', 'demi', 'gras', 'lourd', 'extra gras', 'noir'}
gid	chaîne
horizontalalignment	{'gauche', 'centre', 'droite'}
in_layout	bourdonner
label	objet
linespacing	flottant (multiple de la taille de la police)
math_fontfamily	chaîne
mouseover	bourdonner
multialignment	{'gauche', 'droite', 'centre'}
parse_math	bourdonner
path_effects	AbstractPathEffect
picker	Aucun ou bool ou flottant ou appelable
position	(flotter, flotter)
rasterized	bourdonner
rotation	flottant ou {'vertical', 'horizontal'}
rotation_mode	{Aucun, 'par défaut', 'ancre'}
sketch_params	(échelle : flottant, longueur : flottant, caractère aléatoire : flottant)
snap	booléen ou Aucun
text	objet
transform	Transform
transform_rotates_text	bourdonner
url	chaîne
usetex	booléen ou Aucun
verticalalignment	{'bottom', 'baseline', 'center', 'center_baseline', 'top'}
visible	bourdonner
wrap	bourdonner
x	flotteur
y	flotteur
zorder	flotteur

set_backgroundcolor ( couleur )

Définissez la couleur de fond du texte en mettant à jour la bbox.

Paramètres :

couleur couleur

Voir également

set_bbox

Pour modifier la position de la zone de délimitation

set_bbox ( rectprops )

Dessinez une boîte englobante autour de vous-même.

Paramètres :

rectprops dict avec des propriétés pourpatches.FancyBboxPatch

Le style de boîte par défaut est 'carré'. L'échelle de mutation de patches.FancyBboxPatchest définie sur la taille de la police.

Exemples

t.set_bbox(dict(facecolor='red', alpha=0.5))

set_c ( couleur )

Alias ​​pour set_color.

set_clip_box ( clipbox )

Définissez le clip de l'artiste Bbox.

Paramètres :

clipboxBbox

set_clip_on ( b )

Définissez si l'artiste utilise l'écrêtage.

Lorsque de faux artistes seront visibles en dehors des axes, ce qui peut entraîner des résultats inattendus.

Paramètres :

b bool

set_clip_path ( path , transform = None )

Définissez le chemin du clip de l'artiste.

Paramètres :

chemin Patchou Pathou TransformedPathou Aucun

Le chemin du clip. Si un Path, transform doit également être fourni. Si Aucun , un chemin de clip précédemment défini est supprimé.

transformer Transform, facultatif

Utilisé uniquement si path est un Path, auquel cas le donné Path est converti en un TransformedPathusing transform .

Remarques

Pour plus d'efficacité, si path est un Rectanglecette méthode définira la zone de détourage sur le rectangle correspondant et définira le chemin de détourage sur None.

Pour des raisons techniques (prise en charge de set), un tuple ( path , transform ) est également accepté comme paramètre positionnel unique.

set_color ( couleur )

Définir la couleur de premier plan du texte

Paramètres :

couleur couleur

set_family ( nom de la police )

Alias ​​pour set_fontfamily.

set_font ( fp )

Alias ​​pour set_fontproperties.

set_font_properties ( fp )

Alias ​​pour set_fontproperties.

set_fontfamily ( nom de la police )

Définissez la famille de polices. Il peut s'agir soit d'une seule chaîne, soit d'une liste de chaînes de priorité décroissante. Chaque chaîne peut être soit un nom de police réel, soit un nom de classe de police générique. Dans ce dernier cas, les noms de police spécifiques seront recherchés dans les rcParams correspondants.

Si une Textinstance est construite avec fontfamily=None, alors la police est définie sur rcParams["font.family"](par défaut : ['sans-serif']), et la même chose est faite lorsque est appelé sur une instance set_fontfamily()existante .Text

Paramètres :

nom de la police { FONTNAME , 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}

Voir également

font_manager.FontProperties.set_family

set_fontname ( nom de la police )

Alias ​​pour set_family.

Alias ​​unidirectionnel uniquement : le getter diffère.

Paramètres :

nom de la police { FONTNAME , 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}

Voir également

font_manager.FontProperties.set_family

set_fontproperties ( fp )

Définissez les propriétés de police qui contrôlent le texte.

Paramètres :

fp font_manager.FontPropertiesou stroupathlib.Path

Si a str, il est interprété comme un modèle fontconfig analysé par FontProperties. Si a pathlib.Path, il est interprété comme le chemin absolu vers un fichier de police.

set_fontsize ( fontsize )

Définissez la taille de la police.

Paramètres :

fontsize flottant ou {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}

Si float, la taille de la police en points. Les valeurs de chaîne indiquent les tailles par rapport à la taille de police par défaut.

Voir également

font_manager.FontProperties.set_size

set_fontstretch ( étirer )

Définissez l'étirement de la police (condensation ou expansion horizontale).

Paramètres :

stretch {une valeur numérique dans la plage 0-1000, 'ultra-condensé', 'extra-condensé', 'condensé', 'semi-condensé', 'normal', 'semi-étendu', 'étendu', 'extra- étendu', 'ultra-élargi'}

Voir également

font_manager.FontProperties.set_stretch

set_fontstyle ( style de police )

Définissez le style de police.

Paramètres :

style de police {'normal', 'italique', 'oblique'}

Voir également

font_manager.FontProperties.set_style

set_fontvariant ( variante )

Définissez la variante de police.

Paramètres :

variante {'normal', 'petites majuscules'}

Voir également

font_manager.FontProperties.set_variant

set_fontweight ( poids )

Définissez le poids de la police.

Paramètres :

poids {une valeur numérique dans la plage 0-1000, 'ultralight', 'light', 'normal', 'regular', 'book', 'medium', 'roman', 'semibold', 'demibold', 'demi' , 'gras', 'lourd', 'extra gras', 'noir'}

Voir également

font_manager.FontProperties.set_weight

set_ha ( aligner )

Alias ​​pour set_horizontalalignment.

set_horizontalalignment ( aligner )

Définissez l'alignement horizontal par rapport au point d'ancrage.

Voir aussi Alignement du texte .

Paramètres :

aligner {'gauche', 'centre', 'droite'}

set_linespacing ( espacement )

Définissez l'interligne comme un multiple de la taille de la police.

L'interligne par défaut est de 1,2.

Paramètres :

espacement flottant (multiple de la taille de la police)

set_ma ( aligner )

Alias ​​pour set_multialignment.

set_math_fontfamily ( fontfamily )

Définissez la famille de polices pour le texte mathématique rendu par Matplotlib.

Cela n'affecte que le moteur de rendu mathématique de Matplotlib. Il n'a aucun effet lors du rendu avec TeX ( usetex=True).

Paramètres :

fontfamily str

Le nom de la famille de polices.

Les familles de polices disponibles sont définies dans le fichier matplotlibrc.template .

Voir également

get_math_fontfamily

set_multialignment ( aligner )

Définissez l'alignement du texte pour les textes multilignes.

La disposition de la boîte englobante de toutes les lignes est déterminée par les propriétés horizontalalignment et verticalalignment. Cette propriété contrôle l'alignement des lignes de texte dans cette zone.

Paramètres :

aligner {'gauche', 'droite', 'centre'}

set_name ( fontname )

Alias ​​pour set_fontname.

set_parse_math ( parse_math )

Remplacez le commutateur pour désactiver toute analyse de texte mathématique pour ce fichier Text.

Paramètres :

booléen parse_math

Si False, cela Textn'utilisera jamais mathtext. Si True, mathtext sera utilisé s'il y a un nombre pair de signes dollar non échappés.

set_position ( xy )

Définissez la position ( x , y ) du texte.

Paramètres :

xy (flottant, flottant)

set_rotation ( s )

Définissez la rotation du texte.

Paramètres :

s flottant ou {'vertical', 'horizontal'}

L'angle de rotation en degrés dans le sens mathématiquement positif (sens antihoraire). 'horizontal' est égal à 0, 'vertical' est égal à 90.

set_rotation_mode ( m )

Définir le mode de rotation du texte.

Paramètres :

m {Aucun, 'par défaut', 'ancre'}

Si Noneou "default", le texte sera d'abord tourné, puis aligné selon leurs alignements horizontal et vertical. Si "anchor", alors l'alignement se produit avant la rotation.

set_size ( fontsize )

Alias ​​pour set_fontsize.

set_stretch ( étirer )

Alias ​​pour set_fontstretch.

set_style ( style de police )

Alias ​​pour set_fontstyle.

set_text ( s )

Définissez la chaîne de texte s .

Il peut contenir des retours à la ligne ( \n) ou des maths dans la syntaxe LaTeX.

Paramètres :

l' objet

Tout objet est converti en sa strreprésentation, à l'exception de Nonecelui qui est converti en une chaîne vide.

set_transform_rotates_text ( t )

Si les rotations de la transformation affectent la direction du texte.

Paramètres :

t bool

set_usetex ( usetex )

Paramètres :

usetex booléen ou Aucun

Que ce soit pour rendre en utilisant TeX, Nonesignifie utiliser rcParams["text.usetex"](par défaut : False).

set_va ( aligner )

Alias ​​pour set_verticalalignment.

set_variant ( variante )

Alias ​​pour set_fontvariant.

set_verticalalignment ( aligner )

Définissez l'alignement vertical par rapport au point d'ancrage.

Voir aussi Alignement du texte .

Paramètres :

aligner {'bas', 'baseline', 'center', 'center_baseline', 'top'}

set_weight ( poids )

Alias ​​pour set_fontweight.

set_wrap ( envelopper )

Définissez si le texte peut être enveloppé.

Paramètres :

bobiner _

Remarques

L'encapsulation ne fonctionne pas avec (qui est également utilisé en interne par dans IPython/Jupyter). Le paramètre "serré" redimensionne le canevas pour s'adapter à tout le contenu et se produit avant l'habillage.savefig(..., bbox_inches='tight')%matplotlib inline

set_x ( x )

Définissez la position x du texte.

Paramètres :

x flotteur

set_y ( y )

Définissez la position y du texte.

Paramètres :

je flotte

mise à jour ( kwargs )

Mettez à jour les propriétés de cet artiste à partir du dict props .

Paramètres :

accessoires dict

update_bbox_position_size ( moteur de rendu )

Mettez à jour l'emplacement et la taille de la bbox.

Cette méthode doit être utilisée lorsque la position et la taille de la bbox doivent être mises à jour avant de réellement dessiner la bbox.

update_from ( autre )

Copiez les propriétés de other vers self .

zordre = 3

classe matplotlib.text. Annotation ( text , xy , xytext = None , xycoords = 'data' , textcoords = None , arrowprops = None , annotation_clip = None , ** kwargs )

Bases : Text,_AnnotationBase

An Annotationest un Textqui peut faire référence à une position spécifique xy . En option, une flèche pointant du texte vers xy peut être dessinée.

Attributs :

xy

La position annotée.

xycoords

Le système de coordonnées pour xy .

arrow_patch

A FancyArrowPatchpour pointer de xytext vers xy .

Annotez le point xy avec du texte text .

Dans la forme la plus simple, le texte est placé à xy .

En option, le texte peut être affiché dans une autre position xytext . Une flèche pointant du texte vers le point annoté xy peut alors être ajoutée en définissant arrowprops .

Paramètres :

chaîne de texte

Le texte de l'annotation.

xy (flottant, flottant)

Le point (x, y) à annoter. Le système de coordonnées est déterminé par xycoords .

xytext (float, float), par défaut : xy

La position (x, y) à laquelle placer le texte. Le système de coordonnées est déterminé par textcoords .

xycoords str ou Artistou Transformou callable or (float, float), par défaut : 'data'

Le système de coordonnées dans lequel xy est donné. Les types de valeurs suivants sont pris en charge :

• L'une des chaînes suivantes :

  Évaluer	La description
  'points de chiffres'	Points en bas à gauche de la figure
  'chiffre pixels'	Pixels en bas à gauche de la figure
  'fraction de chiffres'	Fraction de la figure en bas à gauche
  'points de sous-figure'	Points en bas à gauche de la sous-figure
  "pixels sous-figurés"	Pixels en bas à gauche de la sous-figure
  'fraction de sous-figure'	Fraction de sous-figure en bas à gauche
  'points d'axes'	Points du coin inférieur gauche des axes
  'axes pixels'	Pixels du coin inférieur gauche des axes
  'fraction d'axes'	Fraction d'axes en bas à gauche
  'Les données'	Utiliser le système de coordonnées de l'objet annoté (par défaut)
  'polaire'	(thêta, r) ​​s'il ne s'agit pas de coordonnées de "données" natives

  Notez que les « pixels de sous-figure » ​​et les « pixels de la figure » ​​sont les mêmes pour la figure parente, de sorte que les utilisateurs qui souhaitent un code utilisable dans une sous-figure peuvent utiliser des « pixels de sous-figure ».

• Un Artist: xy est interprété comme une fraction du Bbox. Par exemple (0, 0) serait le coin inférieur gauche de la boîte englobante et (0,5, 1) serait le centre supérieur de la boîte englobante.

• A Transformpour transformer xy en coordonnées d'écran.

• Une fonction avec l'une des signatures suivantes :

  def transform(renderer) -> Bbox
  def transform(renderer) -> Transform
  

  où renderer est une sous- RendererBaseclasse.

  Le résultat de la fonction est interprété comme les cas Artistet Transformci-dessus.

• Un tuple (xcoords, ycoords) spécifiant des systèmes de coordonnées séparés pour x et y . xcoords et ycoords doivent chacun appartenir à l'un des types décrits ci-dessus.

Voir Annotations avancées pour plus de détails.

textcoords str or Artistor Transformor callable or (float, float), par défaut : valeur de xycoords

Le système de coordonnées dans lequel xytext est donné.

Toutes les valeurs xycoords sont valides ainsi que les chaînes suivantes :

Évaluer	La description
'points de décalage'	Décalage (en points) de la valeur xy
'pixels décalés'	Décalage (en pixels) de la valeur xy

arrowprops dict, facultatif

Les propriétés utilisées pour dessiner une FancyArrowPatchflèche entre les positions xy et xytext . La valeur par défaut est Aucune, c'est-à-dire qu'aucune flèche n'est dessinée.

Pour des raisons historiques, il existe deux manières différentes de spécifier les flèches, "simple" et "fantaisie":

Flèche simple :

Si arrowprops ne contient pas la clé 'arrowstyle', les clés autorisées sont :

Clé	La description
largeur	La largeur de la flèche en points
largeur de tête	La largeur de la base de la tête de flèche en points
longueur de tête	La longueur de la tête de flèche en points
rétrécir	Fraction de la longueur totale à rétrécir des deux extrémités
?	N'importe quelle clé pourmatplotlib.patches.FancyArrowPatch

La flèche est attachée au bord de la zone de texte, la position exacte (coins ou centres) selon l'endroit où elle pointe.

Flèche fantaisie :

Ceci est utilisé si 'arrowstyle' est fourni dans le arrowprops .

Les clés valides sont les FancyArrowPatch paramètres suivants :

Clé	La description
style de flèche	le style flèche
style de connexion	le style de connexion
repos	voir ci-dessous; la valeur par défaut est (0,5, 0,5)
patchA	la valeur par défaut est le cadre de délimitation du texte
patchB	la valeur par défaut est Aucune
rétrécirA	la valeur par défaut est de 2 points
rétrécirB	la valeur par défaut est de 2 points
mutation_scale	la valeur par défaut est la taille du texte (en points)
mutation_aspect	la valeur par défaut est 1.
?	n'importe quelle clé pourmatplotlib.patches.PathPatch

La position exacte du point de départ de la flèche est définie par relpos . C'est un tuple de coordonnées relatives de la zone de texte, où (0, 0) est le coin inférieur gauche et (1, 1) est le coin supérieur droit. Les valeurs <0 et >1 sont prises en charge et spécifient des points en dehors de la zone de texte. Par défaut (0.5, 0.5) le point de départ est centré dans la zone de texte.

annotation_clip booléen ou Aucun, par défaut : Aucun

S'il faut découper (c'est-à-dire ne pas dessiner) l'annotation lorsque le point d'annotation xy est en dehors de la zone des axes.

• Si True , l'annotation sera coupée lorsque xy est en dehors des axes.

• Si False , l'annotation sera toujours dessinée.

• Si None , l'annotation sera coupée lorsque xy est en dehors des axes et que xycoords est 'data'.

**kwargs

Des kwargs supplémentaires sont transmis à Text.

Retours :

Annotation

Voir également

Annotations avancées

anncoords de propriété

Le système de coordonnées à utiliser pour Annotation.xyann.

contient ( événement )

Renvoie si l'événement de souris s'est produit à l'intérieur de la boîte englobante alignée sur l'axe du texte.

draw ( moteur de rendu )

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.

get_anncoords ( )

Renvoie le système de coordonnées à utiliser pour Annotation.xyann.

Voir aussi xycoords dans Annotation.

get_tightbbox ( moteur de rendu = Aucun )

Comme Artist.get_window_extent, mais inclut tout découpage.

Paramètres :

sous-classe de moteur de renduRendererBase

moteur de rendu qui sera utilisé pour dessiner les figures (c'est-à-dire fig.canvas.get_renderer())

Retours :

Bbox

La boîte englobante englobante (en coordonnées de pixels de la figure).

get_window_extent ( moteur de rendu = Aucun )

Renvoie la Bboxlimite du texte, en unités d'affichage.

En plus d'être utilisé en interne, cela est utile pour spécifier des régions cliquables dans un fichier png sur une page Web.

Paramètres :

moteur de rendu Moteur de rendu, facultatif

Un moteur de rendu est nécessaire pour calculer la boîte englobante. Si l'artiste a déjà été dessiné, le moteur de rendu est mis en cache ; ainsi, il est seulement nécessaire de passer cet argument lors de l'appel get_window_extent avant le premier tirage. En pratique, il est généralement plus facile de déclencher un tirage en premier, par exemple en suivant draw_without_renderingou plt.show().

dpi flottant, facultatif

La valeur dpi pour le calcul de la bbox est par défaut self.figure.dpi( pas le rendu dpi); doit être défini, par exemple pour faire correspondre les régions avec un chiffre enregistré avec une valeur ppp personnalisée.

set ( * , agg_filter=<UNSET> , alpha=<UNSET> , animé=<UNSET> , anncoords=<UNSET> , annotation_clip=<UNSET> , backgroundcolor=<UNSET> , bbox=<UNSET> , clip_box=<UNSET > , clip_on=<UNSET> , clip_path=<UNSET> , color=<UNSET> , fontfamily=<UNSET> , fontproperties=<UNSET> , fontsize=<UNSET> , fontstretch=<UNSET> , fontstyle=<UNSET> , fontvariant=<UNSET> , fontweight=<UNSET>, gid=<UNSET> , horizontalalignment=<UNSET> , in_layout=<UNSET> , label=<UNSET> , linespacing=<UNSET> , math_fontfamily=<UNSET> , mouseover=<UNSET> , multialignment=<UNSET> , parse_math =<UNSET> , path_effects=<UNSET> , picker=<UNSET> , position=<UNSET> , rasterized=<UNSET> , rotation=<UNSET> , rotation_mode=<UNSET> , sketch_params=<UNSET> , snap=< UNSET> ,text=<NON ENSEMBLE> ,transform=<UNSET> , transform_rotates_text=<UNSET> , url=<UNSET> , usetex=<UNSET> , verticalalignment=<UNSET> , visible=<UNSET> , wrap=<UNSET> , x=<UNSET> , y= <UNSET> , zorder=<UNSET> )

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	scalaire ou Aucun
animated	bourdonner
anncoords	inconnue
annotation_clip	booléen ou Aucun
backgroundcolor	Couleur
bbox	dict avec des propriétés pourpatches.FancyBboxPatch
clip_box	Bbox
clip_on	bourdonner
clip_path	Patch ou (chemin, transformation) ou aucun
colorou c	Couleur
figure	inconnue
fontfamilyou famille	{FONTNAME, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}
fontpropertiesou police ou font_properties	font_manager.FontPropertiesou stroupathlib.Path
fontsizeou taille	flottant ou {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}
fontstretchou étirer	{une valeur numérique dans la plage 0-1000, 'ultra-condensé', 'extra-condensé', 'condensé', 'semi-condensé', 'normal', 'semi-élargi', 'élargi', 'extra-élargi ', 'ultra-élargi'}
fontstyleou style	{'normal', 'italique', 'oblique'}
fontvariantou variante	{'normal', 'petites majuscules'}
fontweightou poids	{une valeur numérique dans la plage 0-1000, 'ultralight', 'light', 'normal', 'regular', 'book', 'medium', 'roman', 'semibold', 'demibold', 'demi', 'gras', 'lourd', 'extra gras', 'noir'}
gid	chaîne
horizontalalignmentou ha	{'gauche', 'centre', 'droite'}
in_layout	bourdonner
label	objet
linespacing	flottant (multiple de la taille de la police)
math_fontfamily	chaîne
mouseover	bourdonner
multialignmentou maman	{'gauche', 'droite', 'centre'}
parse_math	bourdonner
path_effects	AbstractPathEffect
picker	Aucun ou bool ou flottant ou appelable
position	(flotter, flotter)
rasterized	bourdonner
rotation	flottant ou {'vertical', 'horizontal'}
rotation_mode	{Aucun, 'par défaut', 'ancre'}
sketch_params	(échelle : flottant, longueur : flottant, caractère aléatoire : flottant)
snap	booléen ou Aucun
text	objet
transform	Transform
transform_rotates_text	bourdonner
url	chaîne
usetex	booléen ou Aucun
verticalalignmentou va	{'bottom', 'baseline', 'center', 'center_baseline', 'top'}
visible	bourdonner
wrap	bourdonner
x	flotteur
y	flotteur
zorder	flotteur

set_anncoords ( coords )

Définissez le système de coordonnées à utiliser pour Annotation.xyann.

Voir aussi xycoords dans Annotation.

set_figure ( figure )

Définissez l' Figureinstance à laquelle appartient l'artiste.

Paramètres :

figureFigure

update_positions ( moteur de rendu )

Mettez à jour les positions des pixels du texte d'annotation et du patch fléché.

propriété xyann

La position du texte.

Voir aussi xytext dans Annotation.

propriété xycoords

classe matplotlib.text. OffsetFrom ( artiste , ref_coord , unit = 'points' )

Socles :object

Classe d'assistance appelable pour travailler avec Annotation.

Paramètres :

artiste Artistou BboxBaseouTransform

L'objet à partir duquel calculer le décalage.

ref_coord (flottant, flottant)

Si l'artiste est un Artistou BboxBase, cette valeur correspond à l'emplacement de l'origine du décalage en fractions de la boîte englobante de l' artiste .

Si artist est une transformation, l'origine du décalage est la transformation appliquée à cette valeur.

unité {'points, 'pixels'}, par défaut : 'points'

Les unités d'écran à utiliser (pixels ou points) pour l'entrée de décalage.

get_unit ( )

Renvoie l'unité d'entrée à la transformation utilisée par __call__.

set_unit ( unité )

Définissez l'unité d'entrée sur la transformation utilisée par __call__.

Paramètres :

unité {'points', 'pixels'}