`matplotlib.figure`#

matplotlib.figure implementiert die folgenden Klassen

Figure: Die oberste Artist-Klasse, die alle Plot-Elemente enthält. Viele Methoden sind in FigureBase implementiert.
SubFigure: Eine logische Figur innerhalb einer Figur, die üblicherweise zu einer Figur (oder einer übergeordneten SubFigure) mit den Methoden Figure.add_subfigure oder Figure.subfigures hinzugefügt wird.

Figuren werden typischerweise mit den Pyplot-Methoden figure, subplots und subplot_mosaic erstellt.

fig, ax = plt.subplots(figsize=(2, 2), facecolor='lightskyblue',
                       layout='constrained')
fig.suptitle('Figure')
ax.set_title('Axes', loc='left', fontstyle='oblique', fontsize='medium')

(Quellcode, 2x.png, png)

Einige Situationen erfordern die direkte Instanziierung einer Figure-Klasse, üblicherweise innerhalb einer Anwendung irgendeiner Art (siehe Einbettung von Matplotlib in grafische Benutzeroberflächen für eine Liste von Beispielen). Weitere Informationen über Figuren finden Sie unter Einführung in Figuren.

Figure#

Figure-Klasse#

Figure

Der oberste Container für alle Plot-Elemente.

Hinzufügen von Achsen und Unterfiguren#

`Figure.add_axes`	Fügt der Figur eine `Achse` hinzu.
`Figure.add_subplot`	Fügt der Figur eine `Achse` als Teil eines Subplot-Arrangements hinzu.
`Figure.subplots`	Fügt dieser Abbildung einen Satz von Subplots hinzu.
`Figure.subplot_mosaic`	Erstellt ein Layout von Achsen basierend auf ASCII-Art oder verschachtelten Listen.
`Figure.add_gridspec`	Low-Level-API zur Erstellung eines `GridSpec`, das diese Figur als Elternteil hat.
`Figure.get_axes`	Liste der Achsen in der Figur.
`Figure.axes`	Liste der Achsen in der Figur.
`Figure.delaxes`	Entfernt die `Achse` ax aus der Figur; aktualisiert die aktuelle Achse.
`Figure.subfigures`	Fügt dieser Abbildung oder Unterabbildung einen Satz von Unterabbildungen hinzu.
`Figure.add_subfigure`	Fügt der Figur eine `SubFigure` als Teil eines Subplot-Arrangements hinzu.

Speichern#

Figure.savefig

Speichert die aktuelle Abbildung als Bild oder Vektorgrafik in einer Datei.

Annotation#

`Figure.colorbar`	Fügt einem Plot eine Farbleiste hinzu.
`Figure.legend`	Platziert eine Legende in der Abbildung.
`Figure.text`	Fügt der Abbildung Text hinzu.
`Figure.suptitle`	Fügt der Abbildung einen zentrierten Über-Titel hinzu.
`Figure.get_suptitle`	Gibt den Über-Titel als Zeichenkette zurück oder eine leere Zeichenkette, wenn er nicht gesetzt ist.
`Figure.supxlabel`	Fügt der Abbildung eine zentrierte übergeordnete X-Achsen-Beschriftung hinzu.
`Figure.get_supxlabel`	Gibt die übergeordnete X-Achsen-Beschriftung als Zeichenkette zurück oder eine leere Zeichenkette, wenn sie nicht gesetzt ist.
`Figure.supylabel`	Fügt der Abbildung eine zentrierte übergeordnete Y-Achsen-Beschriftung hinzu.
`Figure.get_supylabel`	Gibt die übergeordnete Y-Achsen-Beschriftung als Zeichenkette zurück oder eine leere Zeichenkette, wenn sie nicht gesetzt ist.
`Figure.align_labels`	Richtet die X-Achsen-Beschriftungen und Y-Achsen-Beschriftungen von Subplots in derselben Subplot-Zeile bzw. -Spalte aus, wenn die Beschriftungsausrichtung automatisch erfolgt (d.h. die Position der Beschriftung nicht manuell gesetzt ist).
`Figure.align_xlabels`	Richtet die X-Achsen-Beschriftungen von Subplots in derselben Subplot-Zeile aus, wenn die Beschriftungsausrichtung automatisch erfolgt (d.h. die Position der Beschriftung nicht manuell gesetzt ist).
`Figure.align_ylabels`	Richtet die Y-Achsen-Beschriftungen von Subplots in derselben Subplot-Spalte aus, wenn die Beschriftungsausrichtung automatisch erfolgt (d.h. die Position der Beschriftung nicht manuell gesetzt ist).
`Figure.align_titles`	Richtet die Titel von Subplots in derselben Subplot-Zeile aus, wenn die Titelausrichtung automatisch erfolgt (d.h. die Position des Titels nicht manuell gesetzt ist).
`Figure.autofmt_xdate`	Datum-Ticklabels überlappen sich oft, daher ist es nützlich, sie zu drehen und rechts auszurichten.

Figuren-Geometrie#

`Figure.set_size_inches`	Setzt die Figurengröße in Zoll.
`Figure.get_size_inches`	Gibt die aktuelle Figurengröße in Zoll zurück.
`Figure.set_figheight`	Setzt die Höhe der Figur in Zoll.
`Figure.get_figheight`	Gibt die Figurenhöhe in Zoll zurück.
`Figure.set_figwidth`	Setzt die Breite der Figur in Zoll.
`Figure.get_figwidth`	Gibt die Figurenbrite in Zoll zurück.
`Figure.dpi`	Die Auflösung in Dots Per Inch.
`Figure.set_dpi`	Setzt die Auflösung der Figur in Dots Per Inch.
`Figure.get_dpi`	Gibt die Auflösung in Dots Per Inch als Float zurück.

Subplot-Layout#

`Figure.subplots_adjust`	Passt die Subplot-Layout-Parameter an.
`Figure.set_layout_engine`	Setzt die Layout-Engine für diese Figur.
`Figure.get_layout_engine`

Veraltet oder wurde entfernt#

`Figure.tight_layout`	Passt den Abstand zwischen und um die Subplots an.
`Figure.set_tight_layout`	[Veraltet] Legt fest, ob und wie `Figure.tight_layout` beim Zeichnen aufgerufen wird.
`Figure.get_tight_layout`	Gibt zurück, ob `Figure.tight_layout` beim Zeichnen aufgerufen wird.
`Figure.set_constrained_layout`	[Veraltet] Legt fest, ob `constrained_layout` beim Zeichnen verwendet wird.
`Figure.get_constrained_layout`	Gibt zurück, ob ein eingeschränktes Layout verwendet wird.
`Figure.set_constrained_layout_pads`	[Veraltet] Legt den Abstand für `constrained_layout` fest.
`Figure.get_constrained_layout_pads`	[Veraltet] Holt den Abstand für `constrained_layout`.

Interaktivität#

Siehe auch

Ereignisbehandlung und Picking

`Figure.ginput`	Blockierender Aufruf zur Interaktion mit einer Abbildung.
`Figure.add_axobserver`	Immer wenn sich der Achsenstatus ändert, wird `func(self)` aufgerufen.
`Figure.waitforbuttonpress`	Blockierender Aufruf zur Interaktion mit der Abbildung.
`Figure.pick`	Verarbeitet ein Pick-Ereignis.

Aussehen ändern#

`Figure.set_frameon`	Setzt die Sichtbarkeit des Hintergrund-Patches der Figur, d.h. ob der Figurenhintergrund gezeichnet wird.
`Figure.get_frameon`	Gibt die Sichtbarkeit des Hintergrund-Patches der Figur zurück, d.h. ob der Figurenhintergrund gezeichnet wird.
`Figure.set_linewidth`	Legt die Linienbreite des Abbildungsrechtecks fest.
`Figure.get_linewidth`	Ruft die Linienbreite des Abbildungsrechtecks ab.
`Figure.set_facecolor`	Legt die Füllfarbe des Abbildungsrechtecks fest.
`Figure.get_facecolor`	Ruft die Füllfarbe des Abbildungsrechtecks ab.
`Figure.set_edgecolor`	Legt die Kantenfarbe des Abbildungsrechtecks fest.
`Figure.get_edgecolor`	Ruft die Kantenfarbe des Abbildungsrechtecks ab.

Hinzufügen und Abrufen von Künstlern#

`Figure.add_artist`	Fügt der Figur einen `Künstler` hinzu.
`Figure.get_children`	Gibt eine Liste der in der Abbildung enthaltenen Künstler zurück.
`Figure.figimage`	Fügt ein nicht-resampeltes Bild zur Abbildung hinzu.

Zustand abrufen und ändern#

Siehe auch

Interaktive Abbildungen

`Figure.clear`	Löscht die Figur.
`Figure.gca`	Ruft die aktuelle Achse ab.
`Figure.sca`	Setzt die aktuelle Achse auf a und gibt a zurück.
`Figure.get_tightbbox`	Gibt eine (enge) Begrenzungsbox der Figur in Zoll zurück.
`Figure.get_window_extent`	Ruft die Bounding Box des Künstlers im Anzeigeraum ab.
`Figure.show`	Wenn ein GUI-Backend mit Pyplot verwendet wird, zeigt das Figurenfenster an.
`Figure.set_canvas`	Setzt die Canvas, die die Figur enthält
`Figure.draw`	Zeichnet den Künstler (und seine Kinder) mit dem gegebenen Renderer.
`Figure.draw_without_rendering`	Zeichnet die Figur ohne Ausgabe.
`Figure.draw_artist`	Zeichnet nur den `Künstler` a.

SubFigure#

Matplotlib hat das Konzept einer SubFigure, die eine logische Figur innerhalb einer Elternfigur Figure ist. Sie verfügt über viele der gleichen Methoden wie die Elternfigur. Siehe Verschachtelte Achsenlayouts.

(Quellcode, 2x.png, png)

SubFigure-Klasse#

SubFigure

Logische Figur, die in einer Figur platziert werden kann.

Hinzufügen von Achsen und Unterfiguren#

`SubFigure.add_axes`	Fügt der Figur eine `Achse` hinzu.
`SubFigure.add_subplot`	Fügt der Figur eine `Achse` als Teil eines Subplot-Arrangements hinzu.
`SubFigure.subplots`	Fügt dieser Abbildung einen Satz von Subplots hinzu.
`SubFigure.subplot_mosaic`	Erstellt ein Layout von Achsen basierend auf ASCII-Art oder verschachtelten Listen.
`SubFigure.add_gridspec`	Low-Level-API zur Erstellung eines `GridSpec`, das diese Figur als Elternteil hat.
`SubFigure.delaxes`	Entfernt die `Achse` ax aus der Figur; aktualisiert die aktuelle Achse.
`SubFigure.add_subfigure`	Fügt der Figur eine `SubFigure` als Teil eines Subplot-Arrangements hinzu.
`SubFigure.subfigures`	Fügt dieser Abbildung oder Unterabbildung einen Satz von Unterabbildungen hinzu.

Annotation#

`SubFigure.colorbar`	Fügt einem Plot eine Farbleiste hinzu.
`SubFigure.legend`	Platziert eine Legende in der Abbildung.
`SubFigure.text`	Fügt der Abbildung Text hinzu.
`SubFigure.suptitle`	Fügt der Abbildung einen zentrierten Über-Titel hinzu.
`SubFigure.get_suptitle`	Gibt den Über-Titel als Zeichenkette zurück oder eine leere Zeichenkette, wenn er nicht gesetzt ist.
`SubFigure.supxlabel`	Fügt der Abbildung eine zentrierte übergeordnete X-Achsen-Beschriftung hinzu.
`SubFigure.get_supxlabel`	Gibt die übergeordnete X-Achsen-Beschriftung als Zeichenkette zurück oder eine leere Zeichenkette, wenn sie nicht gesetzt ist.
`SubFigure.supylabel`	Fügt der Abbildung eine zentrierte übergeordnete Y-Achsen-Beschriftung hinzu.
`SubFigure.get_supylabel`	Gibt die übergeordnete Y-Achsen-Beschriftung als Zeichenkette zurück oder eine leere Zeichenkette, wenn sie nicht gesetzt ist.
`SubFigure.align_labels`	Richtet die X-Achsen-Beschriftungen und Y-Achsen-Beschriftungen von Subplots in derselben Subplot-Zeile bzw. -Spalte aus, wenn die Beschriftungsausrichtung automatisch erfolgt (d.h. die Position der Beschriftung nicht manuell gesetzt ist).
`SubFigure.align_xlabels`	Richtet die X-Achsen-Beschriftungen von Subplots in derselben Subplot-Zeile aus, wenn die Beschriftungsausrichtung automatisch erfolgt (d.h. die Position der Beschriftung nicht manuell gesetzt ist).
`SubFigure.align_ylabels`	Richtet die Y-Achsen-Beschriftungen von Subplots in derselben Subplot-Spalte aus, wenn die Beschriftungsausrichtung automatisch erfolgt (d.h. die Position der Beschriftung nicht manuell gesetzt ist).
`SubFigure.align_titles`	Richtet die Titel von Subplots in derselben Subplot-Zeile aus, wenn die Titelausrichtung automatisch erfolgt (d.h. die Position des Titels nicht manuell gesetzt ist).

Hinzufügen und Abrufen von Künstlern#

`SubFigure.add_artist`	Fügt der Figur einen `Künstler` hinzu.
`SubFigure.get_children`	Gibt eine Liste der in der Abbildung enthaltenen Künstler zurück.

Aussehen ändern#

`SubFigure.set_frameon`	Setzt die Sichtbarkeit des Hintergrund-Patches der Figur, d.h. ob der Figurenhintergrund gezeichnet wird.
`SubFigure.get_frameon`	Gibt die Sichtbarkeit des Hintergrund-Patches der Figur zurück, d.h. ob der Figurenhintergrund gezeichnet wird.
`SubFigure.set_linewidth`	Legt die Linienbreite des Abbildungsrechtecks fest.
`SubFigure.get_linewidth`	Ruft die Linienbreite des Abbildungsrechtecks ab.
`SubFigure.set_facecolor`	Legt die Füllfarbe des Abbildungsrechtecks fest.
`SubFigure.get_facecolor`	Ruft die Füllfarbe des Abbildungsrechtecks ab.
`SubFigure.set_edgecolor`	Legt die Kantenfarbe des Abbildungsrechtecks fest.
`SubFigure.get_edgecolor`	Ruft die Kantenfarbe des Abbildungsrechtecks ab.

Weiterleitungen#

`SubFigure.set_dpi`	Setzt die Auflösung der Elternfigur in Dots Per Inch.
`SubFigure.get_dpi`	Gibt die Auflösung der Elternfigur in Dots Per Inch als Float zurück.

Basisklasse FigureBase#

class matplotlib.figure.FigureBase(**kwargs)[source]#

Basisklasse für Figure und SubFigure, die die Methoden enthält, die Künstler zur Figur oder Unterfigur hinzufügen, Achsen erstellen usw.

add_artist(artist, clip=False)[source]#

Fügt der Figur einen Künstler hinzu.

Üblicherweise werden Künstler zu Achsen-Objekten über Axes.add_artist hinzugefügt; diese Methode kann in den seltenen Fällen verwendet werden, in denen Künstler stattdessen direkt zur Figur hinzugefügt werden müssen.

Parameter:

artistArtist: Der Künstler, der zur Abbildung hinzugefügt werden soll. Wenn der hinzugefügte Künstler noch keinen Transform hat, wird sein Transform auf figure.transSubfigure gesetzt.
clipbool, default: False: Gibt an, ob der hinzugefügte Künstler vom Abbildungsrechteck beschnitten werden soll.

Gibt zurück:

Artist: Der hinzugefügte Künstler.

add_axes(*args, **kwargs)[source]#

Fügt der Figur eine Achse hinzu.

Aufrufsignaturen

add_axes(rect, projection=None, polar=False, **kwargs)
add_axes(ax)

Parameter:

recttuple (left, bottom, width, height): Die Dimensionen (links, unten, breite, höhe) der neuen Achse. Alle Größenangaben erfolgen in Bruchteilen der Figurenbrite und -höhe.
projection{None, 'aitoff', 'hammer', 'lambert', 'mollweide', 'polar', 'rectilinear', str}, optional: Der Projektionstyp der Achse. str ist der Name einer benutzerdefinierten Projektion, siehe projections. Der Standardwert None ergibt eine 'rechteckige' Projektion.
polarbool, default: False: Wenn True, ist dies äquivalent zu projection='polar'.
axes_classUnterklasse vom Typ Axes, optional: Die zu instanziierende axes.Axes-Unterklasse. Dieser Parameter ist inkompatibel mit projection und polar. Siehe axisartist für Beispiele.
sharex, shareyAchse, optional: Teilen Sie die x- oder y-Achse mit sharex und/oder sharey. Die Achse hat die gleichen Grenzen, Ticks und Skalen wie die Achse der geteilten Achsen.
labelstr: Ein Label für die zurückgegebene Achse.

Gibt zurück:

Achsen oder eine Unterklasse von Achsen: Die zurückgegebene Achsenklasse hängt von der verwendeten Projektion ab. Es ist Achsen, wenn eine rechteckige Projektion verwendet wird, und projections.polar.PolarAxes, wenn eine polare Projektion verwendet wird.

Andere Parameter:

**kwargs

Diese Methode nimmt auch die Schlüsselwortargumente für die zurückgegebene Achsenklasse entgegen. Die Schlüsselwortargumente für die rechteckige Achsenklasse Achsen finden Sie in der folgenden Tabelle, aber es kann auch andere Schlüsselwortargumente geben, wenn eine andere Projektion verwendet wird, siehe die tatsächliche Achsenklasse.

Eigenschaft	Beschreibung
`adjustable`	{'box', 'datalim'}
`agg_filter`	eine Filterfunktion, die ein (m, n, 3) Float-Array und einen dpi-Wert entgegennimmt und ein (m, n, 3) Array und zwei Offsets von der linken unteren Ecke des Bildes zurückgibt
`alpha`	float oder None
`anchor`	(float, float) oder {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
`animated`	bool
`aspect`	{'auto', 'equal'} oder float
`autoscale_on`	bool
`autoscalex_on`	unknown
`autoscaley_on`	unknown
`axes_locator`	Callable[[Axes, Renderer], Bbox]
`axisbelow`	bool oder 'line'
`box_aspect`	float oder None
`clip_box`	`BboxBase` oder None
`clip_on`	bool
`clip_path`	Patch oder (Path, Transform) oder None
`facecolor` oder `fc`	color
`figure`	`Figure` oder `SubFigure`
`forward_navigation_events`	bool oder "auto"
`frame_on`	bool
`gid`	str
`in_layout`	bool
`label`	object
`mouseover`	bool
`navigate`	bool
`navigate_mode`	unknown
`path_effects`	liste von `AbstractPathEffect`
`picker`	None oder bool oder float oder callable
`position`	[links, unten, breite, höhe] oder `Bbox`
`prop_cycle`	`Cycler`
`rasterization_zorder`	float oder None
`rasterized`	bool
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool oder None
`subplotspec`	unknown
`title`	str
`transform`	`Transform`
`url`	str
`visible`	bool
`xbound`	(lower: float, upper: float)
`xlabel`	str
`xlim`	(left: float, right: float)
`xmargin`	float größer als -0.5
`xscale`	unknown
`xticklabels`	unknown
`xticks`	unknown
`ybound`	(lower: float, upper: float)
`ylabel`	str
`ylim`	(bottom: float, top: float)
`ymargin`	float größer als -0.5
`yscale`	unknown
`yticklabels`	unknown
`yticks`	unknown
`zorder`	float

Siehe auch

Figure.add_subplot
pyplot.subplot
pyplot.axes
Figure.subplots
pyplot.subplots

Anmerkungen

In seltenen Fällen kann add_axes mit einem einzigen Argument aufgerufen werden, einer Achse-Instanz, die bereits in der aktuellen Figur erstellt wurde, aber nicht in der Liste der Achsen der Figur.

Beispiele

Einige einfache Beispiele

rect = l, b, w, h
fig = plt.figure()
fig.add_axes(rect)
fig.add_axes(rect, frameon=False, facecolor='g')
fig.add_axes(rect, polar=True)
ax = fig.add_axes(rect, projection='polar')
fig.delaxes(ax)
fig.add_axes(ax)

add_gridspec(nrows=1, ncols=1, **kwargs)[source]#

Low-Level-API zur Erstellung eines GridSpec, das diese Figur als Elternteil hat.

Dies ist eine Low-Level-API, die es Ihnen ermöglicht, einen Gridspec zu erstellen und anschließend Subplots basierend auf dem Gridspec hinzuzufügen. Die meisten Benutzer benötigen diese Freiheit nicht und sollten die High-Level-Methoden subplots oder subplot_mosaic verwenden.

Parameter:

nrowsint, default: 1: Anzahl der Zeilen im Raster.
ncolsint, default: 1: Anzahl der Spalten im Raster.

Gibt zurück:

GridSpec

Andere Parameter:

**kwargs: Schlüsselwortargumente werden an GridSpec übergeben.

Siehe auch

matplotlib.pyplot.subplots

Beispiele

Hinzufügen eines Subplots, der zwei Zeilen überspannt

fig = plt.figure()
gs = fig.add_gridspec(2, 2)
ax1 = fig.add_subplot(gs[0, 0])
ax2 = fig.add_subplot(gs[1, 0])
# spans two rows:
ax3 = fig.add_subplot(gs[:, 1])

add_subfigure(subplotspec, **kwargs)[source]#

Fügt der Figur eine SubFigure als Teil eines Subplot-Arrangements hinzu.

Parameter:

subplotspecgridspec.SubplotSpec: Definiert den Bereich in einem übergeordneten GridSpec, in dem die Unterabbildung platziert wird.

Gibt zurück:

SubFigure

Andere Parameter:

**kwargs: Werden an das SubFigure-Objekt übergeben.

Siehe auch

Figure.subfigures

add_subplot(*args, **kwargs)[source]#

Fügt der Figur eine Achse als Teil eines Subplot-Arrangements hinzu.

Aufrufsignaturen

add_subplot(nrows, ncols, index, **kwargs)
add_subplot(pos, **kwargs)
add_subplot(ax)
add_subplot()

Parameter:

*argsint, (int, int, index), oder SubplotSpec, Standard: (1, 1, 1)

Die Position des Subplots, beschrieben durch eines der folgenden:

Drei Ganzzahlen (*nrows*, *ncols*, *index*). Der Subplot nimmt die index-Position in einem Raster mit nrows Zeilen und ncols Spalten ein. index beginnt in der oberen linken Ecke mit 1 und erhöht sich nach rechts. index kann auch ein Tupel aus zwei Zahlen sein, das die (erste, letzte) Indizes (1-basiert und einschließlich letzter) des Subplots angibt, z. B. fig.add_subplot(3, 1, (1, 2)) erstellt einen Subplot, der sich über die oberen 2/3 der Abbildung erstreckt.
Eine 3-stellige Ganzzahl. Die Ziffern werden so interpretiert, als wären sie separat als drei einstellige Ganzzahlen angegeben, d. h. fig.add_subplot(235) ist dasselbe wie fig.add_subplot(2, 3, 5). Beachten Sie, dass dies nur verwendet werden kann, wenn nicht mehr als 9 Subplots vorhanden sind.
Ein SubplotSpec.

In seltenen Fällen kann add_subplot mit einem einzigen Argument aufgerufen werden, einer Subplot-Achsen-Instanz, die bereits in der aktuellen Figur erstellt wurde, aber nicht in der Liste der Achsen der Figur.

projection{None, 'aitoff', 'hammer', 'lambert', 'mollweide', 'polar', 'rectilinear', str}, optional

Der Projektionstyp des Subplots (Achse). str ist der Name einer benutzerdefinierten Projektion, siehe projections. Der Standardwert None ergibt eine 'rechteckige' Projektion.

polarbool, default: False

Wenn True, ist dies äquivalent zu projection='polar'.

axes_classUnterklasse vom Typ Axes, optional

Die zu instanziierende axes.Axes-Unterklasse. Dieser Parameter ist inkompatibel mit projection und polar. Siehe axisartist für Beispiele.

sharex, shareyAchse, optional

Teilen Sie die x- oder y-Achse mit sharex und/oder sharey. Die Achse hat die gleichen Grenzen, Ticks und Skalen wie die Achse der geteilten Achsen.

labelstr

Ein Label für die zurückgegebene Achse.

Gibt zurück:

Axes: Die Achsen des Subplots. Die zurückgegebene Achse kann tatsächlich eine Instanz einer Unterklasse sein, z. B. projections.polar.PolarAxes für polare Projektionen.

Andere Parameter:

**kwargs

Diese Methode nimmt auch die Schlüsselwortargumente für die zurückgegebene Basisklasse der Achsen entgegen; außer dem Argument figure. Die Schlüsselwortargumente für die rechteckige Basisklasse Achsen finden Sie in der folgenden Tabelle, aber es können auch andere Schlüsselwortargumente vorhanden sein, wenn eine andere Projektion verwendet wird.

Eigenschaft	Beschreibung
`adjustable`	{'box', 'datalim'}
`agg_filter`	eine Filterfunktion, die ein (m, n, 3) Float-Array und einen dpi-Wert entgegennimmt und ein (m, n, 3) Array und zwei Offsets von der linken unteren Ecke des Bildes zurückgibt
`alpha`	float oder None
`anchor`	(float, float) oder {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
`animated`	bool
`aspect`	{'auto', 'equal'} oder float
`autoscale_on`	bool
`autoscalex_on`	unknown
`autoscaley_on`	unknown
`axes_locator`	Callable[[Axes, Renderer], Bbox]
`axisbelow`	bool oder 'line'
`box_aspect`	float oder None
`clip_box`	`BboxBase` oder None
`clip_on`	bool
`clip_path`	Patch oder (Path, Transform) oder None
`facecolor` oder `fc`	color
`figure`	`Figure` oder `SubFigure`
`forward_navigation_events`	bool oder "auto"
`frame_on`	bool
`gid`	str
`in_layout`	bool
`label`	object
`mouseover`	bool
`navigate`	bool
`navigate_mode`	unknown
`path_effects`	liste von `AbstractPathEffect`
`picker`	None oder bool oder float oder callable
`position`	[links, unten, breite, höhe] oder `Bbox`
`prop_cycle`	`Cycler`
`rasterization_zorder`	float oder None
`rasterized`	bool
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool oder None
`subplotspec`	unknown
`title`	str
`transform`	`Transform`
`url`	str
`visible`	bool
`xbound`	(lower: float, upper: float)
`xlabel`	str
`xlim`	(left: float, right: float)
`xmargin`	float größer als -0.5
`xscale`	unknown
`xticklabels`	unknown
`xticks`	unknown
`ybound`	(lower: float, upper: float)
`ylabel`	str
`ylim`	(bottom: float, top: float)
`ymargin`	float größer als -0.5
`yscale`	unknown
`yticklabels`	unknown
`yticks`	unknown
`zorder`	float

Siehe auch

Figure.add_axes
pyplot.subplot
pyplot.axes
Figure.subplots
pyplot.subplots

Beispiele

fig = plt.figure()

fig.add_subplot(231)
ax1 = fig.add_subplot(2, 3, 1)  # equivalent but more general

fig.add_subplot(232, frameon=False)  # subplot with no frame
fig.add_subplot(233, projection='polar')  # polar subplot
fig.add_subplot(234, sharex=ax1)  # subplot sharing x-axis with ax1
fig.add_subplot(235, facecolor="red")  # red subplot

ax1.remove()  # delete ax1 from the figure
fig.add_subplot(ax1)  # add ax1 back to the figure

align_labels(axs=None)[source]#

Richtet die X-Achsen-Beschriftungen und Y-Achsen-Beschriftungen von Subplots in derselben Subplot-Zeile bzw. -Spalte aus, wenn die Beschriftungsausrichtung automatisch erfolgt (d.h. die Position der Beschriftung nicht manuell gesetzt ist).

Die Ausrichtung bleibt für Zeichenereignisse bestehen, nachdem diese aufgerufen wurde.

Parameter:

axsListe von Achsen: Optionale Liste (oder ndarray) von Achsen, um die Beschriftungen auszurichten. Standardmäßig werden alle Achsen auf der Figur ausgerichtet.

Siehe auch

matplotlib.figure.Figure.align_xlabels
matplotlib.figure.Figure.align_ylabels
matplotlib.figure.Figure.align_titles

Anmerkungen

Dies geht davon aus, dass alle Achsen in axs aus demselben GridSpec stammen, sodass ihre SubplotSpec-Positionen den FigurenpOSITIONen entsprechen.

align_titles(axs=None)[source]#

Richtet die Titel von Subplots in derselben Subplot-Zeile aus, wenn die Titelausrichtung automatisch erfolgt (d.h. die Position des Titels nicht manuell gesetzt ist).

Die Ausrichtung bleibt für Zeichenereignisse bestehen, nachdem diese aufgerufen wurde.

Parameter:

axsListe von Achsen: Optionale Liste von (oder ndarray) Achsen, um die Titel auszurichten. Standardmäßig werden alle Achsen auf der Figur ausgerichtet.

Siehe auch

matplotlib.figure.Figure.align_xlabels
matplotlib.figure.Figure.align_ylabels
matplotlib.figure.Figure.align_labels

Anmerkungen

Dies geht davon aus, dass alle Achsen in axs aus demselben GridSpec stammen, sodass ihre SubplotSpec-Positionen den FigurenpOSITIONen entsprechen.

Beispiele

Beispiel mit Titeln

fig, axs = plt.subplots(1, 2)
axs[0].set_aspect('equal')
axs[0].set_title('Title 0')
axs[1].set_title('Title 1')
fig.align_titles()

align_xlabels(axs=None)[source]#

Richtet die X-Achsen-Beschriftungen von Subplots in derselben Subplot-Zeile aus, wenn die Beschriftungsausrichtung automatisch erfolgt (d.h. die Position der Beschriftung nicht manuell gesetzt ist).

Die Ausrichtung bleibt für Zeichenereignisse bestehen, nachdem diese aufgerufen wurde.

Wenn sich eine Beschriftung unten befindet, wird sie an Beschriftungen auf Axes ausgerichtet, die ebenfalls ihre Beschriftung unten haben und dieselbe unterste Zeile des Subplots aufweisen. Wenn sich die Beschriftung oben befindet, wird sie an Beschriftungen auf Axes mit derselben obersten Zeile ausgerichtet.

Parameter:

axsListe von Achsen: Optionale Liste von (oder ndarray) Achsen, um die x-Beschriftungen auszurichten. Standardmäßig werden alle Achsen auf der Figur ausgerichtet.

Siehe auch

matplotlib.figure.Figure.align_ylabels
matplotlib.figure.Figure.align_titles
matplotlib.figure.Figure.align_labels

Anmerkungen

Dies geht davon aus, dass alle Achsen in axs aus demselben GridSpec stammen, sodass ihre SubplotSpec-Positionen den FigurenpOSITIONen entsprechen.

Beispiele

Beispiel mit gedrehten xtick-Beschriftungen

fig, axs = plt.subplots(1, 2)
for tick in axs[0].get_xticklabels():
    tick.set_rotation(55)
axs[0].set_xlabel('XLabel 0')
axs[1].set_xlabel('XLabel 1')
fig.align_xlabels()

align_ylabels(axs=None)[source]#

Richtet die Y-Achsen-Beschriftungen von Subplots in derselben Subplot-Spalte aus, wenn die Beschriftungsausrichtung automatisch erfolgt (d.h. die Position der Beschriftung nicht manuell gesetzt ist).

Die Ausrichtung bleibt für Zeichenereignisse bestehen, nachdem diese aufgerufen wurde.

Wenn sich eine Beschriftung links befindet, wird sie an Beschriftungen auf Axes ausgerichtet, die ebenfalls ihre Beschriftung links haben und dieselbe linkeste Spalte des Subplots aufweisen. Wenn sich die Beschriftung rechts befindet, wird sie an Beschriftungen auf Axes mit derselben rechtesten Spalte ausgerichtet.

Parameter:

axsListe von Achsen: Optionale Liste (oder ndarray) von Achsen, um die y-Beschriftungen auszurichten. Standardmäßig werden alle Achsen auf der Figur ausgerichtet.

Siehe auch

matplotlib.figure.Figure.align_xlabels
matplotlib.figure.Figure.align_titles
matplotlib.figure.Figure.align_labels

Anmerkungen

Dies geht davon aus, dass alle Achsen in axs aus demselben GridSpec stammen, sodass ihre SubplotSpec-Positionen den FigurenpOSITIONen entsprechen.

Beispiele

Beispiel mit großen ytick-Beschriftungen

fig, axs = plt.subplots(2, 1)
axs[0].plot(np.arange(0, 1000, 50))
axs[0].set_ylabel('YLabel 0')
axs[1].set_ylabel('YLabel 1')
fig.align_ylabels()

autofmt_xdate(bottom=0.2, rotation=30, ha='right', which='major')[source]#

Datum-Ticklabels überlappen sich oft, daher ist es nützlich, sie zu drehen und rechts auszurichten. Ein häufiger Anwendungsfall ist auch eine Reihe von Subplots mit gemeinsamer x-Achse, bei der die x-Achse Datumsdaten enthält. Die Ticklabels sind oft lang, und es hilft, sie auf dem unteren Subplot zu drehen und auf anderen Subplots zu deaktivieren sowie die x-Beschriftungen zu deaktivieren.

Parameter:

bottomfloat, Standard: 0.2: Der untere Rand der Subplots für subplots_adjust.
rotationfloat, Standard: 30 Grad: Der Drehwinkel der xtick-Beschriftungen in Grad.
ha{'left', 'center', 'right'}, Standard: 'right': Die horizontale Ausrichtung der xticklabels.
which{'major', 'minor', 'both'}, Standard: 'major': Wählt aus, welche Ticklabels gedreht werden sollen.

clear(keep_observers=False)[source]#

Löscht die Figur.

Parameter:

keep_observersbool, Standard: False: Setzen Sie keep_observers auf True, wenn z. B. ein GUI-Widget die Achsen in der Figur verfolgt.

clf(keep_observers=False)[source]#

[Veraltet] Alias für die Methode clear().

Veraltet

Die Verwendung von clf() wird nicht empfohlen. Verwenden Sie stattdessen clear().

Parameter:

keep_observersbool, Standard: False: Setzen Sie keep_observers auf True, wenn z. B. ein GUI-Widget die Achsen in der Figur verfolgt.

colorbar(mappable, cax=None, ax=None, use_gridspec=True, **kwargs)[source]#

Fügt einem Plot eine Farbleiste hinzu.

Parameter:

mappable

Der matplotlib.cm.ScalarMappable (d.h. AxesImage, ContourSet, etc.), der von dieser Farbleiste beschrieben wird. Dieses Argument ist für die Methode Figure.colorbar zwingend erforderlich, für die Funktion pyplot.colorbar jedoch optional, welche standardmäßig das aktuelle Bild verwendet.

Beachten Sie, dass Sie eine ScalarMappable "on-the-fly" erstellen können, um Farbleisten zu erzeugen, die nicht an einen zuvor gezeichneten Künstler gebunden sind, z.B.

fig.colorbar(cm.ScalarMappable(norm=norm, cmap=cmap), ax=ax)

caxAchsen, optional

Axes, in die die Farbleiste gezeichnet werden soll. Wenn None, wird ein neues Axes-Objekt erstellt und der Platz dafür von den in ax angegebenen Axes gestohlen.

axAchsen oder iterierbar oder numpy.ndarray von Achsen, optional

Die einen oder mehreren übergeordneten Axes, aus denen Platz für ein neues Farbleisten-Axes-Objekt entnommen wird. Dieser Parameter wird nur verwendet, wenn cax nicht gesetzt ist.

Standardmäßig die Axes, die die für die Erstellung der Farbleiste verwendete mappbare Einheit enthalten.

use_gridspecbool, optional

Wenn cax None ist, wird ein neues cax als Instanz von Axes erstellt. Wenn ax mit einer Subplotspec positioniert ist und use_gridspec True ist, wird cax ebenfalls mit einer Subplotspec positioniert.

Gibt zurück:

colorbarColorbar

Andere Parameter:

locationNone oder {'left', 'right', 'top', 'bottom'}

Die Position relativ zu den übergeordneten Axes, an der die Farbleisten-Axes erstellt werden. Sie bestimmt auch die Ausrichtung der Farbleiste (Farbleisten links und rechts sind vertikal, Farbleisten oben und unten sind horizontal). Wenn None, stammt die Position aus der Ausrichtung, wenn diese gesetzt ist (vertikale Farbleisten rechts, horizontale unten), oder standardmäßig auf 'right', wenn orientation nicht gesetzt ist.

orientationNone oder {'vertical', 'horizontal'}

Die Ausrichtung der Farbleiste. Es ist vorzuziehen, die Position der Farbleiste festzulegen, da diese auch die Ausrichtung bestimmt; das Übergeben inkompatibler Werte für location und orientation führt zu einer Ausnahme.

fractionfloat, Standard: 0.15

Anteil der ursprünglichen Axes, der für die Farbleiste verwendet wird.

shrinkfloat, Standard: 1.0

Faktor, mit dem die Größe der Farbleiste multipliziert wird.

aspectfloat, Standard: 20

Verhältnis von langen zu kurzen Seiten.

padfloat, Standard: 0.05 bei vertikal, 0.15 bei horizontal

Anteil der ursprünglichen Axes zwischen der Farbleiste und den neuen Bild-Axes.

anchor(float, float), optional

Der Ankerpunkt der Farbleisten-Axes. Standardmäßig (0.0, 0.5) bei vertikaler Ausrichtung; (0.5, 1.0) bei horizontaler Ausrichtung.

panchor(float, float), oder False, optional

Der Ankerpunkt der übergeordneten Axes der Farbleiste. Wenn False, bleibt der Anker der übergeordneten Axes unverändert. Standardmäßig (1.0, 0.5) bei vertikaler Ausrichtung; (0.5, 0.0) bei horizontaler Ausrichtung.

extend{'neither', 'both', 'min', 'max'}

Erzeugt spitze Enden für Werte außerhalb des Bereichs (außer 'neither'). Diese werden für eine bestimmte Colormap über die Methoden set_under und set_over der Colormap gesetzt.

extendfrac{None, 'auto', Länge, Längen}

Wenn auf None gesetzt, haben sowohl die minimale als auch die maximale dreieckige Farbleisten-Erweiterung eine Länge von 5 % der Länge der inneren Farbleiste (dies ist die Standardeinstellung).

Wenn auf 'auto' gesetzt, haben die dreieckigen Farbleisten-Erweiterungen dieselben Längen wie die inneren Boxen (wenn spacing auf 'uniform' gesetzt ist) oder dieselben Längen wie die jeweiligen angrenzenden inneren Boxen (wenn spacing auf 'proportional' gesetzt ist).

Wenn ein Skalar, gibt er die Länge sowohl der minimalen als auch der maximalen dreieckigen Farbleisten-Erweiterungen als Bruchteil der Länge der inneren Farbleiste an. Eine Sequenz von zwei Brüchen kann ebenfalls angegeben werden, die die Längen der minimalen und maximalen Farbleisten-Erweiterungen als Bruchteil der Länge der inneren Farbleiste angibt.

extendrectbool

Wenn False, sind die minimale und maximale Farbleisten-Erweiterung dreieckig (Standard). Wenn True, sind die Erweiterungen rechteckig.

ticksNone oder Liste von Ticks oder Locator

Wenn None, werden die Ticks automatisch aus der Eingabe bestimmt.

formatNone oder str oder Formatter

Wenn None, wird ScalarFormatter verwendet. Formatzeichenfolgen, z.B. "%4.2e" oder "{x:.2e}", werden unterstützt. Stattdessen kann ein alternativer Formatter angegeben werden.

drawedgesbool

Ob Linien an den Farbgrenzen gezeichnet werden sollen.

labelstr

Die Beschriftung der langen Achse der Farbleiste.

boundaries, valuesNone oder eine Sequenz

Wenn nicht gesetzt, wird die Colormap auf einer Skala von 0-1 angezeigt. Wenn Sequenzen, muss values eine um 1 geringere Länge als boundaries haben. Für jede Region, die durch benachbarte Einträge in boundaries begrenzt wird, wird die Farbe verwendet, die dem entsprechenden Wert in values zugeordnet ist. Die Größe jeder Region wird durch den Parameter spacing bestimmt. Normalerweise nur nützlich für indizierte Farben (d. h. norm=NoNorm()) oder andere ungewöhnliche Umstände.

spacing{'uniform', 'proportional'}

Für diskrete Farbleisten ('uniform' gibt jeder Farbe den gleichen Platz; 'proportional' macht den Platz proportional zum Datenintervall).

Anmerkungen

Wenn mappable ein ContourSet ist, wird dessen extend-Schlüsselwortargument automatisch berücksichtigt.

Das shrink-Keyword-Argument bietet eine einfache Möglichkeit, die Farbleiste relativ zu den Axes zu skalieren. Beachten Sie, dass, wenn cax angegeben ist, dieses die Größe der Farbleiste bestimmt und shrink und aspect ignoriert werden.

Für eine präzisere Steuerung können Sie die Positionen der Axes-Objekte, in denen die mappbare Einheit und die Farbleiste gezeichnet werden, manuell angeben. In diesem Fall verwenden Sie keine der Axes-Eigenschaften-Keywords.

Es ist bekannt, dass einige Vektorgrafik-Viewer (svg und pdf) weiße Lücken zwischen den Segmenten der Farbleiste rendern. Dies liegt an Fehlern in den Viewern, nicht in Matplotlib. Als Workaround kann die Farbleiste mit überlappenden Segmenten gerendert werden

cbar = colorbar()
cbar.solids.set_edgecolor("face")
draw()

Dies hat jedoch in anderen Umständen negative Auswirkungen, z. B. bei halbtransparenten Bildern (Alpha < 1) und Farbleisten-Erweiterungen; daher wird dieser Workaround standardmäßig nicht verwendet (siehe Issue #1188).

contains(mouseevent)[source]#

Testet, ob das Mausereignis auf der Abbildung aufgetreten ist.

Gibt zurück:

bool, {}

delaxes(ax)[source]#: Entfernt die Achse ax aus der Figur; aktualisiert die aktuelle Achse.

draw(renderer)[source]#

Zeichnet den Künstler (und seine Kinder) mit dem gegebenen Renderer.

Dies hat keine Auswirkung, wenn der Künstler nicht sichtbar ist (Artist.get_visible gibt False zurück).

Parameter:

rendererRendererBase Unterklasse.

Anmerkungen

Diese Methode wird in den Künstler-Unterklassen überschrieben.

property figure#: Die Stamm-Figure. Um den übergeordneten Teil einer SubFigure zu erhalten, verwenden Sie die Methode get_figure.

property frameon#: Gibt die Sichtbarkeit des Hintergrund-Patches der Figure zurück, d. h. ob der Hintergrund der Figure gezeichnet wird. Entspricht Figure.patch.get_visible().

gca()[source]#

Ruft die aktuelle Achse ab.

Wenn sich derzeit keine Achsen auf dieser Abbildung befinden, wird eine neue erstellt, indem Figure.add_subplot verwendet wird. (Um zu testen, ob sich derzeit Achsen auf einer Abbildung befinden, prüfen Sie, ob figure.axes leer ist. Um zu testen, ob sich derzeit eine Abbildung im Pyplot-Abbildungsstapel befindet, prüfen Sie, ob pyplot.get_fignums() leer ist.)

get_children()[source]#: Gibt eine Liste der in der Abbildung enthaltenen Künstler zurück.

get_default_bbox_extra_artists()[source]#: Gibt eine Liste von Künstlern zurück, die typischerweise in Figure.get_tightbbox verwendet werden.

get_edgecolor()[source]#: Ruft die Kantenfarbe des Abbildungsrechtecks ab.

get_facecolor()[source]#: Ruft die Füllfarbe des Abbildungsrechtecks ab.

get_figure(root=None)[source]#

Gibt die Figure oder SubFigure Instanz zurück, zu der die (Sub)Figur gehört.

Parameter:

rootbool, default=True: Wenn False, wird die (Sub)Figure zurückgegeben, auf der sich dieser Künstler befindet. Wenn True, wird die Wurzel-Figure für einen verschachtelten Baum von SubFigures zurückgegeben.

Veraltet seit Version 3.10: Ab Version 3.12 wird root standardmäßig auf False gesetzt.

get_frameon()[source]#: Gibt die Sichtbarkeit des Hintergrund-Patches der Figure zurück, d. h. ob der Hintergrund der Figure gezeichnet wird. Entspricht Figure.patch.get_visible().

get_linewidth()[source]#: Ruft die Linienbreite des Abbildungsrechtecks ab.

get_suptitle()[source]#: Gibt den Über-Titel als Zeichenkette zurück oder eine leere Zeichenkette, wenn er nicht gesetzt ist.

get_supxlabel()[source]#: Gibt die übergeordnete X-Achsen-Beschriftung als Zeichenkette zurück oder eine leere Zeichenkette, wenn sie nicht gesetzt ist.

get_supylabel()[source]#: Gibt die übergeordnete Y-Achsen-Beschriftung als Zeichenkette zurück oder eine leere Zeichenkette, wenn sie nicht gesetzt ist.

get_tightbbox(renderer=None, *, bbox_extra_artists=None)[source]#

Gibt eine (enge) Begrenzungsbox der Figur in Zoll zurück.

Beachten Sie, dass sich FigureBase von allen anderen Künstlern unterscheidet, die ihre Bbox in Pixeln zurückgeben.

Künstler, bei denen artist.set_in_layout(False) gesetzt ist, werden nicht in die Bbox aufgenommen.

Parameter:

rendererRendererBase subclass: Renderer, der zum Zeichnen der Abbildungen verwendet wird (d.h. fig.canvas.get_renderer())
bbox_extra_artistsListe von Artist oder None: Liste von Künstlern, die in die enge Bounding Box aufgenommen werden sollen. Wenn None (Standard) ist, werden alle Künstler-Kinder jeder Achse in die enge Bounding Box aufgenommen.

Gibt zurück:

BboxBase: die die Bounding Box enthält (in Abbildungszoll).

get_window_extent(renderer=None)[source]#

Ruft die Bounding Box des Künstlers im Anzeigeraum ab.

Die Breite und Höhe der Bounding Box sind nicht negativ.

Unterklassen sollten für die Aufnahme in die "enge" Bounding-Box-Berechnung überschrieben werden. Standard ist die Rückgabe einer leeren Bounding Box bei 0, 0.

Seien Sie vorsichtig bei der Verwendung dieser Funktion, die Ergebnisse werden nicht aktualisiert, wenn sich die Fenstererweiterung des Künstlers ändert. Die Erweiterung kann sich aufgrund von Änderungen im Transformationsstapel ändern, wie z. B. Änderungen der Axes-Limits, der Figure-Größe oder der verwendeten Canvas (wie beim Speichern einer Figure). Dies kann zu unerwartetem Verhalten führen, bei dem interaktive Figures auf dem Bildschirm gut aussehen, aber falsch gespeichert werden.

legend(*args, **kwargs)[source]#

Platziert eine Legende in der Abbildung.

Aufrufsignaturen

legend()
legend(handles, labels)
legend(handles=handles)
legend(labels)

Die Aufrufsignaturen entsprechen den folgenden verschiedenen Möglichkeiten, diese Methode zu verwenden

1. Automatische Erkennung von Elementen für die Legende

Die Elemente, die der Legende hinzugefügt werden sollen, werden automatisch ermittelt, wenn Sie keine zusätzlichen Argumente übergeben.

In diesem Fall werden die Beschriftungen vom Künstler übernommen. Sie können diese entweder bei der Erstellung des Künstlers festlegen oder durch Aufrufen der Methode set_label() des Künstlers.

ax.plot([1, 2, 3], label='Inline label')
fig.legend()

oder

line, = ax.plot([1, 2, 3])
line.set_label('Label via method')
fig.legend()

Einzelne Linien können von der automatischen Legenden-Elementauswahl ausgeschlossen werden, indem ein Beschriftungsname beginnt mit einem Unterstrich definiert wird. Dies ist standardmäßig für alle Künstler der Fall, sodass das Aufrufen von Figure.legend ohne Argumente und ohne manuelles Festlegen der Beschriftungen dazu führt, dass keine Legende gezeichnet wird.

2. Explizites Auflisten der Künstler und Beschriftungen in der Legende

Für die vollständige Kontrolle darüber, welche Künstler einen Legendeneintrag haben, ist es möglich, ein Iterable von Legendenkünstlern gefolgt von einem Iterable von Legendenbeschriftungen zu übergeben

fig.legend([line1, line2, line3], ['label1', 'label2', 'label3'])

3. Explizites Auflisten der Künstler in der Legende

Dies ist ähnlich wie 2, aber die Beschriftungen werden aus den Label-Eigenschaften der Künstler übernommen. Beispiel

line1, = ax1.plot([1, 2, 3], label='label1')
line2, = ax2.plot([1, 2, 3], label='label2')
fig.legend(handles=[line1, line2])

4. Beschriften vorhandener Plot-Elemente

Veraltet

Diese Aufrufsignatur wird nicht empfohlen, da die Beziehung zwischen Plot-Elementen und Beschriftungen nur implizit durch ihre Reihenfolge gegeben ist und leicht durcheinander geraten kann.

Um eine Legende für alle Künstler auf allen Axes zu erstellen, rufen Sie diese Funktion mit einem Iterable von Strings auf, einem für jeden Legenden-Eintrag. Zum Beispiel

fig, (ax1, ax2) = plt.subplots(1, 2)
ax1.plot([1, 3, 5], color='blue')
ax2.plot([2, 4, 6], color='red')
fig.legend(['the blues', 'the reds'])

Parameter:

handlesListe von Artist, optional

Eine Liste von Künstlern (Linien, Patches), die der Legende hinzugefügt werden sollen. Verwenden Sie dies zusammen mit labels, wenn Sie vollständige Kontrolle darüber benötigen, was in der Legende angezeigt wird und der oben beschriebene automatische Mechanismus nicht ausreicht.

Die Länge von Handles und Labels sollte in diesem Fall gleich sein. Wenn sie nicht gleich sind, werden sie auf die kleinere Länge gekürzt.

labelsListe von str, optional

Eine Liste von Bezeichnern, die neben den Künstlern angezeigt werden sollen. Verwenden Sie dies zusammen mit handles, wenn Sie die volle Kontrolle darüber benötigen, was in der Legende angezeigt wird, und der automatische Mechanismus, der oben beschrieben wurde, nicht ausreicht.

Gibt zurück:

Legende

Andere Parameter:

locstr oder Paar von Floats, Standard: 'upper right'

Die Position der Legende.

Die Strings 'upper left', 'upper right', 'lower left', 'lower right' platzieren die Legende in der entsprechenden Ecke der Abbildung.

Die Strings 'upper center', 'lower center', 'center left', 'center right' platzieren die Legende in der Mitte des entsprechenden Rands der Abbildung.

Der String 'center' platziert die Legende in der Mitte der Abbildung.

Die Position kann auch ein 2er-Tupel sein, das die Koordinaten der unteren linken Ecke der Legende in Abbildungskoordinaten angibt (in diesem Fall wird bbox_to_anchor ignoriert).

Zur Abwärtskompatibilität kann 'center right' (aber keine andere Position) auch als 'right' geschrieben werden, und jede "Zeichenketten"-Position kann auch als numerischer Wert angegeben werden.

Positionszeichenkette	Positions-Code
'best' (nur Achsen)	0
'oben rechts'	1
'oben links'	2
'unten links'	3
'unten rechts'	4
'rechts'	5
'links mitte'	6
'rechts mitte'	7
'unten mitte'	8
'oben mitte'	9
'mitte'	10

Wenn eine Abbildung den Constrained Layout Manager verwendet, können die Zeichenketten-Codes des loc-Schlüsselwortarguments durch das Präfix 'outside' ein besseres Layoutverhalten erzielen. An den Ecken gibt es Mehrdeutigkeiten, daher wird 'outside upper right' Platz über dem Rest der Achsen im Layout für die Legende schaffen, und 'outside right upper' wird Platz auf der rechten Seite des Layouts schaffen. Zusätzlich zu den oben aufgeführten Werten für loc gibt es 'outside right upper', 'outside right lower', 'outside left upper' und 'outside left lower'. Weitere Details finden Sie im Legenden-Leitfaden.

bbox_to_anchorBboxBase, 2-Tupel oder 4-Tupel von Floats

Box, die zur Positionierung der Legende in Verbindung mit loc verwendet wird. Standardmäßig ist dies axes.bbox (wenn als Methode für Axes.legend aufgerufen) oder figure.bbox (wenn figure.legend). Dieses Argument ermöglicht eine beliebige Platzierung der Legende.

Bbox-Koordinaten werden im durch *bbox_transform* gegebenen Koordinatensystem interpretiert, wobei die Standardtransformation die Achsen- oder Figure-Koordinaten sind, je nachdem, welche legend aufgerufen wird.

Wenn ein 4-Tupel oder BboxBase angegeben wird, dann spezifiziert es die Bounding Box (x, y, width, height), in der die Legende platziert wird. Um die Legende an der besten Stelle im unteren rechten Quadranten der Achse (oder Abbildung) zu platzieren.

loc='best', bbox_to_anchor=(0.5, 0., 0.5, 0.5)

Ein 2-Tupel (x, y) platziert die Ecke der Legende, die durch *loc* angegeben wird, bei x, y. Zum Beispiel, um die obere rechte Ecke der Legende in der Mitte der Achse (oder Figur) zu platzieren, können die folgenden Schlüsselwörter verwendet werden:

loc='upper right', bbox_to_anchor=(0.5, 0.5)

ncolsint, default: 1

Die Anzahl der Spalten, die die Legende hat.

Zur Abwärtskompatibilität wird auch die Schreibweise *ncol* unterstützt, diese wird jedoch nicht empfohlen. Wenn beide angegeben sind, hat *ncols* Vorrang.

propNone oder FontProperties oder dict

Die Schriftarteigenschaften der Legende. Wenn None (Standard), werden die aktuellen matplotlib.rcParams verwendet.

fontsizeint oder {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}

Die Schriftgröße der Legende. Wenn der Wert numerisch ist, ist die Größe die absolute Schriftgröße in Punkten. Zeichenkettenwerte sind relativ zur aktuellen Standard-Schriftgröße. Dieses Argument wird nur verwendet, wenn *prop* nicht angegeben ist.

labelcolorstr oder Liste, default: rcParams["legend.labelcolor"] (default: 'None')

Die Farbe des Textes in der Legende. Entweder eine gültige Farbsymbolkette (z. B. 'red') oder eine Liste von Farbsymbolketten. Die *labelcolor* kann auch so eingestellt werden, dass sie mit der Farbe der Linie oder des Markers übereinstimmt, indem 'linecolor', 'markerfacecolor' (oder 'mfc') oder 'markeredgecolor' (oder 'mec') verwendet wird.

Labelcolor kann global mit rcParams["legend.labelcolor"] (default: 'None') gesetzt werden. Wenn None, wird rcParams["text.color"] (default: 'black') verwendet.

numpointsint, default: rcParams["legend.numpoints"] (default: 1)

Die Anzahl der Markerpunkte in der Legende, wenn ein Legenden-Eintrag für ein Line2D (Linie) erstellt wird.

scatterpointsint, default: rcParams["legend.scatterpoints"] (default: 1)

Die Anzahl der Markerpunkte in der Legende, wenn ein Legenden-Eintrag für eine PathCollection (Scatter-Plot) erstellt wird.

scatteryoffsetsiterierbares Objekt von Floats, Standard: [0.375, 0.5, 0.3125]

Der vertikale Versatz (relativ zur Schriftgröße) für die Marker, die für einen Legenden-Eintrag eines Streudiagramms erstellt werden. 0.0 ist an der Basis des Legendentextes, und 1.0 ist an der Oberseite. Um alle Marker auf derselben Höhe zu zeichnen, setzen Sie dies auf [0.5].

markerscalefloat, default: rcParams["legend.markerscale"] (default: 1.0)

Die relative Größe von Legenden-Markern im Vergleich zu den ursprünglich gezeichneten.

markerfirstbool, Standard: True

Wenn *True*, wird der Legenden-Marker links vom Legenden-Bezeichner platziert. Wenn *False*, wird der Legenden-Marker rechts vom Legenden-Bezeichner platziert.

reversebool, Standard: False

Wenn *True*, werden die Legenden-Bezeichner in umgekehrter Reihenfolge zur Eingabe angezeigt. Wenn *False*, werden die Legenden-Bezeichner in derselben Reihenfolge wie die Eingabe angezeigt.

Hinzugefügt in Version 3.7.

frameonbool, default: rcParams["legend.frameon"] (default: True)

Gibt an, ob die Legende auf einem Patch (Rahmen) gezeichnet werden soll.

fancyboxbool, default: rcParams["legend.fancybox"] (default: True)

Ob abgerundete Kanten um den FancyBboxPatch aktiviert werden sollen, der den Hintergrund der Legende bildet.

shadowNone, bool oder dict, default: rcParams["legend.shadow"] (default: False)

Ob ein Schatten hinter der Legende gezeichnet werden soll. Der Schatten kann mit Patch-Schlüsselwörtern konfiguriert werden. Die Konfiguration über rcParams["legend.shadow"] (default: False) wird derzeit nicht unterstützt.

framealphafloat, default: rcParams["legend.framealpha"] (default: 0.8)

Die Alpha-Transparenz des Legenden-Hintergrunds. Wenn *shadow* aktiviert ist und *framealpha* None ist, wird der Standardwert ignoriert.

facecolor"inherit" oder Farbe, default: rcParams["legend.facecolor"] (default: 'inherit')

Die Hintergrundfarbe der Legende. Wenn "inherit", wird rcParams["axes.facecolor"] (default: 'white') verwendet.

edgecolor"inherit" oder Farbe, default: rcParams["legend.edgecolor"] (default: '0.8')

Die Farbe des Hintergrundrahmens der Legende. Wenn "inherit", wird rcParams["axes.edgecolor"] (default: 'black') verwendet.

mode{"expand", None}

Wenn *mode* auf "expand" gesetzt ist, wird die Legende horizontal erweitert, um den Achsenbereich (oder *bbox_to_anchor*, falls dieser die Größe der Legende bestimmt) auszufüllen.

bbox_transformNone oder Transform

Die Transformation für die Bounding Box (*bbox_to_anchor*). Für einen Wert von None (Standard) wird die transAxes-Transformation der Achse verwendet.

titlestr oder None

Der Titel der Legende. Standard ist kein Titel (None).

title_fontpropertiesNone oder FontProperties oder dict

Die Schriftarteigenschaften des Titels der Legende. Wenn None (Standard), wird das Argument title_fontsize verwendet, falls vorhanden; wenn title_fontsize ebenfalls None ist, wird die aktuelle rcParams["legend.title_fontsize"] (default: None) verwendet.

title_fontsizeint oder {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}, default: rcParams["legend.title_fontsize"] (default: None)

Die Schriftgröße des Legendentitels. Hinweis: Dies kann nicht mit *title_fontproperties* kombiniert werden. Wenn Sie die Schriftgröße zusammen mit anderen Schrifteigenschaften festlegen möchten, verwenden Sie den Parameter *size* in *title_fontproperties*.

alignment{'center', 'left', 'right'}, Standard: 'center'

Die Ausrichtung des Legendentitels und der Box der Einträge. Die Einträge werden als einzelner Block ausgerichtet, sodass die Marker immer aufgereiht sind.

borderpadfloat, default: rcParams["legend.borderpad"] (default: 0.4)

Der Bruchteil des Leerraums innerhalb des Legendenrahmens, in Schriftgrößen-Einheiten.

labelspacingfloat, default: rcParams["legend.labelspacing"] (default: 0.5)

Der vertikale Abstand zwischen den Legenden-Einträgen, in Schriftgrößen-Einheiten.

handlelengthfloat, default: rcParams["legend.handlelength"] (default: 2.0)

Die Länge der Legenden-Handles, in Schriftgrößen-Einheiten.

handleheightfloat, default: rcParams["legend.handleheight"] (default: 0.7)

Die Höhe der Legenden-Handles, in Schriftgrößen-Einheiten.

handletextpadfloat, default: rcParams["legend.handletextpad"] (default: 0.8)

Der Abstand zwischen dem Legenden-Handle und dem Text, in Schriftgrößen-Einheiten.

borderaxespadfloat, default: rcParams["legend.borderaxespad"] (default: 0.5)

Der Abstand zwischen der Achse und dem Legenden-Rahmen, in Schriftgrößen-Einheiten.

columnspacingfloat, default: rcParams["legend.columnspacing"] (default: 2.0)

Der Abstand zwischen Spalten, in Schriftgrößen-Einheiten.

handler_mapdict oder None

Das benutzerdefinierte Wörterbuch, das Instanzen oder Typen einer Legendenbehandlung zuordnet. Diese handler_map aktualisiert die Standard-Handler-Map unter matplotlib.legend.Legend.get_legend_handler_map.

draggablebool, Standard: False

Gibt an, ob die Legende per Maus verschoben werden kann.

Siehe auch

Axes.legend

Anmerkungen

Einige Künstler werden von dieser Funktion nicht unterstützt. Einzelheiten finden Sie im Legenden-Leitfaden.

sca(a)[source]#: Setzt die aktuelle Achse auf a und gibt a zurück.

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, frameon=<UNSET>, gid=<UNSET>, in_layout=<UNSET>, label=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[source]#

Setzt mehrere Eigenschaften auf einmal.

Unterstützte Eigenschaften sind

Eigenschaft

Beschreibung

agg_filter

eine Filterfunktion, die ein (m, n, 3) Float-Array und einen dpi-Wert entgegennimmt und ein (m, n, 3) Array und zwei Offsets von der linken unteren Ecke des Bildes zurückgibt

alpha

float oder None

animated

bool

clip_box

BboxBase oder None

clip_on

bool

clip_path

Patch oder (Path, Transform) oder None

Randfarbe (edgecolor)

color

Füllfarbe (facecolor)

color

figure

unknown

frameon

bool

gid

str

in_layout

bool

label

object

Linienbreite (linewidth)

number

mouseover

bool

path_effects

liste von AbstractPathEffect

picker

None oder bool oder float oder callable

rasterized

bool

sketch_params

(scale: float, length: float, randomness: float)

snap

bool oder None

transform

Transform

url

str

visible

bool

zorder

float

set_edgecolor(color)[source]#

Legt die Kantenfarbe des Abbildungsrechtecks fest.

Parameter:

colorFarbe

set_facecolor(color)[source]#

Legt die Füllfarbe des Abbildungsrechtecks fest.

Parameter:

colorFarbe

set_figure(fig)[source]#: Veraltet seit Version 3.10: Diese Methode löst derzeit eine Ausnahme aus, wenn fig etwas anderes als die Stamm-Figure ist, auf der sich diese (Sub)Figur befindet. In Zukunft wird sie immer eine Ausnahme auslösen.

set_frameon(b)[source]#

Legt die Sichtbarkeit des Hintergrund-Patches der Figur fest, d. h. ob der Hintergrund der Figur gezeichnet wird. Entspricht Figure.patch.set_visible().

Parameter:

bbool

set_linewidth(linewidth)[source]#

Legt die Linienbreite des Abbildungsrechtecks fest.

Parameter:

linewidthnumber

subfigures(nrows=1, ncols=1, squeeze=True, wspace=None, hspace=None, width_ratios=None, height_ratios=None, **kwargs)[source]#

Fügt dieser Abbildung oder Unterabbildung einen Satz von Unterabbildungen hinzu.

Eine Subfigur hat dieselben Künstler-Methoden wie eine Figur und ist logisch gesehen identisch mit einer Figur, kann sich aber nicht selbst drucken. Siehe Figure Subfigures.

Geändert in Version 3.10: Subfiguren werden jetzt in zeilenweiser Reihenfolge hinzugefügt.

Parameter:

nrows, ncolsint, Standard: 1: Anzahl der Zeilen/Spalten des Subfigure-Gitters.
squeezebool, Standard: True: Wenn True, werden zusätzliche Dimensionen aus dem zurückgegebenen Array von Subfiguren entfernt.
wspace, hspacefloat, Standard: None: Der Platz für den Abstand zwischen den Subfiguren, ausgedrückt als Bruchteil der durchschnittlichen Subfigur-Breite/-Höhe. Wenn nicht angegeben, werden die Werte aus rcParams abgeleitet, wenn Constrained Layout verwendet wird (siehe ConstrainedLayoutEngine), oder null, wenn kein Layout-Engine verwendet wird.
width_ratiosarray-ähnlich der Länge ncols, optional: Definiert die relativen Breiten der Spalten. Jede Spalte erhält eine relative Breite von width_ratios[i] / sum(width_ratios). Wenn nicht angegeben, haben alle Spalten die gleiche Breite.
height_ratiosarray-ähnlich der Länge nrows, optional: Definiert die relativen Höhen der Zeilen. Jede Zeile erhält eine relative Höhe von height_ratios[i] / sum(height_ratios). Wenn nicht angegeben, haben alle Zeilen die gleiche Höhe.

subplot_mosaic(mosaic, *, sharex=False, sharey=False, width_ratios=None, height_ratios=None, empty_sentinel='.', subplot_kw=None, per_subplot_kw=None, gridspec_kw=None)[source]#

Erstellt ein Layout von Achsen basierend auf ASCII-Art oder verschachtelten Listen.

Dies ist eine Hilfsfunktion zum visuellen Aufbau komplexer GridSpec-Layouts.

Siehe Komplexe und semantische Abbildungskomposition (subplot_mosaic) für ein Beispiel und die vollständige API-Dokumentation.

Parameter:

mosaicListe von Listen von {hashable oder verschachtelt} oder str

Ein visuelles Layout, wie Sie Ihre Achsen beschriftet mit Zeichenketten anordnen möchten. Zum Beispiel

x = [['A panel', 'A panel', 'edge'],
     ['C panel', '.',       'edge']]

erzeugt 4 Achsen

'A panel', das 1 Zeile hoch ist und die ersten beiden Spalten überspannt
'edge', das 2 Zeilen hoch ist und sich am rechten Rand befindet
'C panel', das in der unteren linken Ecke 1 Zeile und 1 Spalte breit ist
ein leerer Platz 1 Zeile und 1 Spalte breit in der Mitte unten

Jeder der Einträge im Layout kann eine Liste von Listen der gleichen Form sein, um verschachtelte Layouts zu erstellen.

Wenn die Eingabe eine Zeichenkette ist, kann sie entweder eine mehrzeilige Zeichenkette der Form sein

'''
AAE
C.E
'''

wobei jedes Zeichen eine Spalte und jede Zeile eine Reihe ist. Oder es kann eine einzeilige Zeichenkette sein, bei der die Reihen durch ; getrennt sind.

'AB;CC'

Die Zeichenkettennotation erlaubt nur einzeichenige Achsenbeschriftungen und unterstützt keine Verschachtelung, ist aber sehr kurz.

Die Achsenidentifikatoren können str oder ein nicht iterierbares hashbares Objekt sein (z. B. tuple darf nicht verwendet werden).

sharex, shareybool, Standard: False

Wenn True, werden die x-Achse (sharex) oder y-Achse (sharey) für alle Unterdiagramme gemeinsam genutzt. In diesem Fall verhalten sich die Sichtbarkeit der Achsenbeschriftungen und die Achseneinheiten wie bei subplots. Wenn False, sind die x- oder y-Achsen jedes Unterdiagramms unabhängig.

width_ratiosarray-ähnlich der Länge ncols, optional

Definiert die relativen Breiten der Spalten. Jede Spalte erhält eine relative Breite von width_ratios[i] / sum(width_ratios). Wenn nicht angegeben, haben alle Spalten die gleiche Breite. Entspricht gridspec_kw={'width_ratios': [...]}. Im Falle von verschachtelten Layouts gilt dieses Argument nur für das äußere Layout.

height_ratiosarray-ähnlich der Länge nrows, optional

Definiert die relativen Höhen der Reihen. Jede Reihe erhält eine relative Höhe von height_ratios[i] / sum(height_ratios). Wenn nicht angegeben, haben alle Reihen die gleiche Höhe. Entspricht gridspec_kw={'height_ratios': [...]}. Im Falle von verschachtelten Layouts gilt dieses Argument nur für das äußere Layout.

subplot_kwdict, optional

Wörterbuch mit Schlüsselwörtern, die an den Figure.add_subplot-Aufruf übergeben werden, der zur Erstellung jedes Unterdiagramms verwendet wird. Diese Werte können durch Werte in per_subplot_kw überschrieben werden.

per_subplot_kwdict, optional

Ein Wörterbuch, das Achsen-Identifikatoren oder Tupel von Identifikatoren einer Wörterbuch von Schlüsselwortargumenten zuordnet, die an den Figure.add_subplot-Aufruf übergeben werden, der zur Erstellung jedes Unterdiagramms verwendet wird. Die Werte in diesen Wörterbüchern haben Vorrang vor den Werten in subplot_kw.

Wenn mosaic ein String ist und somit alle Schlüssel einzelne Zeichen sind, ist es möglich, einen einzelnen String anstelle eines Tupels als Schlüssel zu verwenden; d. h. "AB" ist äquivalent zu ("A", "B").

Hinzugefügt in Version 3.7.

gridspec_kwdict, optional

Wörterbuch mit Schlüsselwörtern, die an den Konstruktor GridSpec übergeben werden, der zum Erstellen des Rasters verwendet wird, auf dem die Unterdiagramme platziert werden. Bei verschachtelten Layouts gilt dieses Argument nur für das äußere Layout. Für komplexere Layouts sollten Benutzer Figure.subfigures verwenden, um die Verschachtelung zu erstellen.

empty_sentinelobject, optional

Eintrag im Layout, der bedeutet "diesen Platz leer lassen". Standard ist '.'. Beachten Sie, dass, wenn layout ein String ist, dieser über inspect.cleandoc verarbeitet wird, um führende Leerzeichen zu entfernen, was die Verwendung von Leerzeichen als leeren Sentinel beeinträchtigen kann.

Gibt zurück:

dict[label, Axes]: Ein Wörterbuch, das die Beschriftungen auf die Achsenobjekte abbildet. Die Reihenfolge der Achsen erfolgt von links nach rechts und von oben nach unten entsprechend ihrer Position im Gesamtlayout.

subplots(nrows=1, ncols=1, *, sharex=False, sharey=False, squeeze=True, width_ratios=None, height_ratios=None, subplot_kw=None, gridspec_kw=None)[source]#

Fügt dieser Abbildung einen Satz von Subplots hinzu.

Dieser Utility-Wrapper macht es bequem, gängige Layouts von Subplots mit einem einzigen Aufruf zu erstellen.

Parameter:

nrows, ncolsint, Standard: 1

Anzahl der Zeilen/Spalten des Subplot-Gitters.

sharex, shareybool oder {'none', 'all', 'row', 'col'}, Standard: False

Steuert die gemeinsame Nutzung der x-Achse (sharex) oder y-Achse (sharey).

True oder 'all': Die X- oder Y-Achse wird zwischen allen Subplots geteilt.
False oder 'none': Jede Subplot-X- oder Y-Achse ist unabhängig.
'row': Jede Subplot-Zeile teilt eine X- oder Y-Achse.
'col': Jede Subplot-Spalte teilt eine X- oder Y-Achse.

Wenn Subplots eine gemeinsame X-Achse entlang einer Spalte haben, werden nur die X-Achsenbeschriftungen des untersten Subplots erstellt. Ebenso werden, wenn Subplots eine gemeinsame Y-Achse entlang einer Zeile haben, nur die Y-Achsenbeschriftungen des ersten Spalten-Subplots erstellt. Um die Beschriftungen anderer Subplots später einzuschalten, verwenden Sie tick_params.

Wenn Subplots eine gemeinsame Achse mit Einheiten haben, aktualisiert der Aufruf von Axis.set_units jede Achse mit den neuen Einheiten.

Beachten Sie, dass es nicht möglich ist, Achsen zu entkoppeln.

squeezebool, Standard: True

Wenn True, werden zusätzliche Dimensionen aus dem zurückgegebenen Array von Axes entfernt.
- Wenn nur ein Subplot erstellt wird (nrows=ncols=1), wird das resultierende einzelne Axes-Objekt als Skalar zurückgegeben.
- Für Nx1- oder 1xM-Subplots ist das zurückgegebene Objekt ein 1D-NumPy-Objekt-Array von Axes-Objekten.
- Für NxM-Subplots mit N>1 und M>1 wird ein 2D-Array zurückgegeben.
Wenn False, wird überhaupt kein Quetschen durchgeführt: Das zurückgegebene Axes-Objekt ist immer ein 2D-Array, das Axes-Instanzen enthält, auch wenn es sich um ein 1x1-Array handelt.

width_ratiosarray-ähnlich der Länge ncols, optional

Definiert die relativen Breiten der Spalten. Jede Spalte erhält eine relative Breite von width_ratios[i] / sum(width_ratios). Wenn nicht angegeben, haben alle Spalten die gleiche Breite. Entspricht gridspec_kw={'width_ratios': [...]}.

height_ratiosarray-ähnlich der Länge nrows, optional

Definiert die relativen Höhen der Zeilen. Jede Zeile erhält eine relative Höhe von height_ratios[i] / sum(height_ratios). Wenn nicht angegeben, haben alle Zeilen die gleiche Höhe. Äquivalent zu gridspec_kw={'height_ratios': [...]}.

subplot_kwdict, optional

Dict mit Schlüsselwörtern, die an den Figure.add_subplot-Aufruf übergeben werden, der zur Erstellung jedes Subplots verwendet wird.

gridspec_kwdict, optional

Dict mit Schlüsselwörtern, die an den Konstruktor GridSpec übergeben werden, der zur Erstellung des Rasters verwendet wird, auf dem die Subplots platziert werden.

Gibt zurück:

Axes oder Array von Axes: Entweder ein einzelnes Axes-Objekt oder ein Array von Axes-Objekten, wenn mehr als ein Subplot erstellt wurde. Die Dimensionen des resultierenden Arrays können mit dem Schlüsselwort squeeze gesteuert werden, siehe oben.

Siehe auch

pyplot.subplots
Figure.add_subplot
pyplot.subplot

Beispiele

# First create some toy data:
x = np.linspace(0, 2*np.pi, 400)
y = np.sin(x**2)

# Create a figure
fig = plt.figure()

# Create a subplot
ax = fig.subplots()
ax.plot(x, y)
ax.set_title('Simple plot')

# Create two subplots and unpack the output array immediately
ax1, ax2 = fig.subplots(1, 2, sharey=True)
ax1.plot(x, y)
ax1.set_title('Sharing Y axis')
ax2.scatter(x, y)

# Create four polar Axes and access them through the returned array
axes = fig.subplots(2, 2, subplot_kw=dict(projection='polar'))
axes[0, 0].plot(x, y)
axes[1, 1].scatter(x, y)

# Share an X-axis with each column of subplots
fig.subplots(2, 2, sharex='col')

# Share a Y-axis with each row of subplots
fig.subplots(2, 2, sharey='row')

# Share both X- and Y-axes with all subplots
fig.subplots(2, 2, sharex='all', sharey='all')

# Note that this is the same as
fig.subplots(2, 2, sharex=True, sharey=True)

subplots_adjust(left=None, bottom=None, right=None, top=None, wspace=None, hspace=None)[source]#

Passt die Subplot-Layout-Parameter an.

Nicht gesetzte Parameter bleiben unverändert; Anfangswerte werden von rcParams["figure.subplot.[name]"] übernommen.

(Quellcode, 2x.png, png)

Parameter:

leftfloat, optional: Die Position der linken Kante der Subplots, als Bruchteil der Abbildungbreite.
rightfloat, optional: Die Position der rechten Kante der Subplots, als Bruchteil der Abbildungbreite.
bottomfloat, optional: Die Position der unteren Kante der Subplots, als Bruchteil der Abbildungshöhe.
topfloat, optional: Die Position der oberen Kante der Subplots, als Bruchteil der Abbildungshöhe.
wspacefloat, optional: Die Breite des Abstands zwischen den Subplots, als Bruchteil der durchschnittlichen Achsenbreite.
hspacefloat, optional: Die Höhe des Abstands zwischen den Subplots, als Bruchteil der durchschnittlichen Achsenhöhe.

suptitle(t, **kwargs)[source]#

Fügt der Abbildung einen zentrierten Über-Titel hinzu.

Parameter:

tstr: Der Text des übergeordneten Titels.
xfloat, Standard: 0.5: Die x-Position des Textes in Abbildungs-Koordinaten.
yfloat, Standard: 0.98: Die y-Position des Textes in Abbildungs-Koordinaten.
horizontalalignment, ha{'center', 'left', 'right'}, Standard: center: Die horizontale Ausrichtung des Textes relativ zu (x, y).
verticalalignment, va{'top', 'center', 'bottom', 'baseline'}, Standard: top: Die vertikale Ausrichtung des Textes relativ zu (x, y).
fontsize, sizeStandard: rcParams["figure.titlesize"] (Standard: 'large'): Die Schriftgröße des Textes. Siehe Text.set_size für mögliche Werte.
fontweight, weightStandard: rcParams["figure.titleweight"] (Standard: 'normal'): Die Schriftstärke des Textes. Siehe Text.set_weight für mögliche Werte.

Gibt zurück:

text: Die Text-Instanz des Über-Titels.

Andere Parameter:

fontpropertiesNone oder dict, optional: Ein Dict mit Schrift-Eigenschaften. Wenn fontproperties angegeben ist, werden die Standardwerte für Schriftgröße und -stärke aus den Standardwerten von FontProperties übernommen. rcParams["figure.titlesize"] (Standard: 'large') und rcParams["figure.titleweight"] (Standard: 'normal') werden in diesem Fall ignoriert.
**kwargs: Zusätzliche kwargs sind matplotlib.text.Text-Eigenschaften.

supxlabel(t, **kwargs)[source]#

Fügt der Abbildung eine zentrierte übergeordnete X-Achsen-Beschriftung hinzu.

Parameter:

tstr: Der übergeordnete X-Achsenbeschriftungstext.
xfloat, Standard: 0.5: Die x-Position des Textes in Abbildungs-Koordinaten.
yfloat, Standard: 0.01: Die y-Position des Textes in Abbildungs-Koordinaten.
horizontalalignment, ha{'center', 'left', 'right'}, Standard: center: Die horizontale Ausrichtung des Textes relativ zu (x, y).
vertikale Ausrichtung, va{'top', 'center', 'bottom', 'baseline'}, Standard: bottom: Die vertikale Ausrichtung des Textes relativ zu (x, y).
fontsize, sizeStandard: rcParams["figure.labelsize"] (Standard: 'large'): Die Schriftgröße des Textes. Siehe Text.set_size für mögliche Werte.
fontweight, weightStandard: rcParams["figure.labelweight"] (Standard: 'normal'): Die Schriftstärke des Textes. Siehe Text.set_weight für mögliche Werte.

Gibt zurück:

text: Die Text-Instanz der übergeordneten X-Achsenbeschriftung.

Andere Parameter:

fontpropertiesNone oder dict, optional: Ein Dict mit Schrift-Eigenschaften. Wenn fontproperties angegeben ist, werden die Standardwerte für Schriftgröße und -stärke aus den Standardwerten von FontProperties übernommen. rcParams["figure.labelsize"] (Standard: 'large') und rcParams["figure.labelweight"] (Standard: 'normal') werden in diesem Fall ignoriert.
**kwargs: Zusätzliche kwargs sind matplotlib.text.Text-Eigenschaften.

supylabel(t, **kwargs)[source]#

Fügt der Abbildung eine zentrierte übergeordnete Y-Achsen-Beschriftung hinzu.

Parameter:

tstr: Der übergeordnete Beschriftungstext der y-Achse.
xfloat, Standard: 0.02: Die x-Position des Textes in Abbildungs-Koordinaten.
yfloat, Standard: 0.5: Die y-Position des Textes in Abbildungs-Koordinaten.
horizontalalignment, ha{'center', 'left', 'right'}, Standard: left: Die horizontale Ausrichtung des Textes relativ zu (x, y).
verticalalignment, va{'top', 'center', 'bottom', 'baseline'}, Standard: center: Die vertikale Ausrichtung des Textes relativ zu (x, y).
fontsize, sizeStandard: rcParams["figure.labelsize"] (Standard: 'large'): Die Schriftgröße des Textes. Siehe Text.set_size für mögliche Werte.
fontweight, weightStandard: rcParams["figure.labelweight"] (Standard: 'normal'): Die Schriftstärke des Textes. Siehe Text.set_weight für mögliche Werte.

Gibt zurück:

text: Die Text-Instanz der übergeordneten Y-Achsenbeschriftung.

Andere Parameter:

fontpropertiesNone oder dict, optional: Ein Dict mit Schrift-Eigenschaften. Wenn fontproperties angegeben ist, werden die Standardwerte für Schriftgröße und -stärke aus den Standardwerten von FontProperties übernommen. rcParams["figure.labelsize"] (Standard: 'large') und rcParams["figure.labelweight"] (Standard: 'normal') werden in diesem Fall ignoriert.
**kwargs: Zusätzliche kwargs sind matplotlib.text.Text-Eigenschaften.

text(x, y, s, fontdict=None, **kwargs)[source]#

Fügt der Abbildung Text hinzu.

Parameter:

x, yfloat: Die Position, an der der Text platziert werden soll. Standardmäßig ist dies in Abbildungskoordinaten, Gleitkommazahlen in [0, 1]. Das Koordinatensystem kann mit dem Schlüsselwort transform geändert werden.
sstr: Der Textstring.
fontdictdict, optional: Ein Dictionary zur Überschreibung der Standard-Texteigenschaften. Wenn nicht angegeben, werden die Standardwerte von rcParams["font.*"] bestimmt. In kwargs übergebene Eigenschaften überschreiben die entsprechenden in fontdict angegebenen.

Gibt zurück:

Text

Andere Parameter:

**kwargsText-Eigenschaften

Andere verschiedene Textparameter.

Eigenschaft	Beschreibung
`agg_filter`	eine Filterfunktion, die ein (m, n, 3) Float-Array und einen dpi-Wert entgegennimmt und ein (m, n, 3) Array und zwei Offsets von der linken unteren Ecke des Bildes zurückgibt
`alpha`	float oder None
`animated`	bool
`antialiased`	bool
`backgroundcolor`	color
`bbox`	dict mit Eigenschaften für `patches.FancyBboxPatch`
`clip_box`	unknown
`clip_on`	unknown
`clip_path`	unknown
`color` oder `c`	color
`figure`	`Figure` oder `SubFigure`
`fontfamily` oder `family` oder `fontname`	{FONTNAME, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}
`fontproperties` oder `font` oder `font_properties`	`font_manager.FontProperties` oder `str` oder `pathlib.Path`
`fontsize` oder `size`	float oder {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}
`fontstretch` oder `stretch`	{ein numerischer Wert im Bereich 0-1000, 'ultra-condensed', 'extra-condensed', 'condensed', 'semi-condensed', 'normal', 'semi-expanded', 'expanded', 'extra-expanded', 'ultra-expanded'}
`fontstyle` oder `style`	{'normal', 'italic', 'oblique'}
`fontvariant` oder `variant`	{'normal', 'small-caps'}
`fontweight` oder `weight`	{ein numerischer Wert im Bereich 0-1000, 'ultralight', 'light', 'normal', 'regular', 'book', 'medium', 'roman', 'semibold', 'demibold', 'demi', 'bold', 'heavy', 'extra bold', 'black'}
`gid`	str
`horizontalalignment` oder `ha`	{'left', 'center', 'right'}
`in_layout`	bool
`label`	object
`linespacing`	float (Vielfaches der Schriftgröße)
`math_fontfamily`	str
`mouseover`	bool
`multialignment` oder `ma`	{'left', 'right', 'center'}
`parse_math`	bool
`path_effects`	liste von `AbstractPathEffect`
`picker`	None oder bool oder float oder callable
`position`	(float, float)
`rasterized`	bool
`rotation`	float oder {'vertical', 'horizontal'}
`rotation_mode`	{None, 'default', 'anchor'}
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool oder None
`text`	object
`transform`	`Transform`
`transform_rotates_text`	bool
`url`	str
`usetex`	bool, Standard: `rcParams["text.usetex"]` (Standard: `False`)
`verticalalignment` oder `va`	{'baseline', 'bottom', 'center', 'center_baseline', 'top'}
`visible`	bool
`wrap`	bool
`x`	float
`y`	float
`zorder`	float

Siehe auch

Axes.text
pyplot.text

Hilfsfunktionen#

matplotlib.figure.figaspect(arg)[source]#

Berechnet die Breite und Höhe für eine Abbildung mit einem bestimmten Seitenverhältnis.

Während die Höhe von rcParams["figure.figsize"] (Standard: [6.4, 4.8]) übernommen wird, wird die Breite angepasst, um das gewünschte Seitenverhältnis zu erfüllen. Zusätzlich wird sichergestellt, dass die Breite im Bereich [4., 16.] und die Höhe im Bereich [2., 16.] liegt. Gegebenenfalls wird die Standardhöhe angepasst, um dies zu gewährleisten.

Parameter:

argfloat oder 2D-Array: Wenn es ein Float ist, definiert es das Seitenverhältnis (d.h. das Verhältnis Höhe / Breite). Im Fall eines Arrays ist das Seitenverhältnis Anzahl der Zeilen / Anzahl der Spalten, sodass das Array unverzerrt in die Abbildung passen könnte.

Gibt zurück:

size(2,) Array: Die Breite und Höhe der Abbildung in Zoll.

Anmerkungen

Wenn Sie eine Achse innerhalb der Abbildung erstellen möchten, die das Seitenverhältnis beibehält, stellen Sie sicher, dass sie mit gleicher Breite und Höhe erstellt wird. Siehe Beispiele unten.

Vielen Dank an Fernando Perez für diese Funktion.

Beispiele

Erstellen Sie eine Abbildung, die doppelt so hoch wie breit ist

w, h = figaspect(2.)
fig = Figure(figsize=(w, h))
ax = fig.add_axes([0.1, 0.1, 0.8, 0.8])
ax.imshow(A, **kwargs)

Erstellen Sie eine Abbildung mit dem richtigen Seitenverhältnis für ein Array

A = rand(5, 3)
w, h = figaspect(A)
fig = Figure(figsize=(w, h))
ax = fig.add_axes([0.1, 0.1, 0.8, 0.8])
ax.imshow(A, **kwargs)

matplotlib.figure#

Figure#

Figure-Klasse#

Hinzufügen von Achsen und Unterfiguren#

Speichern#

Annotation#

Figuren-Geometrie#

Subplot-Layout#

Veraltet oder wurde entfernt#

Interaktivität#

Aussehen ändern#

Hinzufügen und Abrufen von Künstlern#

Zustand abrufen und ändern#

SubFigure#

SubFigure-Klasse#

Hinzufügen von Achsen und Unterfiguren#

Annotation#

Hinzufügen und Abrufen von Künstlern#

Aussehen ändern#

Weiterleitungen#

Basisklasse FigureBase#

Hilfsfunktionen#

`matplotlib.figure`#