matplotlib.backend_tools

Les classes de base abstraites définissent les primitives des outils. Ces outils sont utilisés parmatplotlib.backend_managers.ToolManager

ToolBase

Outil simple sans état

ToolToggleBase

Outil qui a deux états, un seul outil Basculer peut être actif à un moment donné pour le même matplotlib.backend_managers.ToolManager

classe matplotlib.backend_tools. AxisScaleBase ( * args , ** kwargs )

Socles :ToolToggleBase

Outil de base pour basculer entre linéaire et logarithmique.

désactiver ( événement = Aucun )

Désactivez l'outil bascule.

triggerappelez cette méthode quand toggledvaut True.

Cela peut arriver dans différentes circonstances.

• Cliquez sur le bouton de l'outil de la barre d'outils.

• Appelez au matplotlib.backend_managers.ToolManager.trigger_tool.

• Un autre ToolToggleBaseoutil dérivé est déclenché (du même ToolManager).

activer ( événement = Aucun )

Activez l'outil bascule.

triggerappelle cette méthode lorsque toggledvaut False.

déclencheur ( expéditeur , événement , données = Aucun )

Appels enableou disablebasés sur toggledla valeur.

classe matplotlib.backend_tools. ConfigureSubplotsBase ( gestionnaire d'outils , nom )

Socles :ToolBase

Outil de base pour la configuration des sous-parcelles.

description = 'Configurer les sous-parcelles'

Description de l'outil.

str: info-bulle utilisée si l'outil est inclus dans une barre d'outils.

image = 'sous-parcelles'

Nom de fichier de l'image.

str: nom de fichier de l'image à utiliser dans une barre d'outils. Si aucun, le nom est utilisé comme étiquette dans le bouton de la barre d'outils.

classe matplotlib.backend_tools. Curseurs ( valeur )

Socles :IntEnum

Types de curseur indépendants du backend.

MAIN = 2

DEPLACER = 4

POINTEUR = 1

RESIZE_HORIZONTAL = 6

RESIZE_VERTICAL = 7

SELECT_REGION = 3

ATTENDRE = 5

classe matplotlib.backend_tools. RubberbandBase ( gestionnaire d'outils , nom )

Socles :ToolBase

Dessinez et retirez un élastique.

draw_rubberband ( * données )

Dessinez un élastique.

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

remove_rubberband ( )

Retirer l'élastique.

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

déclencheur ( expéditeur , événement , données = Aucun )

Appel draw_rubberbandou remove_rubberbandbasé sur les données.

classe matplotlib.backend_tools. SaveFigureBase ( gestionnaire d' outils , nom )

Socles :ToolBase

Outil de base pour la sauvegarde des chiffres.

propriété default_keymap

description = 'Enregistrer la figure'

Description de l'outil.

str: info-bulle utilisée si l'outil est inclus dans une barre d'outils.

image = 'filesave'

Nom de fichier de l'image.

str: nom de fichier de l'image à utiliser dans une barre d'outils. Si aucun, le nom est utilisé comme étiquette dans le bouton de la barre d'outils.

classe matplotlib.backend_tools. SetCursorBase ( * args , ** kwargs )

Socles :ToolBase

Passe au curseur actuel pendant les axes.

Cet outil garde une trace de tous ToolToggleBaseles outils dérivés et appelle set_cursorlorsqu'un outil est déclenché.

set_cursor ( curseur )

[ Obsolète ] Réglez le curseur.

Remarques

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

set_figure ( figure )

classe matplotlib.backend_tools. ToolBack ( gestionnaire d' outils , nom )

Socles :ViewsPositionsBase

Remontez la pile des limites de la vue.

propriété default_keymap

description = 'Retour à la vue précédente '

Description de l'outil.

str: info-bulle utilisée si l'outil est inclus dans une barre d'outils.

image = 'retour'

Nom de fichier de l'image.

str: nom de fichier de l'image à utiliser dans une barre d'outils. Si aucun, le nom est utilisé comme étiquette dans le bouton de la barre d'outils.

classe matplotlib.backend_tools. ToolBase ( gestionnaire d' outils , nom )

Socles :object

Classe d'outil de base.

Un outil de base, implémente uniquement une triggerméthode ou aucune méthode du tout. L'outil est instancié par matplotlib.backend_managers.ToolManager.

canevas de propriété

Le canevas de la figure affectée par cet outil, ou Aucun.

default_keymap = Aucun

Keymap à associer à cet outil.

list[str]: Liste des touches qui déclencheront cet outil lorsqu'un événement d'appui sur une touche est émis le self.figure.canvas. Notez que cet attribut est recherché sur l'instance, et peut donc être une propriété (ceci est utilisé par exemple par les outils intégrés pour charger les rcParams au moment de l'instanciation).

description = Aucune

Description de l'outil.

str: info-bulle utilisée si l'outil est inclus dans une barre d'outils.

détruire ( )

[ Obsolète ] Détruisez l'outil.

Cette méthode est appelée par ToolManager.remove_tool.

Remarques

Obsolète depuis la version 3.6 : utilisez plutôt tool_removed_event.

chiffre de propriété

La figure affectée par cet outil, ou Aucune.

image = Aucun

Nom de fichier de l'image.

str: nom de fichier de l'image à utiliser dans une barre d'outils. Si aucun, le nom est utilisé comme étiquette dans le bouton de la barre d'outils.

nom de la propriété

L'ID d'outil (str, doit être unique parmi les outils d'un gestionnaire d'outils).

set_figure ( figure )

gestionnaire d'outils de propriété

Le ToolManagerqui contrôle cet outil.

déclencheur ( expéditeur , événement , données = Aucun )

Appelé lorsque cet outil est utilisé.

Cette méthode est appelée par ToolManager.trigger_tool.

Paramètres :

un événementEvent

L'événement canevas qui a provoqué l'appel de cet outil.

objet expéditeur

Objet qui a demandé le déclenchement de l'outil.

objet de données

Données supplémentaires.

classe matplotlib.backend_tools. ToolCopyToClipboardBase ( gestionnaire d' outils , nom )

Socles :ToolBase

Outil pour copier la figure dans le presse-papiers.

propriété default_keymap

description = 'Copier la figure de canevas dans le presse-papiers'

Description de l'outil.

str: info-bulle utilisée si l'outil est inclus dans une barre d'outils.

trigger ( * args , ** kwargs )

Appelé lorsque cet outil est utilisé.

Cette méthode est appelée par ToolManager.trigger_tool.

Paramètres :

un événementEvent

L'événement canevas qui a provoqué l'appel de cet outil.

objet expéditeur

Objet qui a demandé le déclenchement de l'outil.

objet de données

Données supplémentaires.

classe matplotlib.backend_tools. ToolCursorPosition ( * args , ** kwargs )

Socles :ToolBase

Envoyer un message avec la position actuelle du pointeur.

Cet outil s'exécute en arrière-plan en signalant la position du curseur.

send_message ( événement )

Appelez matplotlib.backend_managers.ToolManager.message_event.

set_figure ( figure )

classe matplotlib.backend_tools. ToolForward ( gestionnaire d' outils , nom )

Socles :ViewsPositionsBase

Avancez dans la pile des limites de vue.

propriété default_keymap

description = 'Passer à la vue suivante '

Description de l'outil.

str: info-bulle utilisée si l'outil est inclus dans une barre d'outils.

image = 'avant'

Nom de fichier de l'image.

str: nom de fichier de l'image à utiliser dans une barre d'outils. Si aucun, le nom est utilisé comme étiquette dans le bouton de la barre d'outils.

classe matplotlib.backend_tools. ToolFullScreen ( gestionnaire d' outils , nom )

Socles :ToolBase

Outil pour basculer en plein écran.

propriété default_keymap

description = 'Basculer en mode plein écran '

Description de l'outil.

str: info-bulle utilisée si l'outil est inclus dans une barre d'outils.

déclencheur ( expéditeur , événement , données = Aucun )

Appelé lorsque cet outil est utilisé.

Cette méthode est appelée par ToolManager.trigger_tool.

Paramètres :

un événementEvent

L'événement canevas qui a provoqué l'appel de cet outil.

objet expéditeur

Objet qui a demandé le déclenchement de l'outil.

objet de données

Données supplémentaires.

classe matplotlib.backend_tools. ToolGrid ( gestionnaire d' outils , nom )

Socles :ToolBase

Outil pour basculer les grilles principales de la figure.

propriété default_keymap

description = 'Basculer les grilles principales

Description de l'outil.

str: info-bulle utilisée si l'outil est inclus dans une barre d'outils.

déclencheur ( expéditeur , événement , données = Aucun )

Appelé lorsque cet outil est utilisé.

Cette méthode est appelée par ToolManager.trigger_tool.

Paramètres :

un événementEvent

L'événement canevas qui a provoqué l'appel de cet outil.

objet expéditeur

Objet qui a demandé le déclenchement de l'outil.

objet de données

Données supplémentaires.

classe matplotlib.backend_tools. ToolHelpBase ( gestionnaire d' outils , nom )

Socles :ToolBase

propriété default_keymap

description = 'Imprimer la liste des outils , les raccourcis et la description'

Description de l'outil.

str: info-bulle utilisée si l'outil est inclus dans une barre d'outils.

static format_shortcut ( key_sequence )

Convertit une chaîne de raccourci de la notation utilisée dans rc config vers la notation standard pour afficher les raccourcis, par exemple 'ctrl+a' -> 'Ctrl+A'.

image = 'aide'

Nom de fichier de l'image.

str: nom de fichier de l'image à utiliser dans une barre d'outils. Si aucun, le nom est utilisé comme étiquette dans le bouton de la barre d'outils.

classe matplotlib.backend_tools. ToolHome ( gestionnaire d' outils , nom )

Socles :ViewsPositionsBase

Restaurez les limites de vue d'origine.

propriété default_keymap

description = 'Réinitialiser la vue d' origine '

Description de l'outil.

str: info-bulle utilisée si l'outil est inclus dans une barre d'outils.

image = 'maison'

Nom de fichier de l'image.

str: nom de fichier de l'image à utiliser dans une barre d'outils. Si aucun, le nom est utilisé comme étiquette dans le bouton de la barre d'outils.

classe matplotlib.backend_tools. ToolMinorGrid ( gestionnaire d' outils , nom )

Socles :ToolBase

Outil pour basculer entre les grilles majeure et mineure de la figure.

propriété default_keymap

description = 'Basculer les grilles majeures et mineures

Description de l'outil.

str: info-bulle utilisée si l'outil est inclus dans une barre d'outils.

déclencheur ( expéditeur , événement , données = Aucun )

Appelé lorsque cet outil est utilisé.

Cette méthode est appelée par ToolManager.trigger_tool.

Paramètres :

un événementEvent

L'événement canevas qui a provoqué l'appel de cet outil.

objet expéditeur

Objet qui a demandé le déclenchement de l'outil.

objet de données

Données supplémentaires.

classe matplotlib.backend_tools. ToolPan ( * args )

Socles :ZoomPanBase

Déplacez les axes avec la souris gauche, zoomez avec la droite.

curseur = 4

Curseur à utiliser lorsque l'outil est actif.

propriété default_keymap

description = 'Déplacer les axes avec la souris gauche , zoomer avec la droite'

Description de l'outil.

str: info-bulle utilisée si l'outil est inclus dans une barre d'outils.

image = 'déplacer'

Nom de fichier de l'image.

str: nom de fichier de l'image à utiliser dans une barre d'outils. Si aucun, le nom est utilisé comme étiquette dans le bouton de la barre d'outils.

groupe_radio = 'par défaut'

Attribuer au groupe 'radio' comme outils (mutuellement exclusifs).

strqui identifie le groupe ou Aucun s'il n'appartient pas à un groupe.

classe matplotlib.backend_tools. ToolQuit ( gestionnaire d' outils , nom )

Socles :ToolBase

Outil pour appeler la méthode de destruction du gestionnaire de figures.

propriété default_keymap

description = 'Quitter la figure'

Description de l'outil.

str: info-bulle utilisée si l'outil est inclus dans une barre d'outils.

déclencheur ( expéditeur , événement , données = Aucun )

Appelé lorsque cet outil est utilisé.

Cette méthode est appelée par ToolManager.trigger_tool.

Paramètres :

un événementEvent

L'événement canevas qui a provoqué l'appel de cet outil.

objet expéditeur

Objet qui a demandé le déclenchement de l'outil.

objet de données

Données supplémentaires.

classe matplotlib.backend_tools. ToolQuitAll ( gestionnaire d' outils , nom )

Socles :ToolBase

Outil pour appeler la méthode de destruction du gestionnaire de figures.

propriété default_keymap

description = 'Quitter tous les chiffres'

Description de l'outil.

str: info-bulle utilisée si l'outil est inclus dans une barre d'outils.

déclencheur ( expéditeur , événement , données = Aucun )

Appelé lorsque cet outil est utilisé.

Cette méthode est appelée par ToolManager.trigger_tool.

Paramètres :

un événementEvent

L'événement canevas qui a provoqué l'appel de cet outil.

objet expéditeur

Objet qui a demandé le déclenchement de l'outil.

objet de données

Données supplémentaires.

matplotlib.backend_tools. ToolSetCursor

pseudonyme deSetCursorBase

classe matplotlib.backend_tools. ToolToggleBase ( * args , ** kwargs )

Socles :ToolBase

Outil commutable.

Chaque fois qu'il est déclenché, il bascule entre activer et désactiver.

Paramètres :

``*arguments``

Argument de longueur variable à utiliser par l'outil.

``**kwargs``

toggleds'il est présent et vrai, définit l'état initial des arguments du mot-clé arbitraire de l'outil à consommer par l'outil

curseur = Aucun

Curseur à utiliser lorsque l'outil est actif.

default_toggled = Faux

Par défaut de l'état basculé.

désactiver ( événement = Aucun )

Désactivez l'outil bascule.

triggerappelez cette méthode quand toggledvaut True.

Cela peut arriver dans différentes circonstances.

• Cliquez sur le bouton de l'outil de la barre d'outils.

• Appelez au matplotlib.backend_managers.ToolManager.trigger_tool.

• Un autre ToolToggleBaseoutil dérivé est déclenché (du même ToolManager).

activer ( événement = Aucun )

Activez l'outil bascule.

triggerappelle cette méthode lorsque toggledvaut False.

groupe_radio = Aucun

Attribuer au groupe 'radio' comme outils (mutuellement exclusifs).

strqui identifie le groupe ou Aucun s'il n'appartient pas à un groupe.

set_figure ( figure )

propriété basculée

Etat de l'outil basculé.

déclencheur ( expéditeur , événement , données = Aucun )

Appels enableou disablebasés sur toggledla valeur.

classe matplotlib.backend_tools. ToolViewsPositions ( * args , ** kwargs )

Socles :ToolBase

Outil auxiliaire pour gérer les changements de vues et de positions.

S'exécute en arrière-plan et devrait être utilisé par tous les outils qui ont besoin d'accéder à l'historique des vues et des positions de la figure, par exemple

• ToolZoom

• ToolPan

• ToolHome

• ToolBack

• ToolForward

add_figure ( figure )

Ajoutez la figure actuelle à la pile de vues et de positions.

retour ( )

Reculez d'une étape dans la pile de vues et de positions.

clair ( figure )

Réinitialisez la pile d'axes.

avant ( )

Avancez d'une étape dans la pile de vues et de positions.

maison ( )

Rappelez la première vue et position de la pile.

push_current ( figure = Aucun )

Poussez les limites et la position de la vue actuelle sur leurs piles respectives.

update_home_views ( figure = None )

Assurez-vous qu'il self.home_viewsy a une entrée pour tous les axes présents dans la figure.

update_view ( )

Mettez à jour les limites et la position de la vue pour chaque axe à partir de la position actuelle de la pile. Si des axes sont présents dans la figure qui ne sont pas dans la position actuelle de la pile, utilisez les limites de la vue d'accueil pour ces axes et ne mettez à jour aucune position.

classe matplotlib.backend_tools. ToolXScale ( * args , ** kwargs )

Socles :AxisScaleBase

Outil pour basculer entre les échelles linéaires et logarithmiques sur l'axe X.

propriété default_keymap

description = 'Basculer l' échelle de l'axe X

Description de l'outil.

str: info-bulle utilisée si l'outil est inclus dans une barre d'outils.

set_scale ( axe , échelle )

classe matplotlib.backend_tools. ToolYScale ( * args , ** kwargs )

Socles :AxisScaleBase

Outil pour basculer entre les échelles linéaires et logarithmiques sur l'axe Y.

propriété default_keymap

description = 'Basculer l' échelle de l'axe Y

Description de l'outil.

str: info-bulle utilisée si l'outil est inclus dans une barre d'outils.

set_scale ( axe , échelle )

classe matplotlib.backend_tools. ToolZoom ( * args )

Socles :ZoomPanBase

Un outil pour zoomer à l'aide d'un sélecteur rectangle.

curseur = 3

Curseur à utiliser lorsque l'outil est actif.

propriété default_keymap

description = 'Zoomer sur le rectangle'

Description de l'outil.

str: info-bulle utilisée si l'outil est inclus dans une barre d'outils.

image = 'zoom_to_rect'

Nom de fichier de l'image.

str: nom de fichier de l'image à utiliser dans une barre d'outils. Si aucun, le nom est utilisé comme étiquette dans le bouton de la barre d'outils.

groupe_radio = 'par défaut'

Attribuer au groupe 'radio' comme outils (mutuellement exclusifs).

strqui identifie le groupe ou Aucun s'il n'appartient pas à un groupe.

classe matplotlib.backend_tools. ViewsPositionsBase ( gestionnaire d' outils , nom )

Socles :ToolBase

Classe de base pour ToolHome, ToolBacket ToolForward.

déclencheur ( expéditeur , événement , données = Aucun )

Appelé lorsque cet outil est utilisé.

Cette méthode est appelée par ToolManager.trigger_tool.

Paramètres :

un événementEvent

L'événement canevas qui a provoqué l'appel de cet outil.

objet expéditeur

Objet qui a demandé le déclenchement de l'outil.

objet de données

Données supplémentaires.

classe matplotlib.backend_tools. ZoomPanBase ( * args )

Socles :ToolToggleBase

Classe de base pour ToolZoomet ToolPan.

désactiver ( événement = Aucun )

Relâchez la toile et déconnectez les événements de presse/libération.

activer ( événement = Aucun )

Connectez les événements de presse/libération et verrouillez la toile.

scroll_zoom ( événement )

déclencheur ( expéditeur , événement , données = Aucun )

Appels enableou disablebasés sur toggledla valeur.

matplotlib.backend_tools. add_tools_to_container ( conteneur , outils = [['navigation', ['home', 'back', 'forward']], ['zoompan', ['pan', 'zoom', 'subplots']], ['io ', ['enregistrer', 'aide']]] )

Ajoutez plusieurs outils au conteneur.

Paramètres :

Conteneur Conteneur

backend_bases.ToolContainerBaseobjet qui obtiendra les outils ajoutés.

liste d'outils , facultatif

Répertoriez dans le formulaire où les outils s'afficheront dans group1. Voir pour plus de détails.[[group1, [tool1, tool2 ...]], [group2, [...]]][tool1, tool2, ...]backend_bases.ToolContainerBase.add_tool

matplotlib.backend_tools. add_tools_to_manager ( toolmanager , tools={'back': <class 'matplotlib.backend_tools.ToolBack'> , 'copy': <class 'matplotlib.backend_tools.ToolCopyToClipboardBase'> , 'cursor': <class 'matplotlib.backend_tools.SetCursorBase' > , 'forward' : <class 'matplotlib.backend_tools.ToolForward'> , 'fullscreen' : <class 'matplotlib.backend_tools.ToolFullScreen'> , 'grid' : <class 'matplotlib.backend_tools.ToolGrid' 'matplotlib.backend_tools.ToolMinorGrid'> , 'help' : <classe 'matplotlib.backend_tools.ToolHelpBase'> , 'home' : <classe 'matplotlib.backend_tools.ToolHome'> , 'pan' : <classe 'matplotlib.backend_tools. ToolPan'> , 'position' : <class 'matplotlib.backend_tools.ToolCursorPosition'> , 'quit' : <class 'matplotlib.backend_tools.ToolQuit'> , 'quit_all' : <class 'matplotlib.backend_tools.ToolQuitAll'> , ' élastique': <class 'matplotlib.backend_tools.RubberbandBase'> , 'save' : <classe 'matplotlib.backend_tools.SaveFigureBase'> , 'subplots' : <classe 'matplotlib.backend_tools.ConfigureSubplotsBase'> , 'viewpos' : <classe 'matplotlib.backend_tools.ToolViewsPositions'> , 'xscale' : <classe 'matplotlib. backend_tools.ToolXScale'> , 'yscale': <class 'matplotlib.backend_tools.ToolYScale'> , 'zoom': <class 'matplotlib.backend_tools.ToolZoom'>} )

Ajoutez plusieurs outils à un fichier ToolManager.

Paramètres :

gestionnaire d'outilsbackend_managers.ToolManager

Gestionnaire auquel les outils sont ajoutés.

outils {str : class_like}, facultatif

Les outils à ajouter dans un dict {name : tool}, voir backend_managers.ToolManager.add_toolpour plus d'informations.

matplotlib.backend_tools. curseurs

pseudonyme deCursors