matplotlib.backend_managers#

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

Basen:object

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

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

Basen:object

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

Attribute :
figureFigure

Figur, die die Leinwand hält.

TastensperreLockDraw

LockDrawObjekt, um zu wissen, ob das canvaskey_press_event gesperrt ist.

NachrichtensperreLockDraw

LockDrawObjekt, um zu wissen, ob die Nachricht zum Schreiben verfügbar ist.

Eigenschaft active_toggle #

Derzeit umgeschaltete Tools.

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

Werkzeug hinzufügen zu ToolManager.

Fügt bei Erfolg ein neues Ereignis hinzu, tool_trigger_{name}wobei {name}der Name des Werkzeugs ist; Das Ereignis wird jedes Mal ausgelöst, wenn das Tool ausgelöst wird.

Parameter :
Namensstr _

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

Werkzeugtyp _

Klasse des hinzuzufügenden Werkzeugs. Stattdessen wird eine Unterklasse verwendet, wenn eine für die aktuelle Canvas-Klasse registriert wurde.

Siehe auch

matplotlib.backend_tools.ToolBase

Die Basisklasse für Werkzeuge.

Anmerkungen

args und kwargs werden direkt an den Werkzeugkonstruktor übergeben.

Eigenschaft Leinwand #

Von FigureManager verwaltete Leinwand.

Eigenschaftszahl # _

Figur, die die Leinwand hält.

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

Gibt das Werkzeugobjekt mit dem angegebenen Namen zurück.

Der Einfachheit halber leitet dies Werkzeugobjekte durch.

Parameter :
Namensstr oderToolBase

Name des Tools oder des Tools selbst.

warnen bool, Standard: True

Ob eine Warnung ausgegeben werden soll es existiert kein Tool mit dem angegebenen Namen.

Rückgaben :
ToolBaseoder Keine

Das Tool oder None, wenn kein Tool mit dem angegebenen Namen vorhanden ist.

get_tool_keymap ( name ) [Quelle] #

Gibt die Tastaturbelegung zurück, die dem angegebenen Werkzeug zugeordnet ist.

Parameter :
Namensstr _

Name des Tools.

Rückgaben :
Liste der Str

Liste der dem Werkzeug zugeordneten Schlüssel.

message_event ( Nachricht , Absender = Keine ) [Quelle] #

Emittieren Sie eine ToolManagerMessageEvent.

remove_tool ( name ) [Quelle] #

Entfernen Sie das Tool mit dem Namen name .

Parameter :
Namensstr _

Name des Werkzeugs.

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

Binden Sie die gegebene Figur an die Werkzeuge.

Parameter :
ZahlFigure
update_tools bool, Standard: True

Werkzeuge zum Aktualisieren der Abbildung zwingen.

toolmanager_connect ( s , func ) [Quelle] #

Event mit String s mit func verbinden .

Parameter :
s -str

Der Name des Ereignisses. Folgende Ereignisse werden anerkannt:

  • '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 Tools ist.

Funktion aufrufbar

Callback-Funktion für das Toolmanager-Event mit Signatur:

def func(event: ToolEvent) -> Any
Rückgaben :
Säure

Die Rückruf-ID für die Verbindung. Dies kann in verwendet werden toolmanager_disconnect.

toolmanager_disconnect ( cid ) [Quelle] #

Trennen Sie die Rückruf-ID cid .

Beispielnutzung:

cid = toolmanager.toolmanager_connect('tool_trigger_zoom', onpress)
#...later
toolmanager.toolmanager_disconnect(cid)
Eigenschaftswerkzeuge # _

Name eines Diktierzuordnungstools -> gesteuertes Tool.

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

Lösen Sie ein Tool aus und geben Sie das tool_trigger_{name}Ereignis aus.

Parameter :
Namensstr _

Name des Werkzeugs.

Absenderobjekt _

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

canvasevent- Ereignis

Ursprüngliches Canvas-Ereignis oder None.

Datenobjekt _

Extra data to pass to the tool when triggering.

update_keymap(name, key)[source]#

Set the keymap to associate with the specified tool.

Parameters:
namestr

Name of the Tool.

keystr or list of str

Keys to associate with the tool.

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

Bases: object

Event carrying messages from toolmanager.

Messages usually get displayed to the user by the toolbar.

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

Basen:ToolEvent

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