matplotlib.text

Klassen zum Einbeziehen von Text in eine Abbildung.

class matplotlib.text.Text(x=0, y=0, text='', *, color=None, verticalalignment='baseline', horizontalalignment='left', multialignment=None, fontproperties=None, rotation=None, linespacing=None, rotation_mode=None, usetex=None, wrap=False, transform_rotates_text=False, parse_math=None, antialiased=None, **kwargs)

Bases: Artist

Behandelt das Speichern und Zeichnen von Text in Fenster- oder Datenkoordinaten.

Erzeugt eine Text-Instanz bei x, y mit dem String text.

Der Text wird relativ zum Ankerpunkt (x, y) gemäß horizontalalignment (Standard: 'left') und verticalalignment (Standard: 'baseline') ausgerichtet. Siehe auch Textausrichtung.

Obwohl Text das Schlüsselwortargument 'label' akzeptiert, wird es standardmäßig nicht zu den Handles einer Legende hinzugefügt.

Gültige Schlüsselwortargumente 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
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

contains(mouseevent)

Gibt zurück, ob das Mausereignis innerhalb des achsenparallelen Begrenzungsrahmens des Textes aufgetreten ist.

draw(renderer)

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.

get_antialiased()

Gibt zurück, ob eine Kantenglättung (Antialiasing) verwendet wird.

get_bbox_patch()

Gibt das Bbox-Patch zurück oder None, wenn das patches.FancyBboxPatch nicht erstellt wurde.

get_c()

Alias für get_color.

get_color()

Gibt die Farbe des Textes zurück.

get_family()

Alias für get_fontfamily.

get_font()

Alias für get_fontproperties.

get_font_properties()

Alias für get_fontproperties.

get_fontfamily()

Gibt die Liste der Schriftfamilien zurück, die für die Schriftarten-Suche verwendet werden.

Siehe auch

font_manager.FontProperties.get_family

get_fontname()

Gibt den Schriftartnamen als String zurück.

Siehe auch

font_manager.FontProperties.get_name

get_fontproperties()

Gibt die font_manager.FontProperties zurück.

get_fontsize()

Gibt die Schriftgröße als Integer zurück.

Siehe auch

font_manager.FontProperties.get_size_in_points

get_fontstyle()

Gibt den Schriftstil als String zurück.

Siehe auch

font_manager.FontProperties.get_style

get_fontvariant()

Gibt die Schriftvarianten als String zurück.

Siehe auch

font_manager.FontProperties.get_variant

get_fontweight()

Gibt die Schriftstärke als String oder Zahl zurück.

Siehe auch

font_manager.FontProperties.get_weight

get_ha()

Alias für get_horizontalalignment.

get_horizontalalignment()

Gibt die horizontale Ausrichtung als String zurück. Wird einer von 'left', 'center' oder 'right' sein.

get_math_fontfamily()

Gibt den Namen der Schriftfamilie für mathematischen Text zurück, der von Matplotlib gerendert wird.

Der Standardwert ist rcParams["mathtext.fontset"] (Standard: 'dejavusans').

Siehe auch

set_math_fontfamily

get_name()

Alias für get_fontname.

get_parse_math()

Gibt zurück, ob das Mathtext-Parsing für dieses Text-Objekt berücksichtigt wird.

get_position()

Gibt die (x, y) Position des Textes zurück.

get_rotation()

Gibt den Textwinkel in Grad zwischen 0 und 360 zurück.

get_rotation_mode()

Gibt den Textrotationsmodus zurück.

get_size()

Alias für get_fontsize.

get_stretch()

Gibt die Schriftdehnung als String oder Zahl zurück.

Siehe auch

font_manager.FontProperties.get_stretch

get_style()

Alias für get_fontstyle.

get_text()

Gibt den Textstring zurück.

get_transform_rotates_text()

Gibt zurück, ob Rotationen der Transformation die Textrichtung beeinflussen.

get_unitless_position()

Gibt die einheitenlose (x, y) Position des Textes zurück.

get_usetex()

Gibt zurück, ob dieses Text-Objekt TeX für das Rendering verwendet.

get_va()

Alias für get_verticalalignment.

get_variant()

Alias für get_fontvariant.

get_verticalalignment()

Gibt die vertikale Ausrichtung als String zurück. Wird einer von 'top', 'center', 'bottom', 'baseline' oder 'center_baseline' sein.

get_weight()

Alias für get_fontweight.

get_window_extent(renderer=None, dpi=None)

Gibt die Bbox zurück, die den Text umschließt, in Anzeigeeinheiten.

Zusätzlich zur internen Verwendung ist dies nützlich, um klickbare Bereiche in einer PNG-Datei auf einer Webseite anzugeben.

Parameter:

rendererRenderer, optional

Ein Renderer wird benötigt, um den Begrenzungsrahmen zu berechnen. Wenn die Grafik bereits gezeichnet wurde, wird der Renderer zwischengespeichert; daher ist es nur notwendig, dieses Argument beim Aufrufen von get_window_extent vor dem ersten Zeichnen zu übergeben. In der Praxis ist es normalerweise einfacher, zuerst ein Zeichnen auszulösen, z. B. durch Aufrufen von draw_without_rendering oder plt.show().

dpifloat, optional

Der DPI-Wert für die Berechnung der Bbox, standardmäßig self.get_figure(root=True).dpi (nicht die Renderer-DPI); sollte z. B. gesetzt werden, um Bereiche mit einer Abbildung abzugleichen, die mit einer benutzerdefinierten DPI gespeichert wurde.

get_wrap()

Gibt zurück, ob der Text umgebrochen werden kann.

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, backgroundcolor=<UNSET>, bbox=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, color=<UNSET>, fontfamily=<UNSET>, fontproperties=<UNSET>, fontsize=<UNSET>, fontstretch=<UNSET>, fontstyle=<UNSET>, fontvariant=<UNSET>, fontweight=<UNSET>, gid=<UNSET>, horizontalalignment=<UNSET>, in_layout=<UNSET>, label=<UNSET>, linespacing=<UNSET>, math_fontfamily=<UNSET>, mouseover=<UNSET>, multialignment=<UNSET>, parse_math=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, position=<UNSET>, rasterized=<UNSET>, rotation=<UNSET>, rotation_mode=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, text=<UNSET>, transform=<UNSET>, transform_rotates_text=<UNSET>, url=<UNSET>, usetex=<UNSET>, verticalalignment=<UNSET>, visible=<UNSET>, wrap=<UNSET>, x=<UNSET>, y=<UNSET>, zorder=<UNSET>)

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
antialiased	bool
backgroundcolor	color
bbox	dict mit Eigenschaften für patches.FancyBboxPatch
clip_box	unknown
clip_on	unknown
clip_path	unknown
color	color
figure	Figure oder SubFigure
fontfamily oder fontname	{FONTNAME, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}
fontproperties	font_manager.FontProperties oder str oder pathlib.Path
Schriftgröße	float oder {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}
fontstretch	{ein numerischer Wert im Bereich 0-1000, 'ultra-condensed', 'extra-condensed', 'condensed', 'semi-condensed', 'normal', 'semi-expanded', 'expanded', 'extra-expanded', 'ultra-expanded'}
fontstyle	{'normal', 'italic', 'oblique'}
fontvariant	{'normal', 'small-caps'}
fontweight	{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	{'left', 'center', 'right'}
in_layout	bool
label	object
linespacing	float (Vielfaches der Schriftgröße)
math_fontfamily	str
mouseover	bool
multialignment	{'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	{'baseline', 'bottom', 'center', 'center_baseline', 'top'}
visible	bool
wrap	bool
x	float
y	float
zorder	float

set_antialiased(antialiased)

Gibt an, ob Antialiasing-Rendering verwendet werden soll.

Parameter:

antialiasedbool

Anmerkungen

Das Kantenglättungs-Rendering wird durch rcParams["text.antialiased"] (Standard: True) bestimmt und der Parameter antialiased hat keine Auswirkung, wenn der Text mathematische Ausdrücke enthält.

set_backgroundcolor(color)

Setzt die Hintergrundfarbe des Textes durch Aktualisierung der Bbox.

Parameter:

colorFarbe

Siehe auch

set_bbox

Zum Ändern der Position der Bounding Box

set_bbox(rectprops)

Zeichnet eine Bounding Box um das Objekt.

Parameter:

rectpropsDictionary mit Eigenschaften für patches.FancyBboxPatch

Der Standard-Boxstil ist 'square'. Die Mutationsskala des patches.FancyBboxPatch ist auf die Schriftgröße gesetzt.

Beispiele

t.set_bbox(dict(facecolor='red', alpha=0.5))

set_c(color)

Alias für set_color.

set_clip_box(clipbox)

Legt die Beschneidungs-Bbox des Artists fest Bbox.

Parameter:

clipboxBboxBase oder None

Wird typischerweise aus einem TransformedBbox erstellt. Zum Beispiel ist TransformedBbox(Bbox([[0, 0], [1, 1]]), ax.transAxes) das Standard-Clipping für einen Künstler, der einer Achse hinzugefügt wird.

set_clip_on(b)

Legt fest, ob der Artist Beschneiden verwendet.

Wenn False, werden Künstler außerhalb der Achsen sichtbar sein, was zu unerwarteten Ergebnissen führen kann.

Parameter:

bbool

set_clip_path(path, transform=None)

Legt den Beschneidungspfad des Artists fest.

Parameter:

pathPatch oder Path oder TransformedPath oder None

Der Clip-Pfad. Wenn ein Path angegeben wird, muss transform ebenfalls angegeben werden. Wenn None, wird ein zuvor gesetzter Clip-Pfad entfernt.

transformTransform, optional

Wird nur verwendet, wenn path ein Path ist, in diesem Fall wird der angegebene Path unter Verwendung von transform in einen TransformedPath konvertiert.

Anmerkungen

Aus Effizienzgründen wird, wenn path ein Rectangle ist, die Clipping-Box auf das entsprechende Rechteck gesetzt und der Clipping-Pfad auf None gesetzt.

Aus technischen Gründen (Unterstützung von set) wird auch ein Tupel (path, transform) als einzelner Positions-Parameter akzeptiert.

set_color(color)

Setzt die Vordergrundfarbe des Textes.

Parameter:

colorFarbe

set_family(fontname)

Alias für set_fontfamily.

set_font(fp)

Alias für set_fontproperties.

set_font_properties(fp)

Alias für set_fontproperties.

set_fontfamily(fontname)

Setzt die Schriftfamilie. Kann entweder ein einzelner String oder eine Liste von Strings in absteigender Priorität sein. Jeder String kann entweder ein realer Schriftname oder ein generischer Schriftklassename sein. Im letzteren Fall werden die spezifischen Schriftsnamen in den entsprechenden rcParams nachgeschlagen.

Wenn eine Text-Instanz mit fontfamily=None konstruiert wird, dann wird die Schrift auf rcParams["font.family"] (Standard: ['sans-serif']) gesetzt, und dasselbe geschieht, wenn set_fontfamily() auf einer existierenden Text-Instanz aufgerufen wird.

Parameter:

fontname{SCHRIFTARTNAME, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}

Siehe auch

font_manager.FontProperties.set_family

set_fontname(fontname)

Alias für set_fontfamily.

Nur Einweg-Alias: der Getter unterscheidet sich.

Parameter:

fontname{SCHRIFTARTNAME, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}

Siehe auch

font_manager.FontProperties.set_family

set_fontproperties(fp)

Setzt die Schrift-Eigenschaften, die den Text steuern.

Parameter:

fpfont_manager.FontProperties oder str oder pathlib.Path

Wenn ein str, wird er als Fontconfig-Muster interpretiert, das von FontProperties geparst wird. Wenn ein pathlib.Path, wird er als absoluter Pfad zu einer Schriftdatei interpretiert.

set_fontsize(fontsize)

Setzt die Schriftgröße.

Parameter:

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

Wenn float, ist die Schriftgröße in Punkten. Die String-Werte bezeichnen Größen relativ zur Standard-Schriftgröße.

Siehe auch

font_manager.FontProperties.set_size

set_fontstretch(stretch)

Setzt die Schriftdehnung (horizontale Kompression oder Expansion).

Parameter:

stretch{ein numerischer Wert im Bereich 0-1000, 'ultra-condensed', 'extra-condensed', 'condensed', 'semi-condensed', 'normal', 'semi-expanded', 'expanded', 'extra-expanded', 'ultra-expanded'}

Siehe auch

font_manager.FontProperties.set_stretch

set_fontstyle(fontstyle)

Setzt den Schriftschnitt.

Parameter:

fontstyle{'normal', 'italic', 'oblique'}

Siehe auch

font_manager.FontProperties.set_style

set_fontvariant(variant)

Setzt die Schriftvariante.

Parameter:

variant{'normal', 'small-caps'}

Siehe auch

font_manager.FontProperties.set_variant

set_fontweight(weight)

Setzt die Schriftstärke.

Parameter:

weight{ein numerischer Wert im Bereich 0-1000, 'ultralight', 'light', 'normal', 'regular', 'book', 'medium', 'roman', 'semibold', 'demibold', 'demi', 'bold', 'heavy', 'extra bold', 'black'}

Siehe auch

font_manager.FontProperties.set_weight

set_ha(align)

Alias für set_horizontalalignment.

set_horizontalalignment(align)

Setzt die horizontale Ausrichtung relativ zum Ankerpunkt.

Siehe auch Textausrichtung.

Parameter:

align{'left', 'center', 'right'}

set_linespacing(spacing)

Setzt den Zeilenabstand als Vielfaches der Schriftgröße.

Der Standard-Zeilenabstand ist 1,2.

Parameter:

spacingfloat (Vielfaches der Schriftgröße)

set_ma(align)

Alias für set_multialignment.

set_math_fontfamily(fontfamily)

Setzt die Schriftfamilie für mathematischen Text, der von Matplotlib gerendert wird.

Dies wirkt sich nur auf Matplotlibs eigenen mathematischen Renderer aus. Es hat keine Auswirkung, wenn mit TeX gerendert wird (usetex=True).

Parameter:

fontfamilystr

Der Name der Schriftfamilie.

Verfügbare Schriftfamilien sind in der Standard-matplotlibrc-Datei definiert.

Siehe auch

get_math_fontfamily

set_multialignment(align)

Setzt die Textausrichtung für mehrzeilige Texte.

Das Layout der Bounding Box aller Zeilen wird durch die horizontalen und vertikalen Ausrichtungseigenschaften bestimmt. Diese Eigenschaft steuert die Ausrichtung der Textzeilen innerhalb dieser Box.

Parameter:

align{'left', 'right', 'center'}

set_name(fontname)

Alias für set_fontname.

set_parse_math(parse_math)

Überschreibt den Schalter, um die Mathtext-Analyse für diesen Text zu deaktivieren.

Parameter:

parse_mathbool

Wenn False, wird dieser Text niemals Mathtext verwenden. Wenn True, wird Mathtext verwendet, wenn eine gerade Anzahl von nicht-escapeten Dollarzeichen vorhanden ist.

set_position(xy)

Setzt die (x, y)-Position des Textes.

Parameter:

xy(float, float)

set_rotation(s)

Setzt die Drehung des Textes.

Parameter:

sfloat oder {'vertical', 'horizontal'}

Der Drehwinkel in Grad in mathematisch positiver Richtung (gegen den Uhrzeigersinn). 'horizontal' entspricht 0, 'vertical' entspricht 90.

set_rotation_mode(m)

Setzt den Text-Drehmodus.

Parameter:

m{None, 'default', 'anchor'}

Wenn "default", wird der Text zuerst gedreht und dann entsprechend seiner horizontalen und vertikalen Ausrichtung ausgerichtet. Wenn "anchor", erfolgt die Ausrichtung vor der Drehung. Wenn None übergeben wird, wird der Drehmodus auf "default" gesetzt.

set_size(fontsize)

Alias für set_fontsize.

set_stretch(stretch)

Alias für set_fontstretch.

set_style(fontstyle)

Alias für set_fontstyle.

set_text(s)

Setzt den Text-String s.

Er kann Zeilenumbrüche (\n) oder Mathematik in LaTeX-Syntax enthalten.

Parameter:

sObjekt

Jedes Objekt wird in seine str-Repräsentation konvertiert, außer None, das in einen leeren String konvertiert wird.

set_transform_rotates_text(t)

Ob Rotationen der Transformation die Textrichtung beeinflussen.

Parameter:

tbool

set_usetex(usetex)

Parameter:

usetexbool oder None

Ob mit TeX gerendert werden soll, None bedeutet die Verwendung von rcParams["text.usetex"] (Standard: False).

set_va(align)

Alias für set_verticalalignment.

set_variant(variant)

Alias für set_fontvariant.

set_verticalalignment(align)

Setzt die vertikale Ausrichtung relativ zum Ankerpunkt.

Siehe auch Textausrichtung.

Parameter:

align{'baseline', 'bottom', 'center', 'center_baseline', 'top'}

set_weight(weight)

Alias für set_fontweight.

set_wrap(wrap)

Legt fest, ob der Text umgebrochen werden kann.

Das Umbrechen stellt sicher, dass der Text auf die (Sub-)Figure-Box beschränkt ist. Andere Künstler werden dabei nicht berücksichtigt.

Parameter:

wrapbool

Anmerkungen

Das Umbrechen funktioniert nicht zusammen mit savefig(..., bbox_inches='tight') (was auch intern von %matplotlib inline in IPython/Jupyter verwendet wird). Die Einstellung 'tight' skaliert die Zeichenfläche neu, um allen Inhalt aufzunehmen, und geschieht vor dem Umbrechen.

set_x(x)

Setzt die x-Position des Textes.

Parameter:

xfloat

set_y(y)

Setzt die y-Position des Textes.

Parameter:

yfloat

update(kwargs)

Aktualisiert die Eigenschaften dieses Artists aus dem Wörterbuch props.

Parameter:

propsdict

update_bbox_position_size(renderer)

Aktualisiert die Position und Größe der Bbox.

Diese Methode sollte verwendet werden, wenn die Position und Größe der Bbox aktualisiert werden müssen, bevor die Bbox tatsächlich gezeichnet wird.

update_from(other)

Kopiert Eigenschaften von other nach self.

zorder = 3

class matplotlib.text.Annotation(text, xy, xytext=None, xycoords='data', textcoords=None, arrowprops=None, annotation_clip=None, **kwargs)

Basiert auf: Text, _AnnotationBase

Eine Annotation ist ein Text, der auf eine bestimmte Position xy verweisen kann. Optional kann ein Pfeil gezeichnet werden, der vom Text auf xy zeigt.

Attribute:

xy

Die annotierte Position.

xycoords

Das Koordinatensystem für xy.

arrow_patch

Ein FancyArrowPatch, der von xytext nach xy zeigt.

Annotiert den Punkt xy mit dem Text text.

In der einfachsten Form wird der Text an xy platziert.

Optional kann der Text an einer anderen Position xytext angezeigt werden. Ein Pfeil, der vom Text zum annotierten Punkt xy zeigt, kann dann durch Definition von arrowprops hinzugefügt werden.

Parameter:

textstr

Der Text der Anmerkung.

xy(float, float)

Der Punkt (x, y), der annotiert werden soll. Das Koordinatensystem wird durch xycoords bestimmt.

xytext(float, float), default: xy

Die Position (x, y), an der der Text platziert werden soll. Das Koordinatensystem wird durch textcoords bestimmt.

xycoordsEinzelnes oder Tupel aus zwei Strings oder Artist oder Transform oder aufrufbar, Standard: 'data'

Das Koordinatensystem, in dem xy angegeben ist. Folgende Arten von Werten werden unterstützt

• Einer der folgenden Strings

  Wert	Beschreibung
  'figure points'	Punkte vom linken unteren Rand der Abbildung
  'figure pixels'	Pixel vom linken unteren Rand der Abbildung
  'figure fraction'	Anteil der Abbildung vom linken unteren Rand
  'subfigure points'	Punkte vom linken unteren Rand der Teilabbildung
  'subfigure pixels'	Pixel vom linken unteren Rand der Teilabbildung
  'subfigure fraction'	Anteil der Teilabbildung vom linken unteren Rand
  'axes points'	Punkte vom linken unteren Rand der Achsen
  'axes pixels'	Pixel vom linken unteren Rand der Achsen
  'axes fraction'	Anteil der Achsen vom linken unteren Rand
  'data'	Verwendet das Koordinatensystem des zu annotierenden Objekts (Standard)
  'polar'	(theta, r), wenn nicht native 'data'-Koordinaten

  Beachten Sie, dass 'subfigure pixels' und 'figure pixels' für die übergeordnete Abbildung identisch sind. Benutzer, die Code wünschen, der in einer Teilabbildung verwendbar ist, können daher 'subfigure pixels' verwenden.

• Ein Artist: xy wird als Bruchteil der Bbox des Künstlers interpretiert. Z. B. wäre (0, 0) die untere linke Ecke der Begrenzungsbox und (0,5, 1) wäre die obere Mitte der Begrenzungsbox.

• Eine Transform, um xy in Bildschirmkoordinaten zu transformieren.

• Eine Funktion mit einer der folgenden Signaturen

  def transform(renderer) -> Bbox
  def transform(renderer) -> Transform
  

  wobei renderer eine Unterklasse von RendererBase ist.

  Das Ergebnis der Funktion wird wie die Fälle Artist und Transform oben interpretiert.

• Ein Tupel (xcoords, ycoords), das getrennte Koordinatensysteme für x und y spezifiziert. xcoords und ycoords müssen jeweils von einem der oben beschriebenen Typen sein.

Weitere Informationen finden Sie unter Erweiterte Anmerkungen.

textcoordsEinzelnes oder Tupel aus zwei Strings oder Artist oder Transform oder aufrufbar, Standard: Wert von xycoords

Das Koordinatensystem, in dem xytext angegeben ist.

Alle xycoords-Werte sind gültig, ebenso wie die folgenden Strings

Wert	Beschreibung
'offset points'	Offset, in Punkten, vom xy-Wert
'offset pixels'	Offset, in Pixeln, vom xy-Wert
'offset fontsize'	Offset, relativ zur Schriftgröße, vom xy-Wert

arrowpropsdict, optional

Die Eigenschaften, die zum Zeichnen eines FancyArrowPatch Pfeils zwischen den Positionen xy und xytext verwendet werden. Standardmäßig None, d.h. es wird kein Pfeil gezeichnet.

Aus historischen Gründen gibt es zwei verschiedene Möglichkeiten, Pfeile anzugeben: "einfach" und "fancy"

Einfacher Pfeil

Wenn arrowprops nicht den Schlüssel 'arrowstyle' enthält, sind die erlaubten Schlüssel

Schlüssel	Beschreibung
width	Die Breite des Pfeils in Punkten
headwidth	Die Breite der Basis der Pfeilspitze in Punkten
headlength	Die Länge der Pfeilspitze in Punkten
shrink	Anteil der Gesamtlänge, der von beiden Enden geschrumpft wird
?	Jede Eigenschaft von FancyArrowPatch

Der Pfeil wird am Rand der Textbox befestigt, die genaue Position (Ecken oder Mittelpunkte) hängt davon ab, wohin er zeigt.

Fancy-Pfeil

Dies wird verwendet, wenn 'arrowstyle' in arrowprops angegeben ist.

Gültige Schlüssel sind die folgenden Parameter von FancyArrowPatch

Schlüssel	Beschreibung
arrowstyle	Der Pfeilstil
connectionstyle	Der Verbindungsstil
relpos	Siehe unten; Standard ist (0.5, 0.5)
patchA	Standard ist die Bounding Box des Textes
patchB	Standard ist None
shrinkA	In Punkten. Standard sind 2 Punkte
shrinkB	In Punkten. Standard sind 2 Punkte
mutation_scale	Standard ist Textgröße (in Punkten)
mutation_aspect	Standard ist 1
?	Jede Eigenschaft von FancyArrowPatch

Die exakte Startposition des Pfeils wird durch relpos definiert. Es ist ein Tupel relativer Koordinaten der Textbox, wobei (0, 0) die linke untere Ecke und (1, 1) die obere rechte Ecke ist. Werte <0 und >1 werden unterstützt und spezifizieren Punkte außerhalb der Textbox. Standardmäßig (0.5, 0.5), also ist der Startpunkt in der Mitte der Textbox.

annotation_clipbool or None, default: None

Ob die Anmerkung abgeschnitten werden soll (d.h. nicht gezeichnet werden soll), wenn der Anmerkungspunkt xy außerhalb des Achsenbereichs liegt.

• Wenn True, wird die Anmerkung abgeschnitten, wenn xy außerhalb der Achsen liegt.

• Wenn False, wird die Anmerkung immer gezeichnet.

• Wenn None, wird die Anmerkung abgeschnitten, wenn xy außerhalb der Achsen liegt und xycoords 'data' ist.

**kwargs

Zusätzliche kwargs werden an Text weitergegeben.

Gibt zurück:

Annotation

Siehe auch

Annotationen

property anncoords

Das Koordinatensystem, das für Annotation.xyann verwendet werden soll.

contains(mouseevent)

Gibt zurück, ob das Mausereignis innerhalb des achsenparallelen Begrenzungsrahmens des Textes aufgetreten ist.

draw(renderer)

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.

get_anncoords()

Gibt das Koordinatensystem zurück, das für Annotation.xyann verwendet werden soll.

Siehe auch xycoords in Annotation.

get_tightbbox(renderer=None)

Ähnlich wie Artist.get_window_extent, aber inklusive jeglichen Beschneidens.

Parameter:

rendererRendererBase subclass, optional

Renderer, der zum Zeichnen der Figuren verwendet wird (d. h. fig.canvas.get_renderer())

Gibt zurück:

Bbox oder None

Die umschließende Bounding Box (in Figure-Pixelkoordinaten). Gibt None zurück, wenn durch Clipping keine Schnittmenge entsteht.

get_window_extent(renderer=None)

Gibt die Bbox zurück, die den Text umschließt, in Anzeigeeinheiten.

Zusätzlich zur internen Verwendung ist dies nützlich, um klickbare Bereiche in einer PNG-Datei auf einer Webseite anzugeben.

Parameter:

rendererRenderer, optional

Ein Renderer wird benötigt, um die Begrenzungsbox zu berechnen. Wenn der Künstler bereits gezeichnet wurde, wird der Renderer zwischengespeichert; daher ist es nur notwendig, dieses Argument zu übergeben, wenn get_window_extent vor dem ersten Zeichnen aufgerufen wird. In der Praxis ist es normalerweise einfacher, zuerst ein Zeichnen auszulösen, z. B. durch Aufrufen von draw_without_rendering oder plt.show().

dpifloat, optional

Der DPI-Wert für die Berechnung der Bbox, standardmäßig self.get_figure(root=True).dpi (nicht die Renderer-DPI); sollte z. B. gesetzt werden, um Bereiche mit einer Abbildung abzugleichen, die mit einer benutzerdefinierten DPI gespeichert wurde.

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, anncoords=<UNSET>, annotation_clip=<UNSET>, antialiased=<UNSET>, backgroundcolor=<UNSET>, bbox=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, color=<UNSET>, fontfamily=<UNSET>, fontproperties=<UNSET>, fontsize=<UNSET>, fontstretch=<UNSET>, fontstyle=<UNSET>, fontvariant=<UNSET>, fontweight=<UNSET>, gid=<UNSET>, horizontalalignment=<UNSET>, in_layout=<UNSET>, label=<UNSET>, linespacing=<UNSET>, math_fontfamily=<UNSET>, mouseover=<UNSET>, multialignment=<UNSET>, parse_math=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, position=<UNSET>, rasterized=<UNSET>, rotation=<UNSET>, rotation_mode=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, text=<UNSET>, transform=<UNSET>, transform_rotates_text=<UNSET>, url=<UNSET>, usetex=<UNSET>, verticalalignment=<UNSET>, visible=<UNSET>, wrap=<UNSET>, x=<UNSET>, y=<UNSET>, zorder=<UNSET>)

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
anncoords	unknown
annotation_clip	bool oder None
antialiased	bool
backgroundcolor	color
bbox	dict mit Eigenschaften für patches.FancyBboxPatch
clip_box	BboxBase oder None
clip_on	bool
clip_path	Patch oder (Path, Transform) oder None
color oder c	color
figure	unknown
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

set_anncoords(coords)

Setzt das Koordinatensystem, das für Annotation.xyann verwendet werden soll.

Siehe auch xycoords in Annotation.

set_figure(fig)

Legt die Figure- oder SubFigure-Instanz fest, zu der der Artist gehört.

Parameter:

figFigure oder SubFigure

update_positions(renderer)

Aktualisiert die Pixelpositionen des Anmerkungstextes und des Pfeil-Patches.

property xyann

Die Textposition.

Siehe auch xytext in Annotation.

property xycoords

class matplotlib.text.OffsetFrom(artist, ref_coord, unit='points')

Bases: object

Aufrufbare Hilfsklasse für die Arbeit mit Annotation.

Parameter:

artistArtist oder BboxBase oder Transform

Das Objekt, von dem der Offset berechnet werden soll.

ref_coord(float, float)

Wenn artist ein Artist oder BboxBase ist, sind diese Werte die Position des Ursprungs des Offsets in Bruchteilen der Begrenzungsbox des artists.

Wenn artist eine Transformation ist, ist der Ursprung des Offsets die auf diesen Wert angewendete Transformation.

unit{'points, 'pixels'}, Standard: 'points'

Die zu verwendenden Bildschirm-Einheiten (Pixel oder Punkte) für die Eingabe des Offsets.

get_unit()

Gibt die Einheit für die Eingabe der Transformation zurück, die von __call__ verwendet wird.

set_unit(unit)

Setzt die Einheit für die Eingabe der Transformation, die von __call__ verwendet wird.

Parameter:

unit{'points', 'pixels'}

class matplotlib.text.TextPath(xy, s, size=None, prop=None, _interpolation_steps=1, usetex=False)

Bases: Path

Erstellt einen Pfad aus dem Text.

Erstellt einen Pfad aus dem Text. Beachten Sie, dass es sich nur um einen Pfad handelt, nicht um einen Künstler. Sie müssen PathPatch (oder andere Künstler) verwenden, um diesen Pfad auf die Leinwand zu zeichnen.

Parameter:

xyTupel oder Array aus zwei Fließkommawerten

Position des Textes. Für keine Verschiebung verwenden Sie xy=(0, 0).

sstr

Der in einen Pfad zu konvertierende Text.

sizefloat, optional

Schriftgröße in Punkten. Standardmäßig wird die über die Schriftartparameter prop angegebene Größe verwendet.

propFontProperties, optional

Schriftarteigenschaft. Wenn nicht angegeben, wird eine Standard- FontProperties mit Parametern aus den rcParams verwendet.

_interpolation_stepsint, optional

(Derzeit ignoriert)

usetexbool, Standard: False

Ob Tex-Rendering verwendet werden soll.

Beispiele

Das Folgende erstellt einen Pfad aus der Zeichenkette "ABC" mit der Schriftart Helvetica; und einen weiteren Pfad aus dem Latex-Bruch 1/2

from matplotlib.text import TextPath
from matplotlib.font_manager import FontProperties

fp = FontProperties(family="Helvetica", style="italic")
path1 = TextPath((12, 12), "ABC", size=12, prop=fp)
path2 = TextPath((0, 0), r"$\frac{1}{2}$", size=12, usetex=True)

Siehe auch Verwendung eines Textes als Pfad.

property codes

Gibt die Codes zurück

get_size()

Holt die Textgröße.

set_size(size)

Setzt die Textgröße.

property vertices

Gibt den zwischengespeicherten Pfad nach der notwendigen Aktualisierung zurück.

class matplotlib.text.TextToPath

Bases: object

Eine Klasse, die Zeichenketten in Pfade konvertiert.

DPI = 72

FONT_SCALE = 100.0

get_glyphs_mathtext(prop, s, glyph_map=None, return_new_glyphs_only=False)

Parsen Sie die Mathtext-Zeichenkette s und konvertieren Sie sie in ein Paar (vertices, codes).

get_glyphs_tex(prop, s, glyph_map=None, return_new_glyphs_only=False)

Konvertiert die Zeichenkette s mit usetex-Modus in Vertices und Codes.

get_glyphs_with_font(font, s, glyph_map=None, return_new_glyphs_only=False)

Konvertiert die Zeichenkette s mit der bereitgestellten TTF-Schriftart in Vertices und Codes.

get_text_path(prop, s, ismath=False)

Konvertiert Text s in einen Pfad (ein Tupel aus Vertices und Codes für matplotlib.path.Path).

Parameter:

propFontProperties

Die Schrifteigenschaften für den Text.

sstr

Der zu konvertierende Text.

ismath{False, True, "TeX"}

Wenn True, wird der Mathtext-Parser verwendet. Wenn "TeX", wird Tex für das Rendering verwendet.

Gibt zurück:

vertslist

Eine Liste von Arrays, die die (x, y)-Koordinaten der Eckpunkte enthalten.

codeslist

Eine Liste von Pfadcodes.

Beispiele

Erstellt eine Liste von Eckpunkten und Codes aus einem Text und erstellt daraus einen Path

from matplotlib.path import Path
from matplotlib.text import TextToPath
from matplotlib.font_manager import FontProperties

fp = FontProperties(family="Comic Neue", style="italic")
verts, codes = TextToPath().get_text_path(fp, "ABC")
path = Path(verts, codes, closed=False)

Siehe auch TextPath für eine direktere Methode, einen Pfad aus einem Text zu erstellen.

get_text_width_height_descent(s, prop, ismath)