matplotlib.pyplot.colorbar #
- matplotlib.pyplot. colorbar ( mappable = None , cax = None , ax = None , ** kwargs ) [Quelle] #
Fügen Sie einem Diagramm einen Farbbalken hinzu.
- Parameter :
- abbildbar
Die
matplotlib.cm.ScalarMappable
(dh ,AxesImage
,ContourSet
usw.) werden von diesem Farbbalken beschrieben. Dieses Argument ist obligatorisch für dieFigure.colorbar
Methode, aber optional für diepyplot.colorbar
Funktion, die den Standardwert auf das aktuelle Bild setzt.Beachten Sie, dass man
ScalarMappable
"on-the-fly" erstellen kann, um Farbbalken zu generieren, die nicht an einen zuvor gezeichneten Künstler angehängt sind, zfig.colorbar(cm.ScalarMappable(norm=norm, cmap=cmap), ax=ax)
- cax
Axes
, optional Achsen, in die der Farbbalken gezeichnet wird.
- ax
Axes
, Liste der Achsen, optional Eine oder mehrere Elternachsen, denen Platz für neue Farbbalkenachsen gestohlen wird, wenn cax None ist. Dies hat keine Auswirkungen, wenn cax gesetzt ist.
- use_gridspec bool, optional
Wenn cax gleich ist
None
, wird ein neues cax als Instanz von Axes erstellt. Wenn ax eine Instanz von Subplot ist und use_gridspecTrue
, wird caxgridspec
mithilfe des Moduls als Instanz von Subplot erstellt .
- Rückgaben :
- Farbbalken
Colorbar
- Farbbalken
- Andere Parameter :
- Ort Keine oder {'links', 'rechts', 'oben', 'unten'}
Die Position relativ zu den übergeordneten Achsen, an der die Farbbalkenachsen erstellt werden. Es bestimmt auch die Ausrichtung des Farbbalkens (Farbbalken links und rechts sind vertikal, Farbbalken oben und unten sind horizontal). Wenn None, wird die Position von der Ausrichtung kommen, wenn sie eingestellt ist (vertikale Farbbalken rechts, horizontale unten), oder standardmäßig „rechts“, wenn die Ausrichtung nicht eingestellt ist.
- Ausrichtung Keine oder {'vertikal', 'horizontal'}
Die Ausrichtung des Farbbalkens. Es ist vorzuziehen, die Position des Farbbalkens festzulegen, da dies auch die Ausrichtung bestimmt ; Das Übergeben inkompatibler Werte für Standort und Ausrichtung löst eine Ausnahme aus.
- Bruchfloat , Standard: 0,15
Bruchteil der Originalachsen, der für den Farbbalken verwendet werden soll.
- Schwimmer schrumpfen , Standard: 1,0
Bruchteil, mit dem die Größe des Farbbalkens multipliziert werden soll.
- Aspekt Float, Standard: 20
Verhältnis von langen zu kurzen Abmessungen.
- Pad Float, Standard: 0,05 wenn vertikal, 0,15 wenn horizontal
Bruchteil der Originalachsen zwischen Farbbalken und neuen Bildachsen.
- Anker (Schwimmer, Schwimmer), optional
Der Ankerpunkt der Farbbalkenachsen. Standardeinstellung (0,0, 0,5), wenn vertikal; (0,5, 1,0) wenn horizontal.
- panchor (float, float) oder False , optional
Der Ankerpunkt der übergeordneten Farbbalkenachsen. Bei False bleibt der Anker der übergeordneten Achsen unverändert. Standardeinstellung (1,0, 0,5), wenn vertikal; (0,5, 0,0) wenn horizontal.
- verlängern {'weder', 'beide', 'min', 'max'}
Machen Sie spitze(s) Ende(n) für Werte außerhalb des zulässigen Bereichs (außer „weder noch“). Diese werden für eine gegebene Colormap mit den Methoden colormap set_under und set_over gesetzt.
- extendfrac { None , 'auto', length, lengths}
Wenn „ Keine “ eingestellt ist, haben sowohl die minimale als auch die maximale dreieckige Farbbalkenerweiterung eine Länge von 5 % der inneren Farbbalkenlänge (dies ist die Standardeinstellung).
Bei Einstellung auf „Auto“ werden die dreieckigen Farbbalkenerweiterungen auf die gleiche Länge wie die Innenboxen (wenn der Abstand auf „Uniform“ eingestellt ist) oder auf die gleiche Länge wie die entsprechenden angrenzenden Innenboxen (wenn der Abstand auf „Proportional“ eingestellt ist) eingestellt.
Wenn es sich um einen Skalar handelt, gibt es die Länge sowohl der minimalen als auch der maximalen dreieckigen Farbbalkenerweiterung als Bruchteil der inneren Farbbalkenlänge an. Es kann auch eine aus zwei Elementen bestehende Folge von Brüchen angegeben werden, die die Längen der minimalen und maximalen Farbbalkenerweiterungen jeweils als Bruchteil der inneren Farbbalkenlänge angibt.
- Extender bool
Bei False sind die minimalen und maximalen Farbbalkenerweiterungen dreieckig (Standardeinstellung). Bei True sind die Erweiterungen rechteckig.
- Abstand {'einheitlich', 'proportional'}
Bei diskreten Farbbalken (
BoundaryNorm
oder Konturen) gibt 'einheitlich' jeder Farbe den gleichen Raum; 'proportional' macht den Abstand proportional zum Datenintervall.- Ticks Keine oder Liste von Ticks oder Locator
Bei None werden Ticks automatisch aus der Eingabe ermittelt.
- format None oder str oder Formatter
Wenn keine,
ScalarFormatter
wird verwendet. Formatzeichenfolgen, zB"%4.2e"
oder"{x:.2e}"
, werden unterstützt. Stattdessen kann eine AlternativeFormatter
angegeben werden.- Ziehkanten bool
Ob Linien an Farbgrenzen gezeichnet werden sollen.
- Etikettenstr _
Die Beschriftung auf der Längsachse des Farbbalkens.
- Grenzen, Werte Keine oder eine Sequenz
Wenn nicht gesetzt, wird die Farbkarte auf einer Skala von 0-1 angezeigt. Bei Sequenzen müssen die Werte eine Länge haben, die um 1 kleiner ist als die Grenzen . Für jede Region, die durch benachbarte Einträge in den Grenzen begrenzt ist, wird die Farbe verwendet, die dem entsprechenden Wert in den Werten zugeordnet ist. Normalerweise nur nützlich für indizierte Farben (dh
norm=NoNorm()
) oder andere ungewöhnliche Umstände.
Anmerkungen
Wenn mappable ein ist
ContourSet
, wird sein Erweiterungs -Kwarg automatisch eingeschlossen.Das Shrink -Kwarg bietet eine einfache Möglichkeit, den Farbbalken in Bezug auf die Achsen zu skalieren. Beachten Sie, dass, wenn cax angegeben ist, die Größe des Farbbalkens bestimmt wird und Shrink- und Aspect - Kwargs ignoriert werden.
Für eine genauere Steuerung können Sie die Positionen der Achsenobjekte, in denen das Mappable und der Farbbalken gezeichnet werden, manuell angeben. Verwenden Sie in diesem Fall keine der Achseneigenschaften kwargs.
Es ist bekannt, dass einige Vektorgrafik-Viewer (svg und pdf) weiße Lücken zwischen Segmenten des Farbbalkens rendern. Dies liegt an Fehlern in den Viewern, nicht an Matplotlib. Als Problemumgehung kann der Farbbalken mit überlappenden Segmenten gerendert werden:
cbar = colorbar() cbar.solids.set_edgecolor("face") draw()
Dies hat jedoch unter anderen Umständen negative Folgen, zB bei halbtransparenten Bildern (Alpha < 1) und Farbbalkenerweiterungen; Daher wird diese Problemumgehung standardmäßig nicht verwendet (siehe Problem Nr. 1188).