matplotlib.backend_tools

Abstrakte Basisklassen definieren die Grundelemente für Tools. Diese Tools werden von verwendetmatplotlib.backend_managers.ToolManager

ToolBase

Einfaches zustandsloses Tool

ToolToggleBase

Werkzeug, das zwei Zustände hat, kann immer nur ein Toggle-Werkzeug für dasselbe aktiv sein matplotlib.backend_managers.ToolManager

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

Basen:ToolToggleBase

Base Tool zum Umschalten zwischen linear und logarithmisch.

deaktivieren ( event = None )

Deaktivieren Sie das Toggle-Tool.

triggerRufen Sie diese Methode auf, wenn toggledTrue ist.

Dies kann unter verschiedenen Umständen passieren.

• Klicken Sie auf die Werkzeugschaltfläche der Werkzeugleiste.

• Rufen Sie an matplotlib.backend_managers.ToolManager.trigger_tool.

• Ein anderes ToolToggleBaseabgeleitetes Werkzeug wird ausgelöst (von demselben ToolManager).

enable ( event = None )

Aktivieren Sie das Toggle-Tool.

triggerruft diese Methode auf, wenn toggledFalse ist.

trigger ( sender , event , data = None )

Anrufe enableoder disablebasierend auf dem toggledWert.

Klasse matplotlib.backend_tools. ConfigureSubplotsBase ( Toolmanager , Name )

Basen:ToolBase

Basistool für die Konfiguration von Teilparzellen.

description = ' Nebenplots konfigurieren'

Beschreibung des Tools.

str: Tooltip wird verwendet, wenn das Tool in einer Symbolleiste enthalten ist.

image = 'Nebenhandlungen'

Dateiname des Bildes.

str: Dateiname des Bildes, das in einer Symbolleiste verwendet werden soll. Wenn None, wird der Name als Beschriftung in der Symbolleistenschaltfläche verwendet.

Klasse matplotlib.backend_tools. Cursor ( Wert )

Basen:IntEnum

Backend-unabhängige Cursortypen.

HAND = 2

MOVE = 4

POINTER = 1

RESIZE_HORIZONTAL = 6

RESIZE_VERTICAL = 7

SELECT_REGION = 3

WAIT = 5

Klasse matplotlib.backend_tools. RubberbandBase ( Werkzeugmanager , Name )

Basen:ToolBase

Ziehen und entfernen Sie ein Gummiband.

draw_rubberband ( * data )

Gummiband ziehen.

Diese Methode muss pro Backend implementiert werden.

remove_rubberband ( )

Gummiband entfernen.

Diese Methode sollte pro Backend implementiert werden.

trigger ( sender , event , data = None )

Anruf draw_rubberbandoder remove_rubberbandbasierend auf Daten.

Klasse matplotlib.backend_tools. SaveFigureBase ( Werkzeugmanager , Name )

Basen:ToolBase

Basistool zum Figurensparen.

Eigenschaft default_keymap

description = 'Speichere die Figur'

Beschreibung des Tools.

str: Tooltip wird verwendet, wenn das Tool in einer Symbolleiste enthalten ist.

image = 'filesave'

Dateiname des Bildes.

str: Dateiname des Bildes, das in einer Symbolleiste verwendet werden soll. Wenn None, wird der Name als Beschriftung in der Symbolleistenschaltfläche verwendet.

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

Basen:ToolBase

Wechseln Sie zum aktuellen Cursor, während Sie sich inaxe befinden.

Dieses Tool verfolgt alle ToolToggleBaseabgeleiteten Tools und ruft auf, set_cursorwenn ein Tool ausgelöst wird.

set_cursor ( Cursor )

[ Veraltet ] Setzen Sie den Cursor.

Anmerkungen

Veraltet seit Version 3.5: Verwenden Sie FigureCanvasBase.set_cursorstattdessen.

set_figure ( Abbildung )

Klasse matplotlib.backend_tools. ToolBack ( Werkzeugmanager , Name )

Basen:ViewsPositionsBase

Gehen Sie im Ansichtsbegrenzungsstapel wieder nach oben.

Eigenschaft default_keymap

description = 'Zurück zur vorherigen Ansicht'

Beschreibung des Tools.

str: Tooltip wird verwendet, wenn das Tool in einer Symbolleiste enthalten ist.

image = 'zurück'

Dateiname des Bildes.

str: Dateiname des Bildes, das in einer Symbolleiste verwendet werden soll. Wenn None, wird der Name als Beschriftung in der Symbolleistenschaltfläche verwendet.

Klasse matplotlib.backend_tools. ToolBase ( Werkzeugmanager , Name )

Basen:object

Basis-Tool-Klasse.

Ein Basiswerkzeug, das nur eine triggerMethode oder gar keine Methode implementiert. Das Tool wird durch instanziiert matplotlib.backend_managers.ToolManager.

Eigenschaft Leinwand

Die Leinwand der Figur, die von diesem Werkzeug betroffen ist, oder Keine.

default_keymap = Keine

Keymap, die mit diesem Tool verknüpft werden soll.

list[str]: Liste der Tasten, die dieses Tool auslösen, wenn ein Tastendruckereignis auf ausgegeben wird self.figure.canvas. Beachten Sie, dass dieses Attribut in der Instanz nachgeschlagen wird und daher eine Eigenschaft sein kann (dies wird zB von den eingebauten Tools verwendet, um die rcParams zur Instanziierungszeit zu laden).

Beschreibung = Keine

Beschreibung des Tools.

str: Tooltip wird verwendet, wenn das Tool in einer Symbolleiste enthalten ist.

zerstören ( )

[ Veraltet ] Zerstöre das Werkzeug.

Diese Methode wird von aufgerufen ToolManager.remove_tool.

Anmerkungen

Veraltet seit Version 3.6: Verwenden Sie stattdessen tool_removed_event.

Eigenschaftszahl #

Die von diesem Werkzeug betroffene Zahl oder Keine.

Bild = Keine

Dateiname des Bildes.

str: Dateiname des Bildes, das in einer Symbolleiste verwendet werden soll. Wenn None, wird der Name als Beschriftung in der Symbolleistenschaltfläche verwendet.

Eigenschaftsname _

Die Tool-ID (str, muss unter den Tools eines Tool-Managers eindeutig sein).

set_figure ( Abbildung )

Eigenschaft Toolmanager

Das ToolManager, das dieses Tool steuert.

trigger ( sender , event , data = None )

Wird aufgerufen, wenn dieses Tool verwendet wird.

Diese Methode wird von aufgerufen ToolManager.trigger_tool.

Parameter :

VeranstaltungEvent

Das Canvas-Ereignis, das den Aufruf dieses Tools verursacht hat.

Absenderobjekt _

Objekt, das die Auslösung des Werkzeugs angefordert hat.

Datenobjekt _

Zusätzliche Daten.

Klasse matplotlib.backend_tools. ToolCopyToClipboardBase ( Werkzeugmanager , Name )

Basen:ToolBase

Werkzeug zum Kopieren der Abbildung in die Zwischenablage.

Eigenschaft default_keymap

description = ' Die Leinwandfigur in die Zwischenablage kopieren

Beschreibung des Tools.

str: Tooltip wird verwendet, wenn das Tool in einer Symbolleiste enthalten ist.

trigger ( * args , ** kwargs )

Wird aufgerufen, wenn dieses Tool verwendet wird.

Diese Methode wird von aufgerufen ToolManager.trigger_tool.

Parameter :

VeranstaltungEvent

Das Canvas-Ereignis, das den Aufruf dieses Tools verursacht hat.

Absenderobjekt _

Objekt, das die Auslösung des Werkzeugs angefordert hat.

Datenobjekt _

Zusätzliche Daten.

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

Basen:ToolBase

Nachricht mit der aktuellen Zeigerposition senden.

Dieses Tool läuft im Hintergrund und meldet die Position des Cursors.

send_message ( Ereignis )

Rufen Sie an matplotlib.backend_managers.ToolManager.message_event.

set_figure ( Abbildung )

Klasse matplotlib.backend_tools. ToolForward ( Werkzeugmanager , Name )

Basen:ViewsPositionsBase

Bewegen Sie sich im View Lim Stack vorwärts.

Eigenschaft default_keymap

description = 'Weiter zur nächsten Ansicht'

Beschreibung des Tools.

str: Tooltip wird verwendet, wenn das Tool in einer Symbolleiste enthalten ist.

image = 'weiter'

Dateiname des Bildes.

str: Dateiname des Bildes, das in einer Symbolleiste verwendet werden soll. Wenn None, wird der Name als Beschriftung in der Symbolleistenschaltfläche verwendet.

Klasse matplotlib.backend_tools. ToolFullScreen ( Werkzeugmanager , Name )

Basen:ToolBase

Werkzeug zum Umschalten des Vollbildmodus.

Eigenschaft default_keymap

description = ' Vollbildmodus umschalten'

Beschreibung des Tools.

str: Tooltip wird verwendet, wenn das Tool in einer Symbolleiste enthalten ist.

trigger ( sender , event , data = None )

Wird aufgerufen, wenn dieses Tool verwendet wird.

Diese Methode wird von aufgerufen ToolManager.trigger_tool.

Parameter :

VeranstaltungEvent

Das Canvas-Ereignis, das den Aufruf dieses Tools verursacht hat.

Absenderobjekt _

Objekt, das die Auslösung des Werkzeugs angefordert hat.

Datenobjekt _

Zusätzliche Daten.

Klasse matplotlib.backend_tools. ToolGrid ( Werkzeugmanager , Name )

Basen:ToolBase

Werkzeug zum Umschalten der Hauptraster der Figur.

Eigenschaft default_keymap

description = 'Toggle major grids'

Beschreibung des Tools.

str: Tooltip wird verwendet, wenn das Tool in einer Symbolleiste enthalten ist.

trigger ( sender , event , data = None )

Wird aufgerufen, wenn dieses Tool verwendet wird.

Diese Methode wird von aufgerufen ToolManager.trigger_tool.

Parameter :

VeranstaltungEvent

Das Canvas-Ereignis, das den Aufruf dieses Tools verursacht hat.

Absenderobjekt _

Objekt, das die Auslösung des Werkzeugs angefordert hat.

Datenobjekt _

Zusätzliche Daten.

Klasse matplotlib.backend_tools. ToolHelpBase ( Werkzeugmanager , Name )

Basen:ToolBase

Eigenschaft default_keymap

description = ' Werkzeugliste , Shortcuts und Beschreibung drucken'

Beschreibung des Tools.

str: Tooltip wird verwendet, wenn das Tool in einer Symbolleiste enthalten ist.

statisch format_shortcut ( key_sequence )

Konvertieren Sie einen Shortcut-String von der in rc config verwendeten Notation in die Standardnotation für die Anzeige von Shortcuts, zB 'ctrl+a' -> 'Ctrl+A'.

image = 'Hilfe'

Dateiname des Bildes.

str: Dateiname des Bildes, das in einer Symbolleiste verwendet werden soll. Wenn None, wird der Name als Beschriftung in der Symbolleistenschaltfläche verwendet.

Klasse matplotlib.backend_tools. ToolHome ( Werkzeugmanager , Name )

Basen:ViewsPositionsBase

Stellen Sie die ursprünglichen Anzeigebeschränkungen wieder her.

Eigenschaft default_keymap

description = ' Originalansicht zurücksetzen'

Beschreibung des Tools.

str: Tooltip wird verwendet, wenn das Tool in einer Symbolleiste enthalten ist.

image = 'home'

Dateiname des Bildes.

str: Dateiname des Bildes, das in einer Symbolleiste verwendet werden soll. Wenn None, wird der Name als Beschriftung in der Symbolleistenschaltfläche verwendet.

Klasse matplotlib.backend_tools. ToolMinorGrid ( Werkzeugmanager , Name )

Basen:ToolBase

Werkzeug zum Umschalten des Haupt- und Nebenrasters der Figur.

Eigenschaft default_keymap

description = ' Haupt- und Nebenraster umschalten'

Beschreibung des Tools.

str: Tooltip wird verwendet, wenn das Tool in einer Symbolleiste enthalten ist.

trigger ( sender , event , data = None )

Wird aufgerufen, wenn dieses Tool verwendet wird.

Diese Methode wird von aufgerufen ToolManager.trigger_tool.

Parameter :

VeranstaltungEvent

Das Canvas-Ereignis, das den Aufruf dieses Tools verursacht hat.

Absenderobjekt _

Objekt, das die Auslösung des Werkzeugs angefordert hat.

Datenobjekt _

Zusätzliche Daten.

Klasse matplotlib.backend_tools. ToolPan ( * args )

Basen:ZoomPanBase

Achsen mit linker Maus schwenken, mit rechts zoomen.

Cursor = 4

Zu verwendender Cursor, wenn das Werkzeug aktiv ist.

Eigenschaft default_keymap

description = ' Achsen mit linker Maus verschieben, mit rechts zoomen '

Beschreibung des Tools.

str: Tooltip wird verwendet, wenn das Tool in einer Symbolleiste enthalten ist.

image = 'bewegen'

Dateiname des Bildes.

str: Dateiname des Bildes, das in einer Symbolleiste verwendet werden soll. Wenn None, wird der Name als Beschriftung in der Symbolleistenschaltfläche verwendet.

radio_group = 'Standard'

Attribut zur Gruppe 'radio' like tools (schließen sich gegenseitig aus).

strdie die Gruppe identifiziert, oder None , wenn sie keiner Gruppe angehört.

Klasse matplotlib.backend_tools. ToolQuit ( Werkzeugmanager , Name )

Basen:ToolBase

Tool zum Aufrufen der Destroy-Methode des Figurenmanagers.

Eigenschaft default_keymap

description = 'Verlasse die Figur'

Beschreibung des Tools.

str: Tooltip wird verwendet, wenn das Tool in einer Symbolleiste enthalten ist.

trigger ( sender , event , data = None )

Wird aufgerufen, wenn dieses Tool verwendet wird.

Diese Methode wird von aufgerufen ToolManager.trigger_tool.

Parameter :

VeranstaltungEvent

Das Canvas-Ereignis, das den Aufruf dieses Tools verursacht hat.

Absenderobjekt _

Objekt, das die Auslösung des Werkzeugs angefordert hat.

Datenobjekt _

Zusätzliche Daten.

Klasse matplotlib.backend_tools. ToolQuitAll ( Werkzeugmanager , Name )

Basen:ToolBase

Tool zum Aufrufen der Destroy-Methode des Figurenmanagers.

Eigenschaft default_keymap

description = ' Alle Figuren verlassen'

Beschreibung des Tools.

str: Tooltip wird verwendet, wenn das Tool in einer Symbolleiste enthalten ist.

trigger ( sender , event , data = None )

Wird aufgerufen, wenn dieses Tool verwendet wird.

Diese Methode wird von aufgerufen ToolManager.trigger_tool.

Parameter :

VeranstaltungEvent

Das Canvas-Ereignis, das den Aufruf dieses Tools verursacht hat.

Absenderobjekt _

Objekt, das die Auslösung des Werkzeugs angefordert hat.

Datenobjekt _

Zusätzliche Daten.

matplotlib.backend_tools. ToolSetCursor

Pseudonym vonSetCursorBase

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

Basen:ToolBase

Umschaltbares Werkzeug.

Jedes Mal, wenn es ausgelöst wird, wechselt es zwischen Aktivieren und Deaktivieren.

Parameter :

``*argument``

Vom Tool zu verwendendes Argument variabler Länge.

``**Kwargs``

toggledWenn vorhanden und wahr, wird der Anfangszustand der Arbitrary-Schlüsselwortargumente des Tools festgelegt, die vom Tool verwendet werden sollen

Cursor = Keine

Zu verwendender Cursor, wenn das Werkzeug aktiv ist.

default_toggled = Falsch

Standard des umgeschalteten Zustands.

deaktivieren ( event = None )

Deaktivieren Sie das Toggle-Tool.

triggerRufen Sie diese Methode auf, wenn toggledTrue ist.

Dies kann unter verschiedenen Umständen passieren.

• Klicken Sie auf die Werkzeugschaltfläche der Werkzeugleiste.

• Rufen Sie an matplotlib.backend_managers.ToolManager.trigger_tool.

• Ein anderes ToolToggleBaseabgeleitetes Werkzeug wird ausgelöst (von demselben ToolManager).

enable ( event = None )

Aktivieren Sie das Toggle-Tool.

triggerruft diese Methode auf, wenn toggledFalse ist.

radio_group = Keine

Attribut zur Gruppe 'radio' like tools (schließen sich gegenseitig aus).

strdie die Gruppe identifiziert, oder None , wenn sie keiner Gruppe angehört.

set_figure ( Abbildung )

Eigenschaft umgeschaltet

Status des umgeschalteten Werkzeugs.

trigger ( sender , event , data = None )

Anrufe enableoder disablebasierend auf dem toggledWert.

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

Basen:ToolBase

Hilfswerkzeug zum Umgang mit Änderungen in Ansichten und Positionen.

Läuft im Hintergrund und sollte von allen Tools verwendet werden, die auf den Verlauf der Ansichten und Positionen der Figur zugreifen müssen, z

• ToolZoom

• ToolPan

• ToolHome

• ToolBack

• ToolForward

add_figure ( Abbildung )

Fügen Sie die aktuelle Figur dem Stapel von Ansichten und Positionen hinzu.

zurück ( )

Gehen Sie im Stapel von Ansichten und Positionen einen Schritt zurück.

klar ( Abbildung )

Setzen Sie den Achsenstapel zurück.

vorwärts ( )

Vorwärts einen Schritt im Stapel von Ansichten und Positionen.

home ( )

Rufen Sie die erste Ansicht und Position aus dem Stapel auf.

push_current ( figure = None )

Schieben Sie die aktuellen Ansichtsgrenzen und die Position auf ihre jeweiligen Stapel.

update_home_views ( figure = None )

Stellen Sie sicher, dass self.home_viewsein Eintrag für alle in der Abbildung vorhandenen Achsen vorhanden ist.

update_view ( )

Aktualisieren Sie die Ansichtsgrenzen und die Position für jede Achse von der aktuellen Stapelposition. Wenn in der Figur Achsen vorhanden sind, die sich nicht in der aktuellen Stapelposition befinden, verwenden Sie die Grenzen der Ausgangsansicht für diese Achsen und aktualisieren Sie keine Positionen.

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

Basen:AxisScaleBase

Werkzeug zum Umschalten zwischen linearer und logarithmischer Skalierung auf der X-Achse.

Eigenschaft default_keymap

description = 'Toggle scale X axis'

Beschreibung des Tools.

str: Tooltip wird verwendet, wenn das Tool in einer Symbolleiste enthalten ist.

set_scale ( ax , scale )

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

Basen:AxisScaleBase

Werkzeug zum Umschalten zwischen linearer und logarithmischer Skalierung auf der Y-Achse.

Eigenschaft default_keymap

description = ' Skala Y -Achse umschalten'

Beschreibung des Tools.

str: Tooltip wird verwendet, wenn das Tool in einer Symbolleiste enthalten ist.

set_scale ( ax , scale )

Klasse matplotlib.backend_tools. ToolZoom ( * args )

Basen:ZoomPanBase

Ein Werkzeug zum Zoomen mit einem Rechteckselektor.

Cursor = 3

Zu verwendender Cursor, wenn das Werkzeug aktiv ist.

Eigenschaft default_keymap

description = 'Auf Rechteck zoomen'

Beschreibung des Tools.

str: Tooltip wird verwendet, wenn das Tool in einer Symbolleiste enthalten ist.

image = 'zoom_to_rect'

Dateiname des Bildes.

str: Dateiname des Bildes, das in einer Symbolleiste verwendet werden soll. Wenn None, wird der Name als Beschriftung in der Symbolleistenschaltfläche verwendet.

radio_group = 'Standard'

Attribut zur Gruppe 'radio' like tools (schließen sich gegenseitig aus).

strdie die Gruppe identifiziert, oder None , wenn sie keiner Gruppe angehört.

Klasse matplotlib.backend_tools. ViewsPositionsBase ( Werkzeugmanager , Name )

Basen:ToolBase

Basisklasse für ToolHome, ToolBackund ToolForward.

trigger ( sender , event , data = None )

Wird aufgerufen, wenn dieses Tool verwendet wird.

Diese Methode wird von aufgerufen ToolManager.trigger_tool.

Parameter :

VeranstaltungEvent

Das Canvas-Ereignis, das den Aufruf dieses Tools verursacht hat.

Absenderobjekt _

Objekt, das die Auslösung des Werkzeugs angefordert hat.

Datenobjekt _

Zusätzliche Daten.

Klasse matplotlib.backend_tools. ZoomPanBase ( * args )

Basen:ToolToggleBase

Basisklasse für ToolZoomund ToolPan.

deaktivieren ( event = None )

Lassen Sie die Leinwand los und trennen Sie Press/Release-Events.

enable ( event = None )

Verbinden Sie Presse-/Freigabeereignisse und sperren Sie die Leinwand.

scroll_zoom ( Ereignis )

trigger ( sender , event , data = None )

Anrufe enableoder disablebasierend auf dem toggledWert.

matplotlib.backend_tools. add_tools_to_container ( container , tools = [['navigation', ['home', 'back', 'forward']], ['zoompan', ['pan', 'zoom', 'subplots']], ['io ', ['speichern', 'hilfe']]] )

Fügen Sie dem Container mehrere Tools hinzu.

Parameter :

Behälter Behälter

backend_bases.ToolContainerBaseObjekt, dem die Tools hinzugefügt werden.

Werkzeugliste , optional

Liste im Formular, wo die Werkzeuge in Gruppe1 angezeigt werden. Siehe für Details.[[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': <class 'matplotlib.backend_tools.ToolHelpBase'> , 'home': <class 'matplotlib.backend_tools.ToolHome'> , 'pan': <class 'matplotlib.backend_tools. ToolPan'> , 'position': <class 'matplotlib.backend_tools.ToolCursorPosition'> , 'quit': <class 'matplotlib.backend_tools.ToolQuit'> , 'quit_all': <class 'matplotlib.backend_tools.ToolQuitAll'> , ' Gummiband': <class 'matplotlib.backend_tools.RubberbandBase'> , 'speichern': <class 'matplotlib.backend_tools.SaveFigureBase'> , 'subplots': <class 'matplotlib.backend_tools.ConfigureSubplotsBase'> , 'viewpos': <class 'matplotlib.backend_tools.ToolViewsPositions'> , 'xscale': <class 'matplotlib. backend_tools.ToolXScale'> , 'yscale': <class 'matplotlib.backend_tools.ToolYScale'> , 'zoom': <class 'matplotlib.backend_tools.ToolZoom'>} )

Fügen Sie mehrere Tools zu einer ToolManager.

Parameter :

Werkzeugmanagerbackend_managers.ToolManager

Manager, dem die Tools hinzugefügt werden.

Tools {str: class_like}, optional

Die Tools zum Hinzufügen in einem {name: tool}-Diktat finden Sie unter backend_managers.ToolManager.add_toolfür weitere Informationen.

matplotlib.backend_tools. Cursor

Pseudonym vonCursors