matplotlib.text#

Klassen zum Einfügen von Text in eine Abbildung.

Klasse matplotlib.text. Text ( x = 0 , y = 0 , text = '' , * , color = None , verticalalignment = 'baseline' , horizontalalignment = 'left' , multialignment = None , fontproperties = None , rotation = None , linespacing = None , rotation_mode = Keine, usetex = None , wrap = False , transform_rotates_text = False , parse_math = None , ** kwargs ) [Quelle] #

Basen:Artist

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

Erstellen Sie eine Instanz Textbei x , y mit Zeichenfolgentext .

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

Während Text das Schlüsselwortargument „label“ akzeptiert, wird es standardmäßig nicht zu den Handles einer Legende hinzugefügt.

Gültige Schlüsselwortargumente sind:

Eigentum

Beschreibung

agg_filter

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

alpha

Skalar oder Keine

animated

bool

backgroundcolor

Farbe

bbox

Diktat mit Eigenschaften fürpatches.FancyBboxPatch

clip_box

Unbekannt

clip_on

Unbekannt

clip_path

Unbekannt

coloroder c

Farbe

figure

Figure

fontfamilyoder Familie

{FONTNAME, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}

fontpropertiesoder font oder font_properties

font_manager.FontPropertiesoder stroderpathlib.Path

fontsizeoder Größe

float oder {'xx-klein', 'x-klein', 'klein', 'mittel', 'groß', 'x-groß', 'xx-groß'}

fontstretchoder dehnen

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

fontstyleoder Stil

{'normal', 'kursiv', 'schräg'}

fontvariantoder Variante

{'normal', 'Small-Caps'}

fontweightoder Gewicht

{ein numerischer Wert im Bereich 0-1000, 'ultralight', 'light', 'normal', 'regular', 'book', 'medium', 'roman', 'semibold', 'demibold', 'demi', 'fett', 'schwer', 'extra fett', 'schwarz'}

gid

Str

horizontalalignmentoder ha

{'links', 'mitte', 'rechts'}

in_layout

bool

label

Objekt

linespacing

Float (Vielfaches der Schriftgröße)

math_fontfamily

Str

mouseover

bool

multialignmentoder ma

{'links', 'rechts', 'Mitte'}

parse_math

bool

path_effects

AbstractPathEffect

picker

None oder bool oder float oder aufrufbar

position

(schweben, schweben)

rasterized

bool

rotation

float oder {'vertikal', 'horizontal'}

rotation_mode

{Keine, 'Standard', 'Anker'}

sketch_params

(Maßstab: Float, Länge: Float, Zufälligkeit: Float)

snap

bool oder Keine

text

Objekt

transform

Transform

transform_rotates_text

bool

url

Str

usetex

bool oder Keine

verticalalignmentoder va

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

visible

bool

wrap

bool

x

schweben

y

schweben

zorder

schweben

enthält ( mouseevent ) [Quelle] #

Gibt zurück, ob das Mausereignis innerhalb des an der Achse ausgerichteten Begrenzungsrahmens des Textes aufgetreten ist.

draw ( Renderer ) [Quelle] #

Zeichnen Sie den Künstler (und seine Kinder) mit dem angegebenen Renderer.

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

Parameter :
Renderer- RendererBaseUnterklasse.

Anmerkungen

Diese Methode wird in den Artist-Unterklassen überschrieben.

get_bbox_patch ( ) [Quelle] #

Geben Sie den bbox-Patch oder None zurück, wenn der patches.FancyBboxPatch nicht erstellt wurde.

get_c ( ) [Quelle] #

Pseudonym für get_color.

get_color ( ) [Quelle] #

Gibt die Farbe des Textes zurück.

get_family ( ) [Quelle] #

Pseudonym für get_fontfamily.

get_font ( ) [Quelle] #

Pseudonym für get_fontproperties.

get_font_properties ( ) [Quelle] #

Pseudonym für get_fontproperties.

get_fontfamily ( ) [Quelle] #

Gibt die Liste der Schriftfamilien zurück, die für die Schriftsuche verwendet werden.

get_fontname ( ) [Quelle] #

Gibt den Schriftartnamen als Zeichenfolge zurück.

get_fontproperties ( ) [Quelle] #

Geben Sie die zurück font_manager.FontProperties.

get_fontsize ( ) [Quelle] #

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

get_fontstyle ( ) [Quelle] #

Gibt den Schriftstil als String zurück.

get_fontvariant ( ) [Quelle] #

Gibt die Schriftartvariante als String zurück.

get_fontweight ( ) [Quelle] #

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

get_ha ( ) [Quelle] #

Pseudonym für get_horizontalalignment.

get_horizontalignment ( ) [Quelle] #

Gibt die horizontale Ausrichtung als String zurück. Wird entweder „links“, „Mitte“ oder „rechts“ sein.

get_math_fontfamily ( ) [Quelle] #

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 ( ) [Quelle] #

Pseudonym für get_fontname.

get_parse_math ( ) [Quelle] #

Gibt zurück, ob Mathtext-Parsing dafür in Betracht gezogen wird Text.

get_position ( ) [Quelle] #

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

get_prop_tup ( renderer = None ) [Quelle] #

[ Veraltet ] Gibt ein hashfähiges Tupel von Eigenschaften zurück.

Nicht für Menschenlesbarkeit gedacht, aber nützlich für Backends, die abgeleitete Informationen über Text (z. B. Layouts) zwischenspeichern möchten und wissen müssen, ob sich der Text geändert hat.

Anmerkungen

Veraltet seit Version 3.5.

get_rotation ( ) [Quelle] #

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

get_rotation_mode ( ) [Quelle] #

Gibt den Textrotationsmodus zurück.

get_size ( ) [Quelle] #

Pseudonym für get_fontsize.

get_stretch ( ) [Quelle] #

Gibt die Schriftdehnung als Zeichenfolge oder Zahl zurück.

get_style ( ) [Quelle] #

Pseudonym für get_fontstyle.

get_text ( ) [Quelle] #

Gibt die Textzeichenfolge zurück.

get_transform_rotates_text ( ) [Quelle] #

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

get_unitless_position ( ) [Quelle] #

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

get_usetex ( ) [Quelle] #

Gibt zurück, ob dieses TextObjekt TeX zum Rendern verwendet.

get_va ( ) [Quelle] #

Pseudonym für get_verticalalignment.

get_variant ( ) [Quelle] #

Pseudonym für get_fontvariant.

get_verticalalignment ( ) [Quelle] #

Gibt die vertikale Ausrichtung als String zurück. Wird entweder „top“, „center“, „bottom“, „baseline“ oder „center_baseline“ sein.

get_weight ( ) [Quelle] #

Pseudonym für get_fontweight.

get_window_extent ( renderer = None , dpi = None ) [Quelle] #

Gibt die BboxBegrenzung des Textes in Anzeigeeinheiten zurück.

Dies wird nicht nur intern verwendet, sondern ist auch nützlich, um anklickbare Bereiche in einer PNG-Datei auf einer Webseite anzugeben.

Parameter :
Renderer Renderer, optional

Zur Berechnung des Begrenzungsrahmens wird ein Renderer benötigt. Wenn der Künstler bereits gezeichnet wurde, wird der Renderer zwischengespeichert; Daher muss dieses Argument nur übergeben werden, wenn get_window_extent vor der ersten Ziehung aufgerufen wird. In der Praxis ist es meist einfacher, zuerst eine Ziehung auszulösen, zB durch Aufruf von draw_without_renderingoder plt.show().

dpi- Float, optional

Der dpi-Wert für die Berechnung der BBox ist standardmäßig self.figure.dpi( nicht der Renderer-dpi); sollte eingestellt werden, wenn zB Regionen mit einer Figur abgeglichen werden sollen, die mit einem benutzerdefinierten dpi-Wert gespeichert wurde.

get_wrap ( ) [Quelle] #

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

set ( * , agg_filter=<UNSCHARF> , alpha=<UNSCHARF> , animation=<UNSCHARF> , backgroundcolor=<UNSCHARF> , bbox=<UNSCHARF> , clip_box=<UNSCHARF> , clip_on=<UNSCHARF> , clip_path=<UNSCHARF > , 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> , linepacing=<UNSET> , math_fontfamily=<UNSET> , mouseover=<UNSET> , multialignment=<UNSET> , parse_math=<UNSET> , path_effects =<UNSET> , Auswahl =<UNSET> , position=<UNSET> , gerastert=<UNSET> , rotation=<UNSET> , rotation_mode=<UNSET> , sketch_params=<UNSET> , snap=<UNSET> , text=<UNSET> , transform=< UNSCHARF> ,transform_rotates_text=<UNSET> ,url=<UNSCHARF> , usetex=<UNSCHARF> , verticalalignment=<UNSCHARF> , visible=<UNSCHARF> , wrap=<UNSCHARF> , x=<UNSCHARF> , y=<UNSCHARF> , zorder=<UNSCHARF> ) [source ] #

Legen Sie mehrere Eigenschaften gleichzeitig fest.

Unterstützte Eigenschaften sind

Eigentum

Beschreibung

agg_filter

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

alpha

Skalar oder Keine

animated

bool

backgroundcolor

Farbe

bbox

Diktat mit Eigenschaften fürpatches.FancyBboxPatch

clip_box

Unbekannt

clip_on

Unbekannt

clip_path

Unbekannt

color

Farbe

figure

Figure

fontfamily

{FONTNAME, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}

fontproperties

font_manager.FontPropertiesoder stroderpathlib.Path

fontsize

float oder {'xx-klein', 'x-klein', 'klein', 'mittel', 'groß', 'x-groß', 'xx-groß'}

fontstretch

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

fontstyle

{'normal', 'kursiv', 'schräg'}

fontvariant

{'normal', 'Small-Caps'}

fontweight

{ein numerischer Wert im Bereich 0-1000, 'ultralight', 'light', 'normal', 'regular', 'book', 'medium', 'roman', 'semibold', 'demibold', 'demi', 'fett', 'schwer', 'extra fett', 'schwarz'}

gid

Str

horizontalalignment

{'links', 'mitte', 'rechts'}

in_layout

bool

label

Objekt

linespacing

Float (Vielfaches der Schriftgröße)

math_fontfamily

Str

mouseover

bool

multialignment

{'links', 'rechts', 'Mitte'}

parse_math

bool

path_effects

AbstractPathEffect

picker

None oder bool oder float oder aufrufbar

position

(schweben, schweben)

rasterized

bool

rotation

float oder {'vertikal', 'horizontal'}

rotation_mode

{Keine, 'Standard', 'Anker'}

sketch_params

(Maßstab: Float, Länge: Float, Zufälligkeit: Float)

snap

bool oder Keine

text

Objekt

transform

Transform

transform_rotates_text

bool

url

Str

usetex

bool oder Keine

verticalalignment

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

visible

bool

wrap

bool

x

schweben

y

schweben

zorder

schweben

set_backgroundcolor ( Farbe ) [Quelle] #

Legen Sie die Hintergrundfarbe des Textes fest, indem Sie die Bbox aktualisieren.

Parameter :
Farbe Farbe

Siehe auch

set_bbox

Zum Ändern der Position des Begrenzungsrahmens

set_bbox ( rectprops ) [Quelle] #

Zeichnen Sie einen Begrenzungsrahmen um sich selbst.

Parameter :
rectprops dict mit Eigenschaften fürpatches.FancyBboxPatch

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

Beispiele

t.set_bbox(dict(facecolor='red', alpha=0.5))
set_c ( Farbe ) [Quelle] #

Pseudonym für set_color.

set_clip_box ( clipbox ) [Quelle] #

Stellen Sie den Clip des Künstlers ein Bbox.

Parameter :
KlemmkastenBbox
set_clip_on ( b ) [Quelle] #

Legen Sie fest, ob der Künstler Clipping verwendet.

Wenn falsche Künstler außerhalb der Achsen sichtbar sind, kann dies zu unerwarteten Ergebnissen führen.

Parameter :
b bool
set_clip_path ( path , transform = None ) [Quelle] #

Legen Sie den Clip-Pfad des Künstlers fest.

Parameter :
Pfad Patchoder Pathoder TransformedPathoder Keine

Der Clip-Pfad. Wenn ein angegeben Pathwird, muss auch eine Transformation bereitgestellt werden. Wenn None , wird ein zuvor festgelegter Clip-Pfad entfernt.

transformieren Transform, optional

Wird nur verwendet, wenn path ein Pathist. In diesem Fall wird die Angabe Path in eine TransformedPathusing -Transformation konvertiert .

Anmerkungen

Aus Effizienzgründen setzt diese Methode, wenn der Pfad ein ist Rectangle, die Clipping-Box auf das entsprechende Rechteck und den Clipping-Pfad auf None.

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

set_color ( Farbe ) [Quelle] #

Legen Sie die Vordergrundfarbe des Textes fest

Parameter :
Farbe Farbe
set_family ( Schriftartname ) [Quelle] #

Pseudonym für set_fontfamily.

set_font ( fp ) [Quelle] #

Pseudonym für set_fontproperties.

set_font_properties ( fp ) [Quelle] #

Pseudonym für set_fontproperties.

set_fontfamily ( Schriftartname ) [Quelle] #

Legen Sie die Schriftfamilie fest. Kann entweder eine einzelne Zeichenfolge oder eine Liste von Zeichenfolgen mit abnehmender Priorität sein. Jede Zeichenfolge kann entweder ein echter Schriftartname oder ein generischer Schriftartklassenname sein. Im letzteren Fall werden die spezifischen Schriftartnamen in den entsprechenden rcParams nachgeschlagen.

Wenn eine TextInstanz mit konstruiert wird fontfamily=None, wird die Schriftart auf rcParams["font.family"](Standard: ['sans-serif']) gesetzt, und dasselbe geschieht, wenn set_fontfamily()auf eine vorhandene TextInstanz aufgerufen wird.

Parameter :
fontname {FONTNAME, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}
set_fontname ( Schriftartname ) [Quelle] #

Pseudonym für set_family.

Nur Einweg-Alias: Der Getter ist unterschiedlich.

Parameter :
fontname {FONTNAME, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}
set_fontproperties ( fp ) [Quelle] #

Legen Sie die Schriftarteigenschaften fest, die den Text steuern.

Parameter :
fp font_manager.FontPropertiesoder stroderpathlib.Path

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

set_fontsize ( Schriftgröße ) [Quelle] #

Legen Sie die Schriftgröße fest.

Parameter :
fontsize float oder {'xx-klein', 'x-klein', 'klein', 'mittel', 'groß', 'x-groß', 'xx-groß'}

Bei Float die Schriftgröße in Punkten. Die Zeichenfolgenwerte geben Größen relativ zur Standardschriftgröße an.

set_fontstretch ( stretch ) [Quelle] #

Stellen Sie die Schriftdehnung ein (horizontale Verdichtung oder Ausdehnung).

Parameter :
stretch {ein numerischer Wert im Bereich 0-1000, 'ultra-condensed', 'extra-condensed', 'condensed', 'semi-condensed', 'normal', 'semi-expanded', 'expanded', 'extra- erweitert', 'ultra-erweitert'}
set_fontstyle ( Schriftstil ) [Quelle] #

Legen Sie den Schriftstil fest.

Parameter :
Schriftstil {'normal', 'kursiv', 'schräg'}
set_fontvariant ( Variante ) [Quelle] #

Stellen Sie die Schriftartvariante ein.

Parameter :
Variante {'normal', 'Kapitälchen'}
set_fontweight ( Gewicht ) [Quelle] #

Legen Sie die Schriftstärke fest.

Parameter :
Gewicht {ein numerischer Wert im Bereich 0-1000, 'ultralight', 'light', 'normal', 'regular', 'book', 'medium', 'roman', 'semibold', 'demibold', 'demi' , 'fett', 'schwer', 'extra fett', 'schwarz'}
set_ha ( align ) [Quelle] #

Pseudonym für set_horizontalalignment.

set_horizontalignment ( align ) [Quelle] #

Legen Sie die horizontale Ausrichtung relativ zum Ankerpunkt fest.

Siehe auch Textausrichtung .

Parameter :
ausrichten {'links', 'zentriert', 'rechts'}
set_linespacing ( Abstand ) [Quelle] #

Legen Sie den Zeilenabstand als Vielfaches der Schriftgröße fest.

Der Standardzeilenabstand beträgt 1,2.

Parameter :
Abstand Float (Vielfaches der Schriftgröße)
set_ma ( align ) [Quelle] #

Pseudonym für set_multialignment.

set_math_fontfamily ( Schriftfamilie ) [Quelle] #

Legen Sie die Schriftfamilie für mathematischen Text fest, der von Matplotlib gerendert wird.

Dies betrifft nur den eigenen mathematischen Renderer von Matplotlib. Es hat keine Auswirkung beim Rendern mit TeX ( usetex=True).

Parameter :
Schriftfamilie str

Der Name der Schriftfamilie.

Verfügbare Schriftfamilien sind in der Datei matplotlibrc.template definiert .

Siehe auch

get_math_fontfamily
set_multialignment ( align ) [Quelle] #

Stellen Sie die Textausrichtung für mehrzeilige Texte ein.

Das Layout des Begrenzungsrahmens aller Linien wird durch die Eigenschaften horizontalalignment und verticalalignment bestimmt. Diese Eigenschaft steuert die Ausrichtung der Textzeilen innerhalb dieses Felds.

Parameter :
ausrichten {'links', 'rechts', 'zentriert'}
set_name ( fontname ) [Quelle] #

Pseudonym für set_fontname.

set_parse_math ( parse_math ) [Quelle] #

Überschreiben Sie den Schalter, um jegliches Mathtext-Parsing dafür zu deaktivieren Text.

Parameter :
parse_math bool

Bei False Textwird Mathtext niemals verwendet. Wenn True, wird mathtext verwendet, wenn es eine gerade Anzahl von Dollarzeichen ohne Escapezeichen gibt.

set_position ( xy ) [Quelle] #

Stellen Sie die ( x , y ) Position des Textes ein.

Parameter :
xy (schweben, schweben)
set_rotation ( s ) [Quelle] #

Legen Sie die Drehung des Textes fest.

Parameter :
s float oder {'vertikal', 'horizontal'}

Der Drehwinkel in Grad in mathematisch positiver Richtung (gegen den Uhrzeigersinn). „horizontal“ entspricht 0, „vertikal“ entspricht 90.

set_rotation_mode ( m ) [Quelle] #

Stellen Sie den Textrotationsmodus ein.

Parameter :
m {Keine, 'Standard', 'Anker'}

Wenn Noneoder "default", wird der Text zuerst gedreht und dann entsprechend seiner horizontalen und vertikalen Ausrichtung ausgerichtet. Wenn "anchor", erfolgt die Ausrichtung vor der Drehung.

set_size ( Schriftgröße ) [Quelle] #

Pseudonym für set_fontsize.

set_stretch ( strecken ) [Quelle] #

Pseudonym für set_fontstretch.

set_style ( Schriftstil ) [Quelle] #

Pseudonym für set_fontstyle.

set_text ( s ) [Quelle] #

Legen Sie die Textzeichenfolge s fest .

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

Parameter :
s Objekt

Jedes Objekt wird in seine strDarstellung konvertiert, außer dass Nonees in eine leere Zeichenfolge konvertiert wird.

set_transform_rotates_text ( t ) [Quelle] #

Ob Drehungen der Transformation die Textrichtung beeinflussen.

Parameter :
bool _
set_usetex ( usetex ) [Quelle] #
Parameter :
usetex bool oder None

Ob mit TeX gerendert werden soll, Nonebedeutet verwenden rcParams["text.usetex"](Standard: False).

set_va ( align ) [Quelle] #

Pseudonym für set_verticalalignment.

set_variant ( Variante ) [Quelle] #

Pseudonym für set_fontvariant.

set_verticalalignment ( align ) [Quelle] #

Legen Sie die vertikale Ausrichtung relativ zum Ankerpunkt fest.

Siehe auch Textausrichtung .

Parameter :
ausrichten {'bottom', 'baseline', 'center', 'center_baseline', 'top'}
set_weight ( Gewicht ) [Quelle] #

Pseudonym für set_fontweight.

set_wrap ( Wrap ) [Quelle] #

Legen Sie fest, ob der Text umbrochen werden kann.

Parameter :
Bool umschließen

Anmerkungen

Wrapping funktioniert nicht zusammen mit (das auch intern von in IPython/Jupyter verwendet wird). Die Einstellung „eng“ skaliert die Leinwand neu, um den gesamten Inhalt aufzunehmen, und geschieht vor dem Umbrechen.savefig(..., bbox_inches='tight')%matplotlib inline

set_x ( x ) [Quelle] #

Legen Sie die x -Position des Textes fest.

Parameter :
x schweben
set_y ( y ) [Quelle] #

Legen Sie die y -Position des Textes fest.

Parameter :
y schweben
update ( kwargs ) [Quelle] #

Aktualisieren Sie die Eigenschaften dieses Künstlers über die Dikt- Requisiten .

Parameter :
Requisiten Diktat
update_bbox_position_size ( Renderer ) [Quelle] #

Aktualisieren Sie den Ort und die Größe der Bbox.

Diese Methode sollte verwendet werden, wenn die Position und Größe der BBox aktualisiert werden muss, bevor die BBox tatsächlich gezeichnet wird.

update_from ( andere ) [Quelle] #

Eigenschaften von other nach self kopieren .

zorder = 3 #
Klasse matplotlib.text. Anmerkung ( text , xy , xytext = None , xycoords = 'data' , textcoords = None , arrowprops = None , annotation_clip = None , ** kwargs ) [source] #

Basen: Text,_AnnotationBase

An Annotationist a Text, das sich auf eine bestimmte Position xy beziehen kann . Optional kann ein Pfeil gezeichnet werden, der vom Text nach xy zeigt.

Attribute :
xy

Die kommentierte Position.

xykoord

Das Koordinatensystem für xy .

Pfeil_Patch

A FancyArrowPatch, um von xytext auf xy zu zeigen .

Beschriften Sie den Punkt xy mit Text text .

In der einfachsten Form wird der Text bei 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 die Definition von Pfeilstützen hinzugefügt werden .

Parameter :
Textstr _

Der Text der Anmerkung.

xy (schweben, schweben)

Der zu beschriftende Punkt (x, y) . Das Koordinatensystem wird durch xycoords bestimmt .

xytext (float, float), Standard: xy

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

xycoords str oder Artistoder Transformoder aufrufbares oder (float, float), Standard: 'data'

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

  • Eine der folgenden Zeichenfolgen:

    Wert

    Beschreibung

    'Figurenpunkte'

    Punkte von unten links in der Abbildung

    'Zahl Pixel'

    Pixel von der unteren linken Seite der Abbildung

    'Zahlenbruch'

    Bruchteil der Abbildung von unten links

    'Punkte subfigurieren'

    Punkte von links unten in der Teilfigur

    'subfigure pixel'

    Pixel von der unteren linken Seite der Teilfigur

    'subfigur Bruch'

    Bruchteil der Unterfigur von unten links

    'Achsenpunkte'

    Punkte von der unteren linken Ecke der Achsen

    'Achsen Pixel'

    Pixel von der unteren linken Ecke der Achsen

    'Achsenbruch'

    Bruchteil der Achsen von unten links

    'Daten'

    Koordinatensystem des beschrifteten Objekts verwenden (Standard)

    'Polar'

    (theta, r) ​​wenn nicht native 'Daten'-Koordinaten

    Beachten Sie, dass „Subfigure-Pixel“ und „Figuren-Pixel“ für die übergeordnete Figur identisch sind, sodass Benutzer, die Code wünschen, der in einer Subfigur verwendbar ist, „Subfigure-Pixel“ verwenden können.

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

  • A , um xy in Bildschirmkoordinaten Transformumzuwandeln .

  • Eine Funktion mit einer der folgenden Signaturen:

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

    wobei renderer eine RendererBaseUnterklasse ist.

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

  • Ein Tupel (xcoords, ycoords) , das separate Koordinatensysteme für x und y angibt . xcoords und ycoords müssen jeweils einem der oben beschriebenen Typen angehören.

Weitere Einzelheiten finden Sie unter Erweiterte Anmerkungen .

textcoords str or Artistor Transformor aufrufbares or (float, float), default: Wert von xycoords

Das Koordinatensystem, in dem xytext angegeben ist.

Alle xycoords- Werte sowie die folgenden Zeichenfolgen sind gültig:

Wert

Beschreibung

'Offset-Punkte'

Versatz (in Punkten) vom xy- Wert

'Pixel versetzen'

Versatz (in Pixel) vom xy- Wert

arrowprops dict, optional

Die Eigenschaften, die verwendet werden, um einen FancyArrowPatchPfeil zwischen den Positionen xy und xytext zu zeichnen . Der Standardwert ist None, dh es wird kein Pfeil gezeichnet.

Aus historischen Gründen gibt es zwei verschiedene Möglichkeiten, Pfeile zu spezifizieren, "einfach" und "ausgefallen":

Einfacher Pfeil:

Wenn arrowprops den Schlüssel 'arrowstyle' nicht enthält, sind die zulässigen Schlüssel:

Taste

Beschreibung

Breite

Die Breite des Pfeils in Punkt

Kopfbreite

Die Breite der Basis der Pfeilspitze in Punkten

Kopflänge

Die Länge der Pfeilspitze in Punkten

schrumpfen

Bruchteil der Gesamtlänge, der von beiden Enden zu schrumpfen ist

?

Jeder Schlüssel zumatplotlib.patches.FancyArrowPatch

Der Pfeil ist am Rand des Textfelds angebracht, die genaue Position (Ecken oder Mitten) hängt davon ab, wohin er zeigt.

Ausgefallener Pfeil:

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

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

Taste

Beschreibung

Pfeilstil

der Pfeilstil

Verbindungsstil

der Verbindungsstil

Relationen

siehe unten; Standard ist (0,5, 0,5)

patchA

Standard ist der Begrenzungsrahmen des Textes

patchB

Standard ist Keine

schrumpfenA

Standard ist 2 Punkte

schrumpfenB

Standard ist 2 Punkte

mutation_scale

Standard ist Textgröße (in Punkt)

mutation_aspekt

Standard ist 1.

?

jede Taste fürmatplotlib.patches.PathPatch

Die genaue Startpunktposition des Pfeils wird durch relpos definiert . Es ist ein Tupel relativer Koordinaten des Textfelds, wobei (0, 0) die untere linke Ecke und (1, 1) die obere rechte Ecke ist. Werte <0 und >1 werden unterstützt und geben Punkte außerhalb des Textfelds an. Standardmäßig (0.5, 0.5) ist der Startpunkt im Textfeld zentriert.

annotation_clip bool oder None, Standard: None

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

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

  • Bei False wird die Anmerkung immer gezeichnet.

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

**Kwarg

Zusätzliche kwargs werden an übergeben Text.

Rückgaben :
Annotation
Eigentum anncoords #

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

enthält ( Ereignis ) [Quelle] #

Gibt zurück, ob das Mausereignis innerhalb des an der Achse ausgerichteten Begrenzungsrahmens des Textes aufgetreten ist.

draw ( Renderer ) [Quelle] #

Zeichnen Sie den Künstler (und seine Kinder) mit dem angegebenen Renderer.

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

Parameter :
Renderer- RendererBaseUnterklasse.

Anmerkungen

Diese Methode wird in den Artist-Unterklassen überschrieben.

get_anncoords ( ) [Quelle] #

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

Siehe auch xycoords in Annotation.

get_tightbbox ( renderer = None ) [Quelle] #

Wie Artist.get_window_extent, enthält jedoch jegliches Ausschnitt.

Parameter :
Renderer- RendererBaseUnterklasse

Renderer, der zum Zeichnen der Figuren verwendet wird (z. B. fig.canvas.get_renderer())

Rückgaben :
Bbox

Der umschließende Begrenzungsrahmen (in der Abbildung Pixelkoordinaten).

get_window_extent ( renderer = None ) [Quelle] #

Gibt die BboxBegrenzung des Textes in Anzeigeeinheiten zurück.

Dies wird nicht nur intern verwendet, sondern ist auch nützlich, um anklickbare Bereiche in einer PNG-Datei auf einer Webseite anzugeben.

Parameter :
Renderer Renderer, optional

Zur Berechnung des Begrenzungsrahmens wird ein Renderer benötigt. Wenn der Künstler bereits gezeichnet wurde, wird der Renderer zwischengespeichert; Daher muss dieses Argument nur übergeben werden, wenn get_window_extent vor der ersten Ziehung aufgerufen wird. In der Praxis ist es meist einfacher, zuerst eine Ziehung auszulösen, zB durch Aufruf von draw_without_renderingoder plt.show().

dpi- Float, optional

Der dpi-Wert für die Berechnung der BBox ist standardmäßig self.figure.dpi( nicht der Renderer-dpi); sollte eingestellt werden, wenn zB Regionen mit einer Figur abgeglichen werden sollen, die mit einem benutzerdefinierten dpi-Wert gespeichert wurde.

set ( * , agg_filter=<UNSCHARF> , alpha=<UNSCHARF> , animation= <UNSCHARF> , anncoords=<UNSCHARF> , annotation_clip=<UNSCHARF> , backgroundcolor=<UNSCHARF> , bbox=<UNSCHARF> , clip_box=<UNSCHARF > , clip_on=<UNSET> , clip_path=<UNSET> , color=<UNSET> , fontfamily=<UNSET> , fontproperties=<UNSET> , fontsize= <UNSET> , fontstretch=<UNSET> , fontstyle=<UNSET> , Schriftvariante=<UNSCHARF> , fontweight=<UNSCHARF>, gid=<UNSET> , horizontalalignment=<UNSET> , in_layout=<UNSET> , label=<UNSET> , linepacing=<UNSET> , math_fontfamily=<UNSET> , mouseover=<UNSET> , multialignment=<UNSET> , parse_math =<UNSET> , path_effects=<UNSET> , picker= <UNSET> , position=<UNSET> , gerastert=<UNSET> , rotation=<UNSET> , rotation_mode=<UNSET> , sketch_params=<UNSET> , snap=< UNSCHARF> ,text=<UNSET> ,transform=<UNSET> , transform_rotates_text=<UNSET> , url=<UNSET> , usetex=<UNSET> , verticalalignment=<UNSET> , visible=<UNSET> , wrap=<UNSET> , x=<UNSET> , y= <UNSCHARF> , zorder=<UNSCHARF> ) [Quelle] #

Legen Sie mehrere Eigenschaften gleichzeitig fest.

Unterstützte Eigenschaften sind

Eigentum

Beschreibung

agg_filter

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

alpha

Skalar oder Keine

animated

bool

anncoords

Unbekannt

annotation_clip

bool oder Keine

backgroundcolor

Farbe

bbox

Diktat mit Eigenschaften fürpatches.FancyBboxPatch

clip_box

Bbox

clip_on

bool

clip_path

Patch oder (Pfad, Transform) oder None

coloroder c

Farbe

figure

Unbekannt

fontfamilyoder Familie

{FONTNAME, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}

fontpropertiesoder font oder font_properties

font_manager.FontPropertiesoder stroderpathlib.Path

fontsizeoder Größe

float oder {'xx-klein', 'x-klein', 'klein', 'mittel', 'groß', 'x-groß', 'xx-groß'}

fontstretchoder dehnen

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

fontstyleoder Stil

{'normal', 'kursiv', 'schräg'}

fontvariantoder Variante

{'normal', 'Small-Caps'}

fontweightoder Gewicht

{ein numerischer Wert im Bereich 0-1000, 'ultralight', 'light', 'normal', 'regular', 'book', 'medium', 'roman', 'semibold', 'demibold', 'demi', 'fett', 'schwer', 'extra fett', 'schwarz'}

gid

Str

horizontalalignmentoder ha

{'links', 'mitte', 'rechts'}

in_layout

bool

label

Objekt

linespacing

Float (Vielfaches der Schriftgröße)

math_fontfamily

Str

mouseover

bool

multialignmentoder ma

{'links', 'rechts', 'Mitte'}

parse_math

bool

path_effects

AbstractPathEffect

picker

None oder bool oder float oder aufrufbar

position

(schweben, schweben)

rasterized

bool

rotation

float oder {'vertikal', 'horizontal'}

rotation_mode

{Keine, 'Standard', 'Anker'}

sketch_params

(Maßstab: Float, Länge: Float, Zufälligkeit: Float)

snap

bool oder Keine

text

Objekt

transform

Transform

transform_rotates_text

bool

url

Str

usetex

bool oder Keine

verticalalignmentoder va

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

visible

bool

wrap

bool

x

schweben

y

schweben

zorder

schweben

set_anncoords ( coords ) [Quelle] #

Legen Sie das Koordinatensystem fest, das für verwendet werden soll Annotation.xyann.

Siehe auch xycoords in Annotation.

set_figure ( fig ) [Quelle] #

Legen Sie die FigureInstanz fest, zu der der Künstler gehört.

Parameter :
FeigeFigure
update_positions ( Renderer ) [Quelle] #

Aktualisieren Sie die Pixelpositionen des Anmerkungstexts und des Pfeilfelds.

Eigentum xyann #

Die Textposition.

Siehe auch xytext in Annotation.

Eigenschaft xycoords #
Klasse matplotlib.text. OffsetFrom ( artist , ref_coord , unit = 'points' ) [source] #

Basen:object

Aufrufbare Hilfsklasse für die Arbeit mit Annotation.

Parameter :
Künstler Artistoder BboxBaseoderTransform

Das Objekt, von dem aus der Offset berechnet werden soll.

ref_coord (float, float)

Wenn der Künstler ein Artistoder BboxBaseist, ist dieser Wert die Position bis des Versatzursprungs in Bruchteilen des Begrenzungsrahmens des Künstlers .

Wenn der Künstler eine Transformation ist, ist der Versatzursprung die Transformation, die auf diesen Wert angewendet wird.

Einheit {'Punkte, 'Pixel'}, Standard: 'Punkte'

Die zu verwendenden Bildschirmeinheiten (Pixel oder Punkte) für die Offset-Eingabe.

get_unit ( ) [Quelle] #

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

set_unit ( Einheit ) [Quelle] #

Stellen Sie die Einheit für die Eingabe auf die Transformation ein, die von verwendet wird __call__.

Parameter :
Einheit {'Punkte', 'Pixel'}