`matplotlib.patheffects`#

Definiert Klassen für Pfadeffekte. Die Pfadeffekte werden in Text, Line2D und Patch unterstützt.

Siehe auch

Leitfaden für Pfadeffekte

class matplotlib.patheffects.AbstractPathEffect(offset=(0.0, 0.0))[source]#

Bases: object

Eine Basisklasse für Pfadeffekte.

Unterklassen sollten die Methode draw_path überschreiben, um die Effektfunktionalität hinzuzufügen.

Parameter:

offset(float, float), default: (0, 0): Der (x, y)-Offset, der auf den Pfad angewendet wird, gemessen in Punkten.

draw_path(renderer, gc, tpath, affine, rgbFace=None)[source]#: Abgeleitete Klassen sollten diese Methode überschreiben. Die Argumente sind dieselben wie bei matplotlib.backend_bases.RendererBase.draw_path(), außer dass das erste Argument ein Renderer ist.

class matplotlib.patheffects.Normal(offset=(0.0, 0.0))[source]#

Bases: AbstractPathEffect

Der "Identitäts"-Pfadeffekt.

Der Normal-Pfadeffekt dient ausschließlich dazu, den ursprünglichen Künstler ohne spezielle Pfadeffekte zu zeichnen.

Parameter:

offset(float, float), default: (0, 0): Der (x, y)-Offset, der auf den Pfad angewendet wird, gemessen in Punkten.

class matplotlib.patheffects.PathEffectRenderer(path_effects, renderer)[source]#

Bases: RendererBase

Implementiert einen Renderer, der einen anderen Renderer enthält.

Dieser Proxy fängt dann Zeichenaufrufe ab und ruft die entsprechende AbstractPathEffect Zeichenmethode auf.

Hinweis

Nicht alle Methoden wurden in dieser RendererBase-Unterklasse überschrieben. Es kann notwendig sein, weitere Methoden hinzuzufügen, um die Fähigkeiten von Pfadeffekten weiter auszubauen.

Parameter:

path_effectsiterable von AbstractPathEffect: Die Pfadeffekte, die dieser Renderer repräsentiert.
rendererRendererBase subclass

close_group(s)[source]#

Schließt ein Gruppierungselement mit der Beschriftung s.

Wird nur vom SVG-Renderer verwendet.

copy_with_path_effect(path_effects)[source]#

draw_markers(gc, marker_path, marker_trans, path, **kwargs)[source]#

Zeichnet eine Markierung an jeder der path-Scheitelpunkte (außer Kontrollpunkte).

Die Basisimplementierung (Fallback) macht mehrere Aufrufe an draw_path. Backends möchten dies möglicherweise überschreiben, um den Marker nur einmal zu zeichnen und ihn mehrmals wiederzuverwenden.

Parameter:

gcGraphicsContextBase: Der Grafikkontext.
marker_pathPath: Der Pfad für die Markierung.
marker_transTransform: Eine affine Transformation, die auf die Markierung angewendet wird.
pathPath: Die Orte, an denen die Markierungen gezeichnet werden sollen.
transTransform: Eine affine Transformation, die auf den Pfad angewendet wird.
rgbFacecolor, optional

draw_path(gc, tpath, affine, rgbFace=None)[source]#: Zeichnet eine Path-Instanz mit der gegebenen affinen Transformation.

draw_path_collection(gc, master_transform, paths, **kwargs)[source]#

Zeichnet eine Sammlung von Pfaden.

Jeder Pfad wird zuerst durch den entsprechenden Eintrag in all_transforms (eine Liste von (3, 3) Matrizen) und dann durch master_transform transformiert. Anschließend werden sie durch den entsprechenden Eintrag in offsets verschoben, die zuvor durch offset_trans transformiert wurden.

facecolors, edgecolors, linewidths, linestyles und antialiased sind Listen, die die entsprechenden Eigenschaften festlegen.

offset_position wird jetzt nicht mehr verwendet, aber das Argument bleibt aus Kompatibilitätsgründen erhalten.

Die Basisimplementierung (Fallback) macht mehrere Aufrufe an draw_path. Backends möchten dies möglicherweise überschreiben, um jeden Satz von Pfaddaten nur einmal zu rendern und ihn dann mehrmals mit unterschiedlichen Offsets, Farben, Stilen usw. zu referenzieren. Die Generator-Methoden _iter_collection_raw_paths und _iter_collection werden bereitgestellt, um bei der Implementierung über Backends zu helfen (und diese zu standardisieren). Es wird dringend empfohlen, diese Generatoren zu verwenden, damit Änderungen am Verhalten von draw_path_collection global vorgenommen werden können.

open_group(s, gid=None)[source]#

Öffnet ein Gruppierungselement mit der Beschriftung s und gid (falls gesetzt) als ID.

Wird nur vom SVG-Renderer verwendet.

class matplotlib.patheffects.PathPatchEffect(offset=(0, 0), **kwargs)[source]#

Bases: AbstractPathEffect

Zeichnet eine PathPatch-Instanz, deren Pfad vom ursprünglichen Pfadeffekt-Künstler stammt.

Parameter:

offset(float, float), default: (0, 0): Der (x, y)-Offset, der auf den Pfad angewendet wird, in Punkten.
**kwargs: Alle Schlüsselwortargumente werden an den PathPatch-Konstruktor weitergegeben. Die Eigenschaften, die nicht überschrieben werden können, sind "path", "clip_box", "transform" und "clip_path".

draw_path(renderer, gc, tpath, affine, rgbFace)[source]#: Abgeleitete Klassen sollten diese Methode überschreiben. Die Argumente sind dieselben wie bei matplotlib.backend_bases.RendererBase.draw_path(), außer dass das erste Argument ein Renderer ist.

class matplotlib.patheffects.SimpleLineShadow(offset=(2, -2), shadow_color='k', alpha=0.3, rho=0.3, **kwargs)[source]#

Bases: AbstractPathEffect

Ein einfacher Schatten durch eine Linie.

Parameter:

offset(float, float), default: (2, -2): Der (x, y)-Offset, der auf den Pfad angewendet wird, in Punkten.
shadow_colorcolor, default: 'black': Die Schattenfarbe. Ein Wert von None verwendet die Farbe des ursprünglichen Künstlers mit einem Skalierungsfaktor von rho.
alphafloat, default: 0.3: Die Alpha-Transparenz des erzeugten Schattenpatches.
rhofloat, default: 0.3: Ein Skalierungsfaktor, der auf die rgbFace-Farbe angewendet wird, wenn shadow_color None ist.
**kwargs: Zusätzliche Schlüsselwörter werden gespeichert und an AbstractPathEffect._update_gc() weitergegeben.

draw_path(renderer, gc, tpath, affine, rgbFace)[source]#: Überschreibt die Standard-draw_path, um den Schattenoffset und die notwendigen Farbänderungen für den Schatten hinzuzufügen.

class matplotlib.patheffects.SimplePatchShadow(offset=(2, -2), shadow_rgbFace=None, alpha=None, rho=0.3, **kwargs)[source]#

Bases: AbstractPathEffect

Ein einfacher Schatten durch einen gefüllten Patch.

Parameter:

offset(float, float), default: (2, -2): Der (x, y)-Offset des Schattens in Punkten.
shadow_rgbFacecolor: Die Schattenfarbe.
alphafloat, default: 0.3: Die Alpha-Transparenz des erzeugten Schattenpatches.
rhofloat, default: 0.3: Ein Skalierungsfaktor, der auf die rgbFace-Farbe angewendet wird, wenn shadow_rgbFace nicht angegeben ist.
**kwargs: Zusätzliche Schlüsselwörter werden gespeichert und an AbstractPathEffect._update_gc() weitergegeben.

draw_path(renderer, gc, tpath, affine, rgbFace)[source]#: Überschreibt die Standard-draw_path, um den Schattenoffset und die notwendigen Farbänderungen für den Schatten hinzuzufügen.

class matplotlib.patheffects.Stroke(offset=(0, 0), **kwargs)[source]#

Bases: AbstractPathEffect

Ein linienbasierter Pfadeffekt, der einen Strich neu zeichnet.

Der Pfad wird mit seinem GC gezeichnet, der mit den angegebenen Schlüsselwortargumenten aktualisiert wurde, d. h. die Schlüsselwortargumente sollten gültige GC-Parameterwerte sein.

draw_path(renderer, gc, tpath, affine, rgbFace)[source]#: Zeichnet den Pfad mit aktualisiertem GC.

class matplotlib.patheffects.TickedStroke(offset=(0, 0), spacing=10.0, angle=45.0, length=np.float64(1.4142135623730951), **kwargs)[source]#

Bases: AbstractPathEffect

Ein linienbasierter Pfadeffekt, der einen Pfad mit einem angekreuzten Stil zeichnet.

Dieser Linienstil wird häufig zur Darstellung von Beschränkungen in der Optimierung verwendet. Die Kreuze können verwendet werden, um anzuzeigen, dass eine Seite der Linie ungültig ist, oder um eine geschlossene Grenze eines Bereichs darzustellen (z. B. eine Wand oder der Rand eines Rohrs).

Die Abstände, die Länge und der Winkel der Kreuze können gesteuert werden.

Dieser Linienstil wird manchmal als schraffierte Linie bezeichnet.

Siehe auch das Beispiel TickedStroke patheffect.

Parameter:

offset(float, float), default: (0, 0): Der (x, y)-Offset, der auf den Pfad angewendet wird, in Punkten.
spacingfloat, default: 10.0: Der Abstand zwischen den Kreuzen in Punkten.
anglefloat, default: 45.0: Der Winkel zwischen dem Pfad und dem Kreuz in Grad. Der Winkel wird gemessen, als ob man eine Ameise wäre, die entlang der Kurve läuft, wobei null Grad direkt nach vorne, 90 nach links, -90 nach rechts und 180 nach hinten zeigt. Um die Seite der Kreuze zu ändern, ändern Sie das Vorzeichen des Winkels.
lengthfloat, default: 1.414: Die Länge des Kreuzes im Verhältnis zum Abstand. Empfohlene Länge = 1.414 (sqrt(2)) bei einem Winkel von 45 Grad, Länge = 1.0 bei einem Winkel von 90 Grad und Länge = 2.0 bei einem Winkel von 60 Grad.
**kwargs: Zusätzliche Schlüsselwörter werden gespeichert und an AbstractPathEffect._update_gc() weitergegeben.

Beispiele

Siehe TickedStroke patheffect.

draw_path(renderer, gc, tpath, affine, rgbFace)[source]#: Zeichnet den Pfad mit aktualisiertem GC.

class matplotlib.patheffects.withSimplePatchShadow(offset=(2, -2), shadow_rgbFace=None, alpha=None, rho=0.3, **kwargs)[source]#

Bases: SimplePatchShadow

Ein Kurzpfadeffekt zum Anwenden von SimplePatchShadow und anschließenden Zeichnen des ursprünglichen Künstlers.

Mit dieser Klasse können Sie

artist.set_path_effects([patheffects.withSimplePatchShadow()])

als Abkürzung für

artist.set_path_effects([patheffects.SimplePatchShadow(),
                         patheffects.Normal()])

Parameter:

offset(float, float), default: (2, -2): Der (x, y)-Offset des Schattens in Punkten.
shadow_rgbFacecolor: Die Schattenfarbe.
alphafloat, default: 0.3: Die Alpha-Transparenz des erzeugten Schattenpatches.
rhofloat, default: 0.3: Ein Skalierungsfaktor, der auf die rgbFace-Farbe angewendet wird, wenn shadow_rgbFace nicht angegeben ist.
**kwargs: Zusätzliche Schlüsselwörter werden gespeichert und an AbstractPathEffect._update_gc() weitergegeben.

draw_path(renderer, gc, tpath, affine, rgbFace)[source]#: Überschreibt die Standard-draw_path, um den Schattenoffset und die notwendigen Farbänderungen für den Schatten hinzuzufügen.

class matplotlib.patheffects.withStroke(offset=(0, 0), **kwargs)[source]#

Bases: Stroke

Ein Kurzpfadeffekt zum Anwenden von Stroke und anschließenden Zeichnen des ursprünglichen Künstlers.

Mit dieser Klasse können Sie

artist.set_path_effects([patheffects.withStroke()])

als Abkürzung für

artist.set_path_effects([patheffects.Stroke(),
                         patheffects.Normal()])

Der Pfad wird mit seinem GC gezeichnet, der mit den angegebenen Schlüsselwortargumenten aktualisiert wurde, d. h. die Schlüsselwortargumente sollten gültige GC-Parameterwerte sein.

draw_path(renderer, gc, tpath, affine, rgbFace)[source]#: Zeichnet den Pfad mit aktualisiertem GC.

class matplotlib.patheffects.withTickedStroke(offset=(0, 0), spacing=10.0, angle=45.0, length=np.float64(1.4142135623730951), **kwargs)[source]#

Bases: TickedStroke

Ein Kurzpfadeffekt zum Anwenden von TickedStroke und anschließenden Zeichnen des ursprünglichen Künstlers.

Mit dieser Klasse können Sie

artist.set_path_effects([patheffects.withTickedStroke()])

als Abkürzung für

artist.set_path_effects([patheffects.TickedStroke(),
                         patheffects.Normal()])

Parameter:

offset(float, float), default: (0, 0): Der (x, y)-Offset, der auf den Pfad angewendet wird, in Punkten.
spacingfloat, default: 10.0: Der Abstand zwischen den Kreuzen in Punkten.
anglefloat, default: 45.0: Der Winkel zwischen dem Pfad und dem Kreuz in Grad. Der Winkel wird gemessen, als ob man eine Ameise wäre, die entlang der Kurve läuft, wobei null Grad direkt nach vorne, 90 nach links, -90 nach rechts und 180 nach hinten zeigt. Um die Seite der Kreuze zu ändern, ändern Sie das Vorzeichen des Winkels.
lengthfloat, default: 1.414: Die Länge des Kreuzes im Verhältnis zum Abstand. Empfohlene Länge = 1.414 (sqrt(2)) bei einem Winkel von 45 Grad, Länge = 1.0 bei einem Winkel von 90 Grad und Länge = 2.0 bei einem Winkel von 60 Grad.
**kwargs: Zusätzliche Schlüsselwörter werden gespeichert und an AbstractPathEffect._update_gc() weitergegeben.

Beispiele

Siehe TickedStroke patheffect.

draw_path(renderer, gc, tpath, affine, rgbFace)[source]#: Zeichnet den Pfad mit aktualisiertem GC.

matplotlib.patheffects#

`matplotlib.patheffects`#