matplotlib.backend_managers#

class matplotlib.backend_managers.ToolEvent(name, sender, tool, data=None)[Quelle]#

Bases: object

Ereignis für die Werkzeugmanipulation (Hinzufügen/Entfernen).

class matplotlib.backend_managers.ToolManager(figure=None)[Quelle]#

Bases: object

Manager für Aktionen, die durch Benutzerinteraktionen (Tastendruck, Symbolleistenklicks, ...) auf einer Figur ausgelöst werden.

Attribute:
figureFigure

Figur, die die Zeichenfläche enthält.

keypresslockLockDraw

LockDraw-Objekt, um zu wissen, ob das key_press_event der Zeichenfläche gesperrt ist.

messagelockLockDraw

LockDraw-Objekt, um zu wissen, ob die Nachricht zum Schreiben verfügbar ist.

property active_toggle#

Aktuell umgeschaltete Werkzeuge.

add_tool(name, tool, *args, **kwargs)[Quelle]#

Fügt tool zum ToolManager hinzu.

Bei Erfolg wird ein neues Ereignis tool_trigger_{name} hinzugefügt, wobei {name} der Name des Werkzeugs ist; das Ereignis wird jedes Mal ausgelöst, wenn das Werkzeug ausgelöst wird.

Parameter:
namestr

Der Name des Werkzeugs, der als ID behandelt wird, muss eindeutig sein.

toolTyp

Klasse des hinzuzufügenden Werkzeugs. Eine Unterklasse wird stattdessen verwendet, wenn eine für die aktuelle Zeichenklassenklasse registriert wurde.

*args, **kwargs

Wird an den Konstruktor des tool übergeben.

Siehe auch

matplotlib.backend_tools.ToolBase

Die Basisklasse für Werkzeuge.

property canvas#

Von FigureManager verwaltete Zeichenfläche.

property figure#

Figur, die die Zeichenfläche enthält.

get_tool(name, warn=True)[Quelle]#

Gibt das Werkzeugobjekt mit dem angegebenen Namen zurück.

Zur Bequemlichkeit werden Werkzeugobjekte durchgereicht.

Parameter:
namestr oder ToolBase

Name des Werkzeugs oder das Werkzeug selbst.

warnbool, Standard: True

Ob eine Warnung ausgegeben werden soll, wenn kein Werkzeug mit dem angegebenen Namen existiert.

Gibt zurück:
ToolBase oder None

Das Werkzeug oder None, wenn kein Werkzeug mit dem angegebenen Namen existiert.

get_tool_keymap(name)[Quelle]#

Gibt die dem angegebenen Werkzeug zugeordnete Tastenbelegung zurück.

Parameter:
namestr

Name des Werkzeugs.

Gibt zurück:
Liste von str

Liste der Tasten, die dem Werkzeug zugeordnet sind.

message_event(message, sender=None)[Quelle]#

Sendet ein ToolManagerMessageEvent.

remove_tool(name)[Quelle]#

Entfernt das Werkzeug mit dem Namen name.

Parameter:
namestr

Name des Werkzeugs.

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

Bindet die gegebene Figur an die Werkzeuge.

Parameter:
figureFigure
update_toolsbool, Standard: True

Erzwingt die Aktualisierung der Figur durch die Werkzeuge.

toolmanager_connect(s, func)[Quelle]#

Verbindet das Ereignis mit der Zeichenkette s mit func.

Parameter:
sstr

Der Name des Ereignisses. Die folgenden Ereignisse werden erkannt:

  • 'tool_message_event'

  • 'tool_removed_event'

  • 'tool_added_event'

Für jedes hinzugefügte Werkzeug wird ein neues Ereignis erstellt:

  • 'tool_trigger_TOOLNAME', wobei TOOLNAME die ID des Werkzeugs ist.

funcaufrufbar

Callback-Funktion für das Toolmanager-Ereignis mit der Signatur

def func(event: ToolEvent) -> Any
Gibt zurück:
cid

Die Callback-ID für die Verbindung. Diese kann in toolmanager_disconnect verwendet werden.

toolmanager_disconnect(cid)[Quelle]#

Trennt die Callback-ID cid.

Beispielverwendung

cid = toolmanager.toolmanager_connect('tool_trigger_zoom', onpress)
#...later
toolmanager.toolmanager_disconnect(cid)
property tools#

Ein Dictionary, das Werkzeugnamen -> verwaltetes Werkzeug zuordnet.

trigger_tool(name, sender=None, canvasevent=None, data=None)[Quelle]#

Löst ein Werkzeug aus und sendet das Ereignis tool_trigger_{name}.

Parameter:
namestr

Name des Werkzeugs.

senderobject

Objekt, das das Werkzeug auslösen möchte.

canvaseventEreignis

Ursprüngliches Zeichenflächenereignis oder None.

dataobject

Zusätzliche Daten, die beim Auslösen an das Werkzeug übergeben werden sollen.

update_keymap(name, key)[Quelle]#

Legt die Tastenbelegung fest, die dem angegebenen Werkzeug zugeordnet werden soll.

Parameter:
namestr

Name des Werkzeugs.

keystr oder Liste von str

Tasten, die dem Werkzeug zugeordnet werden sollen.

class matplotlib.backend_managers.ToolManagerMessageEvent(name, sender, message)[Quelle]#

Bases: object

Ereignis, das Nachrichten vom Toolmanager überträgt.

Nachrichten werden normalerweise von der Symbolleiste für den Benutzer angezeigt.

class matplotlib.backend_managers.ToolTriggerEvent(name, sender, tool, canvasevent=None, data=None)[Quelle]#

Basiert auf: ToolEvent

Ereignis zur Benachrichtigung, dass ein Werkzeug ausgelöst wurde.

Auf dieser Seite