matplotlib.backend_bases#

Les classes de base abstraites définissent les primitives que les rendus et les contextes graphiques doivent implémenter pour servir de backend Matplotlib.

RendererBase

Une classe de base abstraite pour gérer les opérations de dessin/rendu.

FigureCanvasBase

La couche d'abstraction qui sépare les Figuredétails spécifiques du backend, comme une zone de dessin d'interface utilisateur.

GraphicsContextBase

Une classe de base abstraite qui fournit la couleur, les styles de ligne, etc.

Event

La classe de base pour toute la gestion des événements Matplotlib. Les classes dérivées telles que KeyEventet MouseEventstockent les métadonnées telles que les touches et les boutons enfoncés, les emplacements x et y en pixels et Axesles coordonnées.

ShowBase

La classe de base pour la Showclasse de chaque backend interactif ; l'appelable 'show' est alors défini sur Show.__call__.

ToolContainerBase

La classe de base pour la classe Toolbar de chaque backend interactif.

classe matplotlib.backend_bases. CloseEvent ( name , canvas , guiEvent = None ) [source] #

Socles :Event

Un événement déclenché par la fermeture d'une figure.

classe matplotlib.backend_bases. DrawEvent ( name , canvas , renderer ) [source] #

Socles :Event

Un événement déclenché par une opération de dessin sur le canevas.

Dans la plupart des backends, les rappels abonnés à cet événement seront déclenchés une fois le rendu terminé mais avant la mise à jour de l'écran. Tous les artistes supplémentaires dessinés sur le moteur de rendu du canevas seront reflétés sans appel explicite à blit.

Avertissement

L'appel canvas.drawet canvas.blitdans ces rappels peut ne pas être sûr avec tous les backends et peut provoquer une récursivité infinie.

Un DrawEvent a un certain nombre d'attributs spéciaux en plus de ceux définis par la Eventclasse parent.

Attributs :
moteur de renduRendererBase

Moteur de rendu pour l'événement draw.

classe matplotlib.backend_bases. Event ( name , canvas , guiEvent = None ) [source] #

Socles :object

Un événement Matplotlib.

Les attributs suivants sont définis et affichés avec leurs valeurs par défaut. Les sous-classes peuvent définir des attributs supplémentaires.

Attributs :
chaîne de nom

Le nom de l'événement.

ToileFigureCanvasBase

L'instance de canevas spécifique au backend générant l'événement.

guiEvent

L'événement GUI qui a déclenché l'événement Matplotlib.

classe matplotlib.backend_bases. FigureCanvasBase ( figure = Aucun ) [source] #

Socles :object

La toile dans laquelle la figure se rend.

Attributs :
chiffrematplotlib.figure.Figure

Une instance de chiffre de haut niveau.

blit ( bbox = Aucun ) [source] #

Blit le canevas dans bbox (canevas entier par défaut).

propriété button_pick_id #
button_press_event ( x , y , button , dblclick = False , guiEvent = None ) [source] #

[ Obsolète ] Traitement de rappel pour les événements d'appui sur le bouton de la souris.

Les classes dérivées backend doivent appeler cette fonction à chaque pression sur un bouton de la souris. ( x , y ) sont les coordonnées du canevas ((0, 0) est en bas à gauche). le bouton et la touche sont tels que définis dans MouseEvent.

Cette méthode appellera toutes les fonctions connectées au 'button_press_event' avec une MouseEventinstance.

Remarques

Obsolète depuis la version 3.6 : utilisez callbacks.process('button_press_event', MouseEvent(...)) à la place.

button_release_event ( x , y , bouton , guiEvent = Aucun ) [source] #

[ Obsolète ] Traitement de rappel pour les événements de relâchement du bouton de la souris.

Les classes dérivées backend doivent appeler cette fonction à chaque relâchement du bouton de la souris.

Cette méthode appellera toutes les fonctions connectées au 'button_release_event' avec une MouseEventinstance.

Paramètres :
x flotteur

Le canevas coordonne où 0=gauche.

je flotte

Le canevas coordonne où 0 = bas.

guiEvent

L'événement d'interface utilisateur natif qui a généré l'événement Matplotlib.

Remarques

Obsolète depuis la version 3.6 : utilisez callbacks.process('button_release_event', MouseEvent(...)) à la place.

rappels de propriété #
close_event ( guiEvent = Aucun ) [source] #

[ Obsolète ] Passez a CloseEventà toutes les fonctions connectées à close_event.

Remarques

Obsolète depuis la version 3.6 : utilisez callbacks.process('close_event', CloseEvent(...)) à la place.

propriété device_pixel_ratio #

Le rapport entre les pixels physiques et logiques utilisés pour le canevas à l'écran.

Par défaut, il s'agit de 1, ce qui signifie que les pixels physiques et logiques ont la même taille. Les sous-classes qui prennent en charge les écrans High DPI peuvent définir cette propriété pour indiquer que ledit rapport est différent. Toutes les interactions Matplotlib, à moins de travailler directement avec le canevas, restent en pixels logiques.

dessiner ( * args , ** kwargs ) [source] #

Rendre le Figure.

Cette méthode doit parcourir l'arborescence des artistes, même si aucune sortie n'est produite, car elle déclenche un travail différé auquel les utilisateurs peuvent souhaiter accéder avant d'enregistrer la sortie sur le disque. Par exemple, calculer des limites, des limites automatiques et des valeurs de tick.

draw_event ( moteur de rendu ) [source] #

[ Obsolète ] Passez a DrawEventà toutes les fonctions connectées à draw_event.

Remarques

Obsolète depuis la version 3.6 : utilisez plutôt callbacks.process('draw_event', DrawEvent(...)).

draw_idle ( * args , ** kwargs ) [source] #

Demander un redessin du widget une fois que le contrôle revient à la boucle d'événements de l'interface graphique.

Même si plusieurs appels se draw_idleproduisent avant que le contrôle ne revienne à la boucle d'événements de l'interface graphique, la figure ne sera rendue qu'une seule fois.

Remarques

Les backends peuvent choisir de remplacer la méthode et de mettre en œuvre leur propre stratégie pour empêcher plusieurs rendus.

enter_notify_event ( guiEvent = Aucun , xy = Aucun ) [source] #

[ Obsolète ] Traitement de rappel pour le curseur de la souris entrant dans le canevas.

Les classes dérivées du backend doivent appeler cette fonction lors de l'entrée dans canvas.

Paramètres :
guiEvent

L'événement d'interface utilisateur natif qui a généré l'événement Matplotlib.

xy (flottant, flottant)

L'emplacement des coordonnées du pointeur lorsque le canevas est entré.

Remarques

Obsolète depuis la version 3.6 : utilisez callbacks.process('enter_notify_event', LocationEvent(...)) à la place.

événements = ['resize_event', 'draw_event', 'key_press_event', 'key_release_event', 'button_press_event', 'button_release_event', 'scroll_event', 'motion_notify_event', 'pick_event', 'figure_enter_event', 'figure_leave_event', 'axes_enter_event' , 'axes_leave_event', 'close_event'] #
filetypes = {'eps': ' Postscript encapsulé ', 'jpeg': 'Groupe conjoint d' experts en photographie ', 'jpg': 'Groupe conjoint d' experts en photographie ', 'pdf': 'Portable Document Format', 'pgf': 'PGF code for LaTeX', 'png': 'Portable Network Graphics', 'ps': 'Postscript', 'raw': 'Raw RGBA bitmap', 'rgba': 'Raw RGBA bitmap','svg' : ' Graphiques vectoriels évolutifs ', 'svgz': 'Scalable Vector Graphics', 'tif': 'Tagged Image File Format', 'tiff': 'Tagged Image File Format', 'webp': 'WebP Image Format'} #
fixed_dpi = Aucun #
flush_events ( ) [source] #

Videz les événements GUI pour la figure.

Les backends interactifs doivent réimplémenter cette méthode.

get_default_filename ( ) [source] #

Renvoie une chaîne, qui inclut l'extension, pouvant être utilisée comme nom de fichier par défaut.

méthode de classe get_default_filetype ( ) [source] #

Renvoie le format de fichier savefig par défaut tel que spécifié dans rcParams["savefig.format"](par défaut : 'png').

La chaîne renvoyée n'inclut pas de point. Cette méthode est remplacée dans les backends qui ne prennent en charge qu'un seul type de fichier.

méthode de classe get_supported_filetypes ( ) [ source] #

Renvoie le dict des formats de fichiers savefig pris en charge par ce backend.

méthode de classe get_supported_filetypes_grouped ( ) [ source] #

Renvoie un dict des formats de fichiers savefig pris en charge par ce backend, où les clés sont un nom de type de fichier, tel que 'Joint Photographic Experts Group', et les valeurs sont une liste d'extensions de nom de fichier utilisées pour ce type de fichier, telles que ['jpg' , 'jpeg'].

get_width_height ( * , physique = False ) [source] #

Renvoie la largeur et la hauteur de la figure en points entiers ou en pixels.

Lorsque le chiffre est utilisé sur des écrans High DPI (et que le backend le prend en charge), la troncation en nombres entiers se produit après mise à l'échelle par le rapport de pixels de l'appareil.

Paramètres :
physique booléen, par défaut : False

S'il faut renvoyer de vrais pixels physiques ou des pixels logiques. Les pixels physiques peuvent être utilisés par les backends qui prennent en charge HiDPI, mais configurent toujours le canevas en utilisant sa taille réelle.

Retours :
largeur, hauteur entière

La taille de la figure, en points ou en pixels, selon le backend.

grab_mouse ( hache ) [source] #

Définissez l'enfant Axesqui saisit les événements de la souris.

Habituellement appelé par les widgets eux-mêmes. C'est une erreur d'appeler ceci si la souris est déjà saisie par un autre Axe.

inaxes ( xy ) [source] #

Renvoie le visible le plus haut Axescontenant le point xy .

Paramètres :
xy (flottant, flottant)

(x, y) positions des pixels à partir de la gauche/du bas du canevas.

Retours :
Axesou Aucun

Les axes visibles les plus élevés contenant le point, ou Aucun s'il n'y a pas d'axes au point.

is_saving ( ) [source] #

Renvoie si le moteur de rendu est en train d'enregistrer dans un fichier, plutôt que d'effectuer un rendu pour un tampon à l'écran.

key_press_event ( clé , guiEvent = Aucun ) [source] #

[ Obsolète ] Passez a KeyEventà toutes les fonctions connectées à key_press_event.

Remarques

Obsolète depuis la version 3.6 : utilisez callbacks.process('key_press_event', KeyEvent(...)) à la place.

key_release_event ( clé , guiEvent = Aucun ) [source] #

[ Obsolète ] Passez a KeyEventà toutes les fonctions connectées à key_release_event.

Remarques

Obsolète depuis la version 3.6 : utilisez callbacks.process('key_release_event', KeyEvent(...)) à la place.

leave_notify_event ( guiEvent = Aucun ) [source] #

[ Obsolète ] Traitement de rappel pour le curseur de la souris quittant le canevas.

Les classes dérivées du backend doivent appeler cette fonction lorsqu'elles quittent le canevas.

Paramètres :
guiEvent

L'événement d'interface utilisateur natif qui a généré l'événement Matplotlib.

Remarques

Obsolète depuis la version 3.6 : utilisez plutôt callbacks.process('leave_notify_event', LocationEvent(...)).

manager_class [source] #

pseudonyme deFigureManagerBase

motion_notify_event ( x , y , guiEvent = Aucun ) [source] #

[ Obsolète ] Traitement de rappel pour les événements de mouvement de la souris.

Les classes dérivées du backend doivent appeler cette fonction sur tout événement de notification de mouvement.

Cette méthode appellera toutes les fonctions connectées au 'motion_notify_event' avec une MouseEventinstance.

Paramètres :
x flotteur

Le canevas coordonne où 0=gauche.

je flotte

Le canevas coordonne où 0 = bas.

guiEvent

L'événement d'interface utilisateur natif qui a généré l'événement Matplotlib.

Remarques

Obsolète depuis la version 3.6 : utilisez callbacks.process('motion_notify_event', MouseEvent(...)) à la place.

mpl_connect ( s , func ) [source] #

Lie la fonction func à l'événement s .

Paramètres :
s str

L'un des ID d'événement suivants :

  • 'bouton_press_event'

  • 'bouton_release_event'

  • 'draw_event'

  • 'key_press_event'

  • 'key_release_event'

  • 'motion_notify_event'

  • 'choisir_événement'

  • 'resize_event'

  • 'scroll_event'

  • 'figure_enter_event',

  • 'figure_leave_event',

  • 'axes_enter_event',

  • 'axes_leave_event'

  • 'fermer_événement'.

fonction appelable

La fonction callback à exécuter, qui doit avoir la signature :

def func(event: Event) -> Any

Pour les événements de localisation (appui/relâchement de bouton et de touche), si la souris est sur les Axes, l' inaxesattribut de l'événement sera défini sur Axesl'événement se produit est terminé, et en plus, les variables xdataet les ydataattributs seront définis sur la souris emplacement en coordonnées de données. Voir KeyEvent et MouseEventpour plus d'informations.

Retours :
cid

Un identifiant de connexion qui peut être utilisé avec FigureCanvasBase.mpl_disconnect.

Exemples

def on_press(event):
    print('you pressed', event.button, event.xdata, event.ydata)

cid = canvas.mpl_connect('button_press_event', on_press)
mpl_disconnect ( cid ) [source] #

Déconnectez le rappel avec l'id cid .

Exemples

cid = canvas.mpl_connect('button_press_event', on_press)
# ... later
canvas.mpl_disconnect(cid)
méthode de classe new_manager ( figure , num ) [ source] #

Créez un nouveau gestionnaire de figures pour figure , en utilisant cette classe canvas.

Remarques

Cette méthode ne doit pas être réimplémentée dans les sous-classes. Si une logique de création de gestionnaire personnalisé est nécessaire, veuillez réimplémenter FigureManager.create_with_canvas.

new_timer ( intervalle = Aucun , rappels = Aucun ) [source] #

Créez une nouvelle sous-classe spécifique au backend de Timer.

Ceci est utile pour obtenir des événements périodiques via la boucle d'événements native du backend. Implémenté uniquement pour les backends avec des interfaces graphiques.

Paramètres :
intervalle entier

Intervalle de minuterie en millisecondes.

liste de rappels [tuple[callable, tuple, dict]]

Séquence de (func, args, kwargs) où sera exécutée par le timer à chaque intervalle .func(*args, **kwargs)

Rappels qui reviennent Falseou 0seront supprimés de la minuterie.

Exemples

>>> timer = fig.canvas.new_timer(callbacks=[(f1, (1,), {'a': 3})])
pick ( mouseevent ) [source] #

[ Obsolète ]

Remarques

Obsolète depuis la version 3.6 : utilisez plutôt canvas.figure.pick.

pick_event ( mouseevent , artist , ** kwargs ) [source] #

[ Obsolète ] Traitement de rappel pour les événements de sélection.

Cette méthode sera appelée par les artistes sélectionnés et déclenchera des PickEventrappels des auditeurs enregistrés.

Notez que les artistes ne sont pas sélectionnables par défaut (voir Artist.set_picker).

Remarques

Obsolète depuis la version 3.6 : utilisez callbacks.process('pick_event', PickEvent(...)) à la place.

print_figure ( filename , dpi = None , facecolor = None , edgecolor = None , orientation = 'portrait' , format = None , * , bbox_inches = None , pad_inches = None , bbox_extra_artists = None , backend = None , ** kwargs ) [source ] #

Rendre la figure sur papier. Définissez les couleurs de face et de bord du patch de la figure. Ceci est utile car certaines des interfaces graphiques ont un arrière-plan de couleur grise et vous souhaiterez probablement remplacer cela sur la copie papier.

Paramètres :
nom de fichier str ou comme chemin ou comme fichier

Le fichier où la figure est enregistrée.

ppp flottant, par défaut : rcParams["savefig.dpi"](par défaut : 'figure')

Les points par pouce pour enregistrer la figure.

couleur de facecolor ou 'auto', par défaut : rcParams["savefig.facecolor"](par défaut : 'auto')

La couleur de face de la figure. Si 'auto', utilise la couleur de face actuelle de la figure.

edgecolor color ou 'auto', par défaut : rcParams["savefig.edgecolor"](par défaut : 'auto')

La couleur de bord de la figure. Si 'auto', utilise la couleur de bord actuelle de la figure.

orientation {'paysage', 'portrait'}, par défaut : 'portrait'

Ne s'applique actuellement qu'à l'impression PostScript.

chaîne de format , facultatif

Forcer un format de fichier spécifique. S'il n'est pas fourni, le format est déduit de l' extension du nom de fichierrcParams["savefig.format"] et, en cas d'échec, de (par défaut : 'png').

bbox_inches 'serré' ou Bbox, par défaut : rcParams["savefig.bbox"](par défaut : None)

Boîte englobante en pouces : seule la partie donnée de la figure est enregistrée. Si 'serré', essayez de trouver la bbox serrée de la figure.

pad_inches flottant, par défaut : rcParams["savefig.pad_inches"](par défaut : 0.1)

Quantité de rembourrage autour de la figure lorsque bbox_inches est 'serré'.

bbox_extra_artists liste de Artist, facultatif

Une liste d'artistes supplémentaires qui seront pris en compte lors du calcul de la bbox serrée.

backend str, facultatif

Utilisez un backend non par défaut pour rendre le fichier, par exemple pour rendre un fichier png avec le backend "cairo" plutôt que le "agg" par défaut, ou un fichier pdf avec le backend "pgf" plutôt que le "pdf" par défaut. Notez que le backend par défaut est normalement suffisant. Voir Les backends intégrés pour une liste des backends valides pour chaque format de fichier. Les backends personnalisés peuvent être référencés comme "module://...".

release_mouse ( ax ) [source] #

Relâchez la poignée de la souris tenue par la hache .Axes

Habituellement appelé par les widgets. C'est correct d'appeler cela même si ax n'a pas la souris pour le moment.

required_interactive_framework = Aucun #
redimensionner ( w , h ) [source] #

INUTILISÉ : définissez la taille du canevas en pixels.

Certains backends peuvent implémenter une méthode similaire en interne, mais ce n'est pas une exigence ni n'est utilisé par Matplotlib lui-même.

resize_event ( ) [source] #

[ Obsolète ] Passez a ResizeEventà toutes les fonctions connectées à resize_event.

Remarques

Obsolète depuis la version 3.6 : utilisez plutôt callbacks.process('resize_event', ResizeEvent(...)).

scroll_event ( x , y , step , guiEvent = None ) [source] #

[ Obsolète ] Traitement de rappel pour les événements de défilement.

Les classes dérivées backend doivent appeler cette fonction sur n'importe quel événement de molette de défilement. ( x , y ) sont les coordonnées du canevas ((0, 0) est en bas à gauche). le bouton et la touche sont tels que définis dans MouseEvent.

Cette méthode appellera toutes les fonctions connectées au 'scroll_event' avec une MouseEventinstance.

Remarques

Obsolète depuis la version 3.6 : utilisez callbacks.process('scroll_event', MouseEvent(...)) à la place.

propriété scroll_pick_id #
set_cursor ( curseur ) [source] #

Définissez le curseur actuel.

Cela peut n'avoir aucun effet si le backend n'affiche rien.

Si le backend l'exige, cette méthode doit déclencher une mise à jour dans la boucle d'événements du backend après la définition du curseur, car cette méthode peut être appelée, par exemple, avant une tâche de longue durée au cours de laquelle l'interface graphique n'est pas mise à jour.

Paramètres :
le curseurCursors

Curseur à afficher sur le canevas. Remarque : certains backends peuvent changer le curseur pour toute la fenêtre.

start_event_loop ( timeout = 0 ) [source] #

Démarrer une boucle d'événements bloquants.

Une telle boucle d'événements est utilisée par des fonctions interactives, telles que ginputet waitforbuttonpress, pour attendre des événements.

La boucle d'événements se bloque jusqu'à ce qu'une fonction de rappel se déclenche stop_event_loopou que le délai d' attente soit atteint.

Si timeout est 0 ou négatif, jamais timeout.

Seuls les backends interactifs doivent réimplémenter cette méthode et elle repose sur flush_eventsune implémentation correcte.

Les backends interactifs devraient implémenter cela de manière plus native.

stop_event_loop ( ) [source] #

Arrête la boucle d'événements de blocage en cours.

Les backends interactifs doivent réimplémenter cela pour correspondre start_event_loop

supports_blit = Faux #
switch_backends ( FigureCanvasClass ) [source] #

Instancier une instance de FigureCanvasClass

Ceci est utilisé pour la commutation backend, par exemple, pour instancier un FigureCanvasPS à partir d'un FigureCanvasGTK. Notez que la copie en profondeur n'est pas effectuée, donc toute modification apportée à l'une des instances (par exemple, la définition de la taille de la figure ou des accessoires de ligne) sera reflétée dans l'autre

classe matplotlib.backend_bases. FigureManagerBase ( canvas , num ) [source] #

Socles :object

Une abstraction indépendante du backend d'un conteneur de figures et d'un contrôleur.

Le gestionnaire de figures est utilisé par pyplot pour interagir avec la fenêtre de manière indépendante du backend. C'est un adaptateur pour le cadre réel (GUI) qui représente la figure visuelle à l'écran.

Les backends de l'interface graphique définissent à partir de cette classe pour traduire les opérations courantes telles que l' affichage ou le redimensionnement en code spécifique à l'interface graphique. Les backends non GUI ne prennent pas en charge ces opérations et peuvent simplement utiliser la classe de base.

Les opérations de base suivantes sont accessibles :

Opérations de fenêtre

Gestion des pressions sur les touches et les boutons de la souris

Le gestionnaire de figures configure la gestion par défaut des touches et des boutons de la souris key_press_handleren connectant le au système d'événements matplotlib. Cela garantit les mêmes raccourcis et actions de la souris sur tous les backends.

Autres opérations

Les sous-classes auront des attributs et des fonctions supplémentaires pour accéder à des fonctionnalités supplémentaires. Ceci est bien sûr spécifique au backend. Par exemple, la plupart des backends GUI ont windowet des toolbarattributs qui donnent accès aux widgets GUI natifs du framework respectif.

Attributs :
ToileFigureCanvasBase

L'instance de canevas spécifique au backend.

num int ou str

Le numéro du chiffre.

key_press_handler_id entier

Le cid du gestionnaire de clé par défaut, lors de l'utilisation du toolmanager. Pour désactiver la gestion par défaut des touches, utilisez :

figure.canvas.mpl_disconnect(
    figure.canvas.manager.key_press_handler_id)
button_press_handler_id entier

Le cid du gestionnaire de bouton de la souris par défaut, lors de l'utilisation du gestionnaire d'outils. Pour désactiver la gestion des appuis sur les boutons par défaut, utilisez :

figure.canvas.mpl_disconnect(
    figure.canvas.manager.button_press_handler_id)
classmethod create_with_canvas ( canvas_class , figure , num ) [source] #

Créez un gestionnaire pour une figure donnée en utilisant un canvas_class spécifique .

Les backends doivent remplacer cette méthode s'ils ont des besoins spécifiques pour configurer le canevas ou le gestionnaire.

détruire ( ) [source] #
full_screen_toggle ( ) [source] #
get_window_title ( ) [source] #

Renvoie le texte du titre de la fenêtre contenant la figure, ou None s'il n'y a pas de fenêtre (par exemple, un backend PS).

redimensionner ( w , h ) [source] #

Pour les backends GUI, redimensionnez la fenêtre (en pixels physiques).

set_window_title ( titre ) [source] #

Définissez le texte du titre de la fenêtre contenant la figure.

Cela n'a aucun effet pour les backends non GUI (par exemple, PS).

afficher ( ) [source] #

Pour les backends GUI, affichez la fenêtre de la figure et redessinez. Pour les backends non GUI, déclenchez une exception, à moins qu'ils ne s'exécutent sans tête (c'est-à-dire sous Linux avec un DISPLAY non défini) ; cette exception est convertie en avertissement dans Figure.show.

classe matplotlib.backend_bases. GraphicsContextBase [source] #

Socles :object

Une classe de base abstraite qui fournit la couleur, les styles de ligne, etc.

copy_properties ( gc ) [source] #

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

get_alpha ( ) [source] #

Renvoie la valeur alpha utilisée pour le mélange - non pris en charge sur tous les backends.

get_antialiased ( ) [source] #

Indique si l'objet doit essayer d'effectuer un rendu anticrénelé.

get_capstyle ( ) [source] #

Retournez le CapStyle.

get_clip_path ( ) [source] #

Renvoie le chemin du clip sous la forme (path, transform), où path est une Pathinstance et transform est une transformation affine à appliquer au chemin avant le découpage.

get_clip_rectangle ( ) [source] #

Renvoie le rectangle du clip en tant Bboxqu'instance.

get_dashes ( ) [source] #

Renvoie le style de tiret sous la forme d'une paire (décalage, liste de tirets).

Voir set_dashespour plus de détails.

La valeur par défaut est (Aucun, Aucun).

get_forced_alpha ( ) [source] #

Renvoie si la valeur donnée par get_alpha() doit être utilisée pour remplacer toute autre valeur de canal alpha.

get_gid ( ) [source] #

Renvoie l'identifiant de l'objet s'il est défini, Aucun sinon.

get_hatch ( ) [source] #

Obtenez le style de hachures actuel.

get_hatch_color ( ) [source] #

Obtenez la couleur des hachures.

get_hatch_linewidth ( ) [source] #

Obtenez la largeur de ligne de hachures.

get_hatch_path ( densité = 6.0 ) [source] #

Renvoie a Pathpour la hachure actuelle.

get_joinstyle ( ) [source] #

Retournez le JoinStyle.

get_linewidth ( ) [source] #

Renvoie la largeur de la ligne en points.

get_rgb ( ) [source] #

Renvoie un tuple de trois ou quatre flottants de 0 à 1.

get_sketch_params ( ) [source] #

Renvoyer les paramètres d'esquisse pour l'artiste.

Retours :
tuple ouNone

Un 3-uplet avec les éléments suivants :

  • scale: L'amplitude de l'oscillation perpendiculaire à la ligne source.

  • length: La longueur de l'agitation le long de la ligne.

  • randomness: Le facteur d'échelle par lequel la longueur est réduite ou agrandie.

Peut revenir Nonesi aucun paramètre d'esquisse n'a été défini.

get_snap ( ) [source] #

Renvoyer le paramètre d'accrochage, qui peut être :

  • Vrai : aligner les sommets sur le centre du pixel le plus proche

  • Faux : laissez les sommets tels quels

  • Aucun : (auto) si le chemin ne contient que des segments de ligne rectilignes, arrondir au centre du pixel le plus proche

get_url ( ) [source] #

Renvoie une url si elle est définie, None sinon.

restaurer ( ) [source] #

Restaurez le contexte graphique à partir de la pile - nécessaire uniquement pour les backends qui enregistrent les contextes graphiques sur une pile.

set_alpha ( alpha ) [source] #

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

Si alpha=None(valeur par défaut), les composants alpha des couleurs de premier plan et de remplissage seront utilisés pour définir leurs transparences respectives (le cas échéant) ; sinon, alphales remplacera.

set_antialiased ( b ) [source] #

Définissez si l'objet doit être dessiné avec un rendu anticrénelé.

set_capstyle ( cs ) [source] #

Définissez comment dessiner les extrémités des lignes.

Paramètres :
cs CapStyleou {'butt', 'projecting', 'round'}
set_clip_path ( chemin ) [source] #

Définissez le chemin du clip sur a TransformedPathou Aucun.

set_clip_rectangle ( rectangle ) [source] #

Définissez le rectangle du clip sur a Bboxou Aucun.

set_dashes ( dash_offset , dash_list ) [source] #

Définissez le style de tiret pour le gc.

Paramètres :
dash_offset flottant

Distance, en points, dans le modèle de pointillés à laquelle commencer le modèle. Il est généralement défini sur 0.

dash_list type tableau ou Aucun

La séquence marche-arrêt sous forme de points. Aucun spécifie une ligne continue. Sinon, toutes les valeurs doivent être non négatives (\(\ge 0\)).

Remarques

Voir p. 666 de la référence du langage PostScript pour plus d'informations.

set_foreground ( fg , isRGBA = False ) [source] #

Définissez la couleur de premier plan.

Paramètres :
couleur fg
isRGBA booléen

Si fg est connu pour être un tuple, isRGBA peut être défini sur True pour améliorer les performances.(r, g, b, a)

set_gid ( id ) [source] #

Définissez l'identifiant.

set_hatch ( hachure ) [source] #

Définissez le style de hachures (pour les remplissages).

set_hatch_color ( hatch_color ) [source] #

Définissez la couleur des hachures.

set_joinstyle ( js ) [source] #

Définissez comment dessiner les connexions entre les segments de ligne.

Paramètres :
js JoinStyleou {'miter', 'round', 'bevel'}
set_linewidth ( w ) [source] #

Définissez la largeur de ligne en points.

set_sketch_params ( scale = None , length = None , randomness = None ) [source] #

Définissez les paramètres d'esquisse.

Paramètres :
flotteur d'échelle , en option

L'amplitude de l'oscillation perpendiculaire à la ligne source, en pixels. Si l'échelle est Noneou n'est pas fournie, aucun filtre d'esquisse ne sera fourni.

longueur flottante, par défaut : 128

La longueur de l'oscillation le long de la ligne, en pixels.

flottant aléatoire , par défaut : 16

Le facteur d'échelle par lequel la longueur est réduite ou agrandie.

set_snap ( snap ) [source] #

Définissez le paramètre d'accrochage qui peut être :

  • Vrai : aligner les sommets sur le centre du pixel le plus proche

  • Faux : laissez les sommets tels quels

  • Aucun : (auto) si le chemin ne contient que des segments de ligne rectilignes, arrondir au centre du pixel le plus proche

set_url ( url ) [source] #

Définissez l'URL des liens dans les backends compatibles.

classe matplotlib.backend_bases. KeyEvent ( nom , canevas , clé , x = 0 , y = 0 , guiEvent = Aucun ) [source] #

Socles :LocationEvent

Un événement clé (touche enfoncée, touche relâchée).

Un KeyEvent a un certain nombre d'attributs spéciaux en plus de ceux définis par le parent Eventet les LocationEventclasses.

Remarques

Les touches de modification seront préfixées à la touche enfoncée et seront dans l'ordre "ctrl", "alt", "super". L'exception à cette règle est lorsque la touche enfoncée est elle-même une touche de modification, donc "ctrl+alt" et "alt+control" peuvent tous deux être des valeurs de touche valides.

Exemples

def on_key(event):
    print('you pressed', event.key, event.xdata, event.ydata)

cid = fig.canvas.mpl_connect('key_press_event', on_key)
Attributs :
clé Aucun ou str

La ou les touches enfoncées. Peut être None , un seul caractère Unicode sensible à la casse ("g", "G", "#", etc.), une touche spéciale ("control", "shift", "f1", "up", etc.) ou une combinaison des éléments ci-dessus (par exemple, "ctrl+alt+g", "ctrl+alt+G").

classe matplotlib.backend_bases. LocationEvent ( name , canvas , x , y , guiEvent = None ) [source] #

Socles :Event

Un événement qui a un emplacement d'écran.

Un LocationEvent a un certain nombre d'attributs spéciaux en plus de ceux définis par la Eventclasse parent.

Attributs :
x, y entier ou Aucun

Emplacement de l'événement en pixels à partir du bas à gauche du canevas.

inaxes Axesou Aucun

L' Axesinstance sur laquelle se trouve la souris, le cas échéant.

xdata, ydata float ou None

Coordonnées des données de la souris dans inaxes , ou None si la souris n'est pas sur un Axes.

dernier événement = Aucun #
classe matplotlib.backend_bases. MouseButton ( valeur ) [source] #

Socles :IntEnum

Une énumération.

RETOUR = 8 [source] #
AVANT = 9 [source] #
GAUCHE = 1 [source] #
MILIEU = 2 [source] #
DROITE = 3 [source] #
classe matplotlib.backend_bases. MouseEvent ( name , canvas , x , y , button = None , key = None , step = 0 , dblclick = False , guiEvent = None ) [source] #

Socles :LocationEvent

Un événement de souris ('button_press_event', 'button_release_event', 'scroll_event', 'motion_notify_event').

Un MouseEvent a un certain nombre d'attributs spéciaux en plus de ceux définis par le parent Eventet les LocationEventclasses.

Exemples

def on_press(event):
    print('you pressed', event.button, event.xdata, event.ydata)

cid = fig.canvas.mpl_connect('button_press_event', on_press)
Attributs :
bouton Aucun ou MouseButtonou {'up', 'down'}

Le bouton enfoncé. 'up' et 'down' sont utilisés pour les événements de défilement.

Notez que GAUCHE et DROITE se réfèrent en fait aux boutons "primaire" et "secondaire", c'est-à-dire que si l'utilisateur inverse ses boutons gauche et droit ("réglage gaucher") alors le bouton GAUCHE sera celui physiquement à droite.

Si ce n'est pas défini, le nom est "scroll_event", et l'étape est différente de zéro, alors cela sera défini sur "up" ou "down" selon le signe de step .

clé Aucun ou str

La touche enfoncée lorsque l'événement de la souris s'est déclenché, par exemple 'shift'. Voir KeyEvent.

Avertissement

Cette clé est actuellement obtenue à partir du dernier 'key_press_event' ou 'key_release_event' qui s'est produit dans le canevas. Ainsi, si le dernier changement d'état du clavier s'est produit alors que le canevas n'avait pas le focus, cet attribut sera erroné.

flotteur d' étape

Le nombre de pas de défilement (positif pour 'up', négatif pour 'down'). Cela s'applique uniquement à 'scroll_event' et par défaut à 0 sinon.

dblclick booléen

Indique si l'événement est un double-clic. Cela ne s'applique qu'à 'button_press_event' et vaut False sinon. En particulier, il n'est pas utilisé dans 'button_release_event'.

classe matplotlib.backend_bases. Barre d'outils de navigation2 ( canevas ) [source] #

Socles :object

Classe de base pour le curseur de navigation, version 2.

Les backends doivent implémenter un canevas qui gère les connexions pour 'button_press_event' et 'button_release_event'. Voir FigureCanvasBase.mpl_connect()pour plus d'informations.

Ils doivent aussi définir

save_figure()

enregistrer le chiffre actuel

draw_rubberband()(optionnel)

dessinez le zoom pour rectifier le rectangle "rubberband"

set_message()(optionnel)

afficher le message

set_history_buttons()(optionnel)

vous pouvez modifier les boutons de retour / avant de l'historique pour indiquer l'état désactivé / activé.

et remplacez __init__pour configurer la barre d'outils - sans oublier d'appeler la classe de base init. En règle générale, __init__il faut configurer des boutons de barre d'outils connectés aux méthodes home, back, forward, pan, zoomet save_figureet en utilisant des icônes standard dans le sous-répertoire "images" du chemin de données.

Voilà, nous ferons le reste !

retour ( * arguments ) [source] #

Remontez la pile des limites de vue.

Pour la commodité d'être directement connecté en tant que rappel d'interface graphique, qui reçoit souvent des paramètres supplémentaires, cette méthode accepte des paramètres arbitraires, mais ne les utilise pas.

configure_subplots ( * args ) [source] #
drag_pan ( événement ) [source] #

Rappel pour faire glisser en mode panoramique/zoom.

drag_zoom ( événement ) [source] #

Rappel pour faire glisser en mode zoom.

draw_rubberband ( événement , x0 , y0 , x1 , y1 ) [source] #

Dessinez un rectangle élastique pour indiquer les limites de zoom.

Notez qu'il n'est pas garanti que et .x0 <= x1y0 <= y1

avant ( * args ) [source] #

Avancez dans la pile des limites de vue.

Pour la commodité d'être directement connecté en tant que rappel d'interface graphique, qui reçoit souvent des paramètres supplémentaires, cette méthode accepte des paramètres arbitraires, mais ne les utilise pas.

maison ( * args ) [source] #

Restaurer la vue d'origine.

Pour la commodité d'être directement connecté en tant que rappel d'interface graphique, qui reçoit souvent des paramètres supplémentaires, cette méthode accepte des paramètres arbitraires, mais ne les utilise pas.

mouse_move ( événement ) [source] #
panoramique ( * arguments ) [source] #

Basculer l'outil panoramique/zoom.

Panoramique avec le bouton gauche, zoom avec la droite.

press_pan ( événement ) [source] #

Rappel pour l'appui sur le bouton de la souris en mode panoramique/zoom.

press_zoom ( événement ) [source] #

Rappel pour l'appui sur le bouton de la souris en zoom en mode rect.

push_current ( ) [source] #

Repoussez les limites de la vue actuelle et positionnez-vous sur la pile.

release_pan ( événement ) [source] #

Rappel pour le relâchement du bouton de la souris en mode panoramique/zoom.

release_zoom ( événement ) [source] #

Rappel pour le relâchement du bouton de la souris en mode zoom vers rect.

remove_rubberband ( ) [source] #

Retirez l'élastique.

save_figure ( * args ) [source] #

Enregistrez la figure actuelle.

set_cursor ( curseur ) [source] #

[ Obsolète ] Définissez le curseur actuel sur l'une des Cursorsvaleurs d'énumération.

Si le backend l'exige, cette méthode doit déclencher une mise à jour dans la boucle d'événements du backend après la définition du curseur, car cette méthode peut être appelée, par exemple, avant une tâche de longue durée au cours de laquelle l'interface graphique n'est pas mise à jour.

Remarques

Obsolète depuis la version 3.5 : utilisez à la FigureCanvasBase.set_cursorplace.

set_history_buttons ( ) [source] #

Activez ou désactivez le bouton Précédent/Suivant.

set_message ( s ) [source] #

Afficher un message sur la barre d'outils ou dans la barre d'état.

toolitems = (('Home', 'Reset original view', 'home', 'home'), ('Back', 'Retour à la vue précédente ', 'back', 'back'), ('Forward', ' Passer à la vue suivante ', 'avant', 'avant'), (Aucun, Aucun, Aucun, Aucun), ('Pan', 'Le bouton gauche effectue un panoramique, le bouton droit zoome \nx/y fixe l' axe, CTRL fixe l'aspect', 'bouger', 'panoramique'),('Zoom', 'Zoom sur rectangle\nx/y fixe l'axe', 'zoom_to_rect', 'zoom'), ('Subplots', 'Configure subplots' , 'subplots' , 'configure_subplots'), (None, None, None, None), ('Save', 'Save the figure', 'filesave', 'save_figure')) #
mettre à jour ( ) [source] #

Réinitialisez la pile des haches.

zoom ( * arguments ) [source] #
exception matplotlib.backend_bases. NonGuiException [source] #

Socles :Exception

Déclenché lors de la tentative d'affichage d'une figure dans un backend non graphique.

classe matplotlib.backend_bases. PickEvent ( name , canvas , mouseevent , artist , guiEvent = None , ** kwargs ) [source] #

Socles :Event

Un événement de choix.

Cet événement est déclenché lorsque l'utilisateur sélectionne un emplacement sur la toile suffisamment proche d'un artiste qui a été rendu sélectionnable avec Artist.set_picker.

Un PickEvent a un certain nombre d'attributs spéciaux en plus de ceux définis par la Eventclasse parent.

Exemples

Liez une fonction on_pick()pour sélectionner des événements, qui imprime les coordonnées du point de données sélectionné :

ax.plot(np.rand(100), 'o', picker=5)  # 5 points tolerance

def on_pick(event):
    line = event.artist
    xdata, ydata = line.get_data()
    ind = event.ind
    print('on pick line:', np.array([xdata[ind], ydata[ind]]).T)

cid = fig.canvas.mpl_connect('pick_event', on_pick)
Attributs :
événement de sourisMouseEvent

L'événement de souris qui a généré le choix.

artistematplotlib.artist.Artist

L'artiste choisi. Notez que les artistes ne sont pas sélectionnables par défaut (voir Artist.set_picker).

autre

Des attributs supplémentaires peuvent être présents selon le type de l'objet sélectionné ; par exemple, un Line2Dchoix peut définir des attributs supplémentaires différents d'un PatchCollectionchoix.

classe matplotlib.backend_bases. RendererBase [source] #

Socles :object

Une classe de base abstraite pour gérer les opérations de dessin/rendu.

Les méthodes suivantes doivent être implémentées dans le backend pour une fonctionnalité complète (bien que la simple implémentation draw_pathseule donnerait un backend très performant):

Les méthodes suivantes doivent être implémentées dans le backend pour des raisons d'optimisation :

close_group ( s ) [source] #

Ferme un élément de regroupement avec l'étiquette s .

Utilisé uniquement par le moteur de rendu SVG.

draw_gouraud_triangle ( gc , points , colors , transform ) [source] #

Dessinez un triangle ombré de Gouraud.

Paramètres :
gcGraphicsContextBase

Le contexte graphique.

points (3, 2) en forme de tableau

Tableau de (x, y) points pour le triangle.

couleurs (3, 4) en forme de tableau

Couleurs RGBA pour chaque point du triangle.

transformermatplotlib.transforms.Transform

Une transformation affine à appliquer aux points.

draw_gouraud_triangles ( gc , triangles_array , colors_array , transform ) [source] #

Dessinez une série de triangles de Gouraud.

Paramètres :
points (N, 3, 2) en forme de tableau

Tableau de N (x, y) points pour les triangles.

couleurs (N, 3, 4) en forme de tableau

Tableau de N couleurs RGBA pour chaque point des triangles.

transformermatplotlib.transforms.Transform

Une transformation affine à appliquer aux points.

draw_image ( gc , x , y , im , transform = None ) [source] #

Dessinez une image RGBA.

Paramètres :
gcGraphicsContextBase

Un contexte graphique avec des informations de découpage.

x scalaire

La distance en unités physiques (c'est-à-dire, points ou pixels) depuis le côté gauche du canevas.

y scalaire

La distance en unités physiques (c'est-à-dire, points ou pixels) depuis le bas du canevas.

im (N, M, 4) comme un tableau de np.uint8

Un tableau de pixels RGBA.

transformermatplotlib.transforms.Affine2DBase

Si et seulement si le backend concret est écrit de telle sorte que option_scale_imagerenvoie True, une transformation affine (c'est-à-dire un Affine2DBase) peut être passée à draw_image. Le vecteur de translation de la transformation est donné en unités physiques (c'est-à-dire points ou pixels). Notez que la transformation ne remplace pas x et y , et doit être appliquée avant de traduire le résultat par x et y (cela peut être accompli en ajoutant x et y au vecteur de translation défini par transform ).

draw_markers ( gc , marker_path , marker_trans , path , trans , rgbFace = None ) [source] #

Dessinez un marqueur à chacun des sommets du chemin (à l'exclusion des points de contrôle).

L'implémentation de base (de secours) effectue plusieurs appels à draw_path. Les backends peuvent souhaiter remplacer cette méthode afin de dessiner le marqueur une seule fois et de le réutiliser plusieurs fois.

Paramètres :
gcGraphicsContextBase

Le contexte graphique.

marqueur_transmatplotlib.transforms.Transform

Une transformation affine appliquée au marqueur.

transmatplotlib.transforms.Transform

Une transformation affine appliquée au chemin.

draw_path ( gc , path , transform , rgbFace = None ) [source] #

Dessinez une Pathinstance à l'aide de la transformation affine donnée.

draw_path_collection ( gc , master_transform , paths , all_transforms , offsets , offset_trans , facecolors , edgecolors , linewidths , linestyles , antialiased , urls , offset_position ) [source] #

Dessinez une collection de chemins .

Chaque chemin est d'abord transformé par l'entrée correspondante dans all_transforms (une liste de matrices (3, 3)) puis par master_transform . Ils sont ensuite traduits par l'entrée correspondante dans offsets , qui a d'abord été transformée par offset_trans .

facecolors , edgecolors , linewidths , linestyles et antialiased sont des listes qui définissent les propriétés correspondantes.

offset_position n'est plus utilisé maintenant, mais l'argument est conservé pour la compatibilité descendante.

L'implémentation de base (de secours) effectue plusieurs appels à draw_path. Les backends peuvent vouloir remplacer cela afin de rendre chaque ensemble de données de chemin une seule fois, puis référencer ce chemin plusieurs fois avec les différents décalages, couleurs, styles, etc. Les méthodes du générateur _iter_collection_raw_pathset _iter_collectionsont fournies pour aider (et normaliser) la mise en œuvre à travers les back-ends. Il est fortement recommandé d'utiliser ces générateurs, afin que les changements de comportement de draw_path_collectionpuissent être effectués globalement.

draw_quad_mesh ( gc , master_transform , meshWidth , meshHeight , coordinates , offsets , offsetTrans , facecolors , antialiased , edgecolors ) [source] #

Dessinez un quadrilatère.

L'implémentation de base (de secours) convertit le quadmesh en chemins, puis appelle draw_path_collection.

draw_tex ( gc , x , y , s , prop , angle , * , mtext = None ) [source] #
draw_text ( gc , x , y , s , prop , angle , ismath = False , mtext = None ) [source] #

Dessinez une instance de texte.

Paramètres :
gcGraphicsContextBase

Le contexte graphique.

x flotteur

L'emplacement x du texte dans les coordonnées d'affichage.

je flotte

L'emplacement y de la ligne de base du texte dans les coordonnées d'affichage.

s str

La chaîne de texte.

soutenirmatplotlib.font_manager.FontProperties

Les propriétés de la police.

flotteur d' angle

L'angle de rotation en degrés dans le sens inverse des aiguilles d'une montre.

textmultmatplotlib.text.Text

L'objet texte d'origine à rendre.

Remarques

Remarque pour les implémenteurs backend :

Lorsque vous essayez de déterminer si vous avez correctement défini votre cadre de délimitation (ce qui permet à la disposition/à l'alignement du texte de fonctionner correctement), il est utile de modifier la ligne dans text.py :

if 0: bbox_artist(self, renderer)

à si 1, puis la zone de délimitation réelle sera tracée avec votre texte.

flipy ( ) [source] #

Renvoie si les valeurs y augmentent de haut en bas.

Notez que cela n'affecte que le dessin des textes.

get_canvas_width_height ( ) [source] #

Renvoie la largeur et la hauteur du canevas dans les coordonnées d'affichage.

get_image_magnification ( ) [source] #

Obtenez le facteur d'agrandissement des images transmises à draw_image. Permet à un backend d'avoir des images à une résolution différente de celle des autres artistes.

get_texmanager ( ) [source] #

Renvoie l' TexManagerinstance.

get_text_width_height_descent ( s , prop , ismath ) [source] #

Obtenez la largeur, la hauteur et la descente (décalage du bas à la ligne de base), dans les coordonnées d'affichage, de la chaîne s avec prop .FontProperties

nouveau_gc ( ) [source] #

Renvoie une instance d'un GraphicsContextBase.

open_group ( s , gid = Aucun ) [source] #

Ouvre un élément de regroupement avec label s et gid (si défini) comme id.

Utilisé uniquement par le moteur de rendu SVG.

option_image_nocomposite ( ) [source] #

Indique si la composition d'image par Matplotlib doit être ignorée.

Les backends raster doivent généralement renvoyer False (laissant le rastériseur de niveau C s'occuper de la composition de l'image); les backends vectoriels doivent généralement renvoyer .not rcParams["image.composite_image"]

option_scale_image ( ) [source] #

Renvoie si les transformations affines arbitraires draw_imagesont prises en charge (True pour la plupart des backends vectoriels).

points_to_pixels ( points ) [source] #

Convertissez des points en unités d'affichage.

Vous devez remplacer cette fonction (sauf si votre backend n'a pas de dpi, par exemple, postscript ou svg). Certains systèmes d'imagerie supposent une certaine valeur pour les pixels par pouce :

points to pixels = points * pixels_per_inch/72 * dpi/72
Paramètres :
les points flottent ou ressemblent à des tableaux

un float ou un tableau numpy de float

Retours :
Points convertis en pixels
start_filter ( ) [source] #

Basculez vers un moteur de rendu temporaire pour les effets de filtrage d'image.

Actuellement uniquement pris en charge par le moteur de rendu agg.

start_rasterizing ( ) [source] #

Basculez vers le rendu raster.

Utilisé par MixedModeRenderer.

stop_filter ( fonction_filtre ) [source] #

Revenez au moteur de rendu d'origine. Le contenu du moteur de rendu temporaire est traité avec filter_func et est dessiné sur le moteur de rendu d'origine sous forme d'image.

Actuellement uniquement pris en charge par le moteur de rendu agg.

stop_rasterizing ( ) [source] #

Revenez au rendu vectoriel et dessinez le contenu du rendu raster sous forme d'image sur le rendu vectoriel.

Utilisé par MixedModeRenderer.

classe matplotlib.backend_bases. ResizeEvent ( nom , canevas ) [source] #

Socles :Event

Un événement déclenché par un redimensionnement du canevas.

Un ResizeEvent a un certain nombre d'attributs spéciaux en plus de ceux définis par la Eventclasse parent.

Attributs :
largeur entière

Largeur du canevas en pixels.

hauteur int

Hauteur de la toile en pixels.

classe matplotlib.backend_bases. AfficherBase [source] #

Socles :_Backend

Classe de base simple pour générer une show()fonction dans les backends.

La sous-classe doit remplacer la mainloop()méthode.

classe matplotlib.backend_bases. TimerBase ( intervalle = Aucun , rappels = Aucun ) [source] #

Socles :object

Une classe de base pour fournir des événements de minuterie, utile pour les animations de choses. Les backends doivent implémenter quelques méthodes spécifiques afin d'utiliser leurs propres mécanismes de synchronisation afin que les événements de minuterie soient intégrés dans leurs boucles d'événements.

Les sous-classes doivent remplacer les méthodes suivantes :

  • _timer_start: code spécifique au backend pour démarrer le minuteur.

  • _timer_stop: code spécifique au backend pour arrêter le minuteur.

Les sous-classes peuvent en outre remplacer les méthodes suivantes :

  • _timer_set_single_shot: Code de réglage du temporisateur en mode de fonctionnement monocoup, si pris en charge par l'objet temporisateur. Si ce n'est pas le cas, la Timer classe elle-même stockera l'indicateur et la _on_timerméthode doit être surchargée pour prendre en charge un tel comportement.

  • _timer_set_interval: code pour définir l'intervalle sur le minuteur, s'il existe une méthode pour le faire sur l'objet minuteur.

  • _on_timer: La fonction interne que tout objet minuterie doit appeler, qui gérera la tâche d'exécution de tous les rappels qui ont été définis.

Paramètres :
intervalle entier, par défaut : 1 000 ms

Le temps entre les événements de minuterie en millisecondes. Sera stocké en tant que timer.interval.

liste de rappels [tuple[callable, tuple, dict]]

Liste des tuples (func, args, kwargs) qui seront appelés lors d'événements de minuterie. Cette liste est accessible au fur et à mesure timer.callbackset peut être manipulée directement, ou les fonctions add_callbacket remove_callbackpeuvent être utilisées.

add_callback ( func , * args , ** kwargs ) [source] #

Enregistrez la fonction à appeler par la minuterie lorsque l'événement se déclenche. Tous les arguments supplémentaires fournis seront passés à func .

Cette fonction retourne func , ce qui permet de l'utiliser comme décorateur.

intervalle de propriété #

Le temps entre les événements de minuterie, en millisecondes.

remove_callback ( func , * args , ** kwargs ) [source] #

Supprimer la fonction de la liste des rappels.

args et kwargs sont facultatifs et utilisés pour distinguer les copies de la même fonction enregistrées pour être appelées avec des arguments différents. Ce comportement est obsolète. À l'avenir, ne sera plus considéré; pour conserver un rappel spécifique amovible par lui-même, transmettez-le à en tant qu'objet.*args, **kwargsadd_callbackfunctools.partial

propriété single_shot #

Indique si cette minuterie doit s'arrêter après une seule exécution.

début ( intervalle = Aucun ) [source] #

Démarrez l'objet minuterie.

Paramètres :
intervalle entier, facultatif

Intervalle de minuterie en millisecondes ; remplace un intervalle défini précédemment s'il est fourni.

arrêter ( ) [source] #

Arrêtez le chronomètre.

classe matplotlib.backend_bases. ToolContainerBase ( gestionnaire d' outils ) [source] #

Socles :object

Classe de base pour tous les conteneurs d'outils, par exemple les barres d'outils.

Attributs :
gestionnaire d'outilsToolManager

Les outils avec lesquels cela ToolContainerveut communiquer.

add_tool ( outil , groupe , position = -1 ) [source] #

Ajouter un outil à ce conteneur.

Paramètres :
outil tool_like

L'outil à ajouter, voir ToolManager.get_tool.

groupe str

Le nom du groupe auquel ajouter cet outil.

position entière, par défaut : -1

La position au sein du groupe pour placer cet outil.

add_toolitem ( nom , groupe , position , image , description , bascule ) [source] #

Ajoutez un outil au conteneur.

Cette méthode doit être implémentée par backend.

Le rappel associé à l'événement de clic sur le bouton doit être exactement self.trigger_tool(name) .

Paramètres :
chaîne de nom

Nom de l'outil à ajouter, il est utilisé comme ID de l'outil et comme étiquette par défaut des boutons.

groupe str

Nom du groupe auquel appartient cet outil.

position entière

Position de l'outil dans son groupe, si -1 il va à la fin.

chaîne d'images

Nom de fichier de l'image pour le bouton ou None.

chaîne de description

Description de l'outil, utilisée pour les info-bulles.

basculer booléen
  • True: Le bouton est une bascule (change l'état enfoncé/non enfoncé entre des clics consécutifs).

  • False: Le bouton est un bouton normal (revient à l'état non enfoncé après avoir été relâché).

remove_toolitem ( nom ) [source] #

Supprimer un élément d'outil du fichier ToolContainer.

Cette méthode doit être implémentée par backend.

Appelé lorsqu'il ToolManagerémet un tool_removed_event.

Paramètres :
chaîne de nom

Nom de l'outil à supprimer.

set_message ( s ) [source] #

Afficher un message sur la barre d'outils.

Paramètres :
s str

Texte des messages.

toggle_toolitem ( nom , basculé ) [source] #

Basculer l'élément d'outil sans événement de déclenchement.

Paramètres :
chaîne de nom

ID de l'outil à basculer.

booléen basculé

Que ce soit pour définir cet outil comme basculé ou non.

trigger_tool ( nom ) [source] #

Déclenchez l'outil.

Paramètres :
chaîne de nom

Nom (id) de l'outil déclenché depuis le conteneur.

matplotlib.backend_bases. button_press_handler ( événement , canevas = Aucun , barre d'outils = Aucun ) [source] #

Les actions de bouton Matplotlib par défaut pour les boutons de souris supplémentaires.

Les paramètres sont les mêmes que pour key_press_handler, sauf que l' événement est un MouseEvent.

matplotlib.backend_bases. get_registered_canvas_class ( format ) [source] #

Renvoie le canevas par défaut enregistré pour le format de fichier donné. Gère l'importation différée du backend requis.

matplotlib.backend_bases. key_press_handler ( événement , canevas = Aucun , barre d'outils = Aucun ) [source] #

Implémentez les raccourcis clavier Matplotlib par défaut pour le canevas et la barre d'outils décrits dans Raccourcis clavier de navigation .

Paramètres :
un événementKeyEvent

Un événement d'appui/relâchement de touche.

canevas FigureCanvasBase, par défaut :event.canvas

L'instance de canevas spécifique au backend. Ce paramètre est conservé pour la rétrocompatibilité, mais, s'il est défini, doit toujours être égal à event.canvas.

barre d'outils NavigationToolbar2, par défaut :event.canvas.toolbar

La barre d'outils du curseur de navigation. Ce paramètre est conservé pour la rétrocompatibilité, mais, s'il est défini, doit toujours être égal à event.canvas.toolbar.

matplotlib.backend_bases. register_backend ( format , backend , description = None ) [source] #

Enregistrez un backend pour enregistrer dans un format de fichier donné.

Paramètres :
chaîne de format

Extension de fichier

chaîne de module backend ou classe canvas

Backend pour gérer la sortie des fichiers

chaîne de description , par défaut : ""

Description du type de fichier.