matplotlib.backend_managers#

classe matplotlib.backend_managers. ToolEvent ( nom , expéditeur , outil , données = Aucun ) [source] #

Socles :object

Evénement de manipulation d'outil (ajout/suppression).

classe matplotlib.backend_managers. ToolManager ( figure = Aucun ) [source] #

Socles :object

Gestionnaire des actions déclenchées par les interactions de l'utilisateur (appui sur une touche, clics sur la barre d'outils, ...) sur une Figure.

Attributs :
figureFigure

Figure qui tient la toile.

keypresslockLockDraw

LockDrawobjet pour savoir si le canvaskey_press_event est verrouillé.

verrouillage des messagesLockDraw

LockDrawobjet pour savoir si le message est disponible en écriture.

propriété active_toggle #

Outils actuellement activés.

add_tool ( nom , outil , * args , ** kwargs ) [source] #

Ajouter un outil à ToolManager.

En cas de succès, ajoute un nouvel événement tool_trigger_{name}où {name}est le nom de l'outil ; l'événement est déclenché chaque fois que l'outil est déclenché.

Paramètres :
chaîne de nom

Le nom de l'outil, traité comme l'ID, doit être unique.

type d'outil

Classe de l'outil à ajouter. Une sous-classe sera utilisée à la place si une a été enregistrée pour la classe de canevas actuelle.

Voir également

matplotlib.backend_tools.ToolBase

La classe de base pour les outils.

Remarques

args et kwargs sont transmis directement au constructeur d'outils.

canevas de propriété #

Canevas géré par FigureManager.

chiffre de propriété #

Figure qui tient la toile.

get_tool ( nom , avertir = True ) [source] #

Renvoie l'objet outil avec le nom donné.

Pour plus de commodité, cela fait passer les objets outils.

Paramètres :
nom str ouToolBase

Nom de l'outil ou de l'outil lui-même.

warn bool, par défaut : True

Indique si un avertissement doit être émis si aucun outil portant le nom donné n'existe.

Retours :
ToolBaseou Aucun

L'outil ou Aucun si aucun outil portant le nom donné n'existe.

get_tool_keymap ( nom ) [source] #

Renvoie le keymap associé à l'outil spécifié.

Paramètres :
chaîne de nom

Nom de l'outil.

Retours :
liste de str

Liste des clés associées à l'outil.

message_event ( message , expéditeur = Aucun ) [source] #

Émet un ToolManagerMessageEvent.

remove_tool ( nom ) [source] #

Supprimer l'outil nommé name .

Paramètres :
chaîne de nom

Nom de l'outil.

set_figure ( figure , update_tools = True ) [source] #

Liez la figure donnée aux outils.

Paramètres :
chiffreFigure
update_tools booléen , par défaut : Vrai

Forcer les outils à mettre à jour la figure.

toolmanager_connect ( s , func ) [source] #

Connectez l'événement avec la chaîne s à func .

Paramètres :
s str

Le nom de l'évènement. Les événements suivants sont reconnus :

  • 'tool_message_event'

  • 'tool_removed_event'

  • 'tool_added_event'

Pour chaque outil ajouté, un nouvel événement est créé

  • 'tool_trigger_TOOLNAME', où TOOLNAME est l'identifiant de l'outil.

fonction appelable

Fonction de rappel pour l'événement toolmanager avec signature :

def func(event: ToolEvent) -> Any
Retours :
cid

ID de rappel pour la connexion. Cela peut être utilisé dans toolmanager_disconnect.

toolmanager_disconnect ( cid ) [source] #

Déconnecter l'id de rappel cid .

Exemple d'utilisation :

cid = toolmanager.toolmanager_connect('tool_trigger_zoom', onpress)
#...later
toolmanager.toolmanager_disconnect(cid)
outils de propriété #

Un nom d'outil de mappage dict -> outil contrôlé.

trigger_tool ( nom , expéditeur = Aucun , canvasevent = Aucun , données = Aucun ) [source] #

Déclencher un outil et émettre l' tool_trigger_{name}événement.

Paramètres :
chaîne de nom

Nom de l'outil.

objet expéditeur

Objet qui souhaite déclencher l'outil.

Événement de toile

Événement Canvas d'origine ou Aucun.

objet de données

Données supplémentaires à transmettre à l'outil lors du déclenchement.

update_keymap ( nom , clé ) [source] #

Définissez le keymap à associer à l'outil spécifié.

Paramètres :
chaîne de nom

Nom de l'outil.

clé str ou liste de str

Touches à associer à l'outil.

classe matplotlib.backend_managers. ToolManagerMessageEvent ( nom , expéditeur , message ) [source] #

Socles :object

Événement portant des messages de toolmanager.

Les messages sont généralement affichés à l'utilisateur par la barre d'outils.

classe matplotlib.backend_managers. ToolTriggerEvent ( nom , expéditeur , outil , canvasevent = None , data = None ) [source] #

Socles :ToolEvent

Evénement pour informer qu'un outil a été déclenché.