matplotlib.offsetbox#
Container-Klassen für Artists.
OffsetBoxDie Basis aller in diesem Modul definierten Container-Künstler.
AnchoredOffsetbox,AnchoredTextVerankert und richtet einen beliebigen
Artistoder Text relativ zu den übergeordneten Achsen oder einem bestimmten Ankerpunkt aus.DrawingAreaEin Container mit fester Breite und Höhe. Kinder haben eine feste Position innerhalb des Containers und können beschnitten werden.
HPacker,VPackerContainer zum vertikalen oder horizontalen Anordnen ihrer Kinder.
PaddedBoxEin Container, um einen
Artistmit einem Innenabstand zu versehen.TextAreaEnthält eine einzelne
Text-Instanz.
- class matplotlib.offsetbox.AnchoredOffsetbox(loc, *, pad=0.4, borderpad=0.5, child=None, prop=None, frameon=True, bbox_to_anchor=None, bbox_transform=None, **kwargs)[source]#
Bases:
OffsetBoxEine Offset-Box, die gemäß der Position loc platziert wird.
AnchoredOffsetbox hat ein einzelnes Kind. Wenn mehrere Kinder benötigt werden, verwenden Sie eine zusätzliche OffsetBox, um sie einzuschließen. Standardmäßig wird die Offset-Box an ihren übergeordneten Achsen verankert. Sie können bbox_to_anchor explizit angeben.
- Parameter:
- locstr
Die Position der Box. Gültige Positionen sind 'upper left', 'upper center', 'upper right', 'center left', 'center', 'center right', 'lower left', 'lower center', 'lower right'. Aus Kompatibilitätsgründen werden auch numerische Werte akzeptiert. Details finden Sie im Parameter loc von
Legend.- padfloat, default: 0.4
Innenabstand um das Kind als Bruchteil der Schriftgröße.
- borderpadfloat, default: 0.5
Innenabstand zwischen dem Rahmen der Offset-Box und dem bbox_to_anchor.
- child
OffsetBox Die Box, die verankert wird.
- prop
FontProperties Dies wird nur als Referenz für Innenabstände verwendet. Wenn nicht angegeben, wird
rcParams["legend.fontsize"](Standard:'medium') verwendet.- frameonbool
Ob ein Rahmen um die Box gezeichnet werden soll.
- bbox_to_anchor
BboxBase, 2-Tupel oder 4-Tupel von Floats Box, die zur Positionierung der Legende in Verbindung mit loc verwendet wird.
- bbox_transformNone oder
matplotlib.transforms.Transform Die Transformation für die Bounding Box (bbox_to_anchor).
- **kwargs
Alle anderen Parameter werden an
OffsetBoxweitergegeben.
Anmerkungen
Siehe
Legendfür eine detaillierte Beschreibung des Verankerungsmechanismus.- codes = {'center': 10, 'center left': 6, 'center right': 7, 'lower center': 8, 'lower left': 3, 'lower right': 4, 'right': 5, 'upper center': 9, 'upper left': 2, 'upper right': 1}#
- draw(renderer)[source]#
Aktualisiert die Position der Kinder, falls erforderlich, und zeichnet sie auf den gegebenen renderer.
- get_bbox(renderer)[source]#
Gibt die Bounding Box der Offset-Box zurück, wobei übergeordnete Offsets ignoriert werden.
- get_offset(bbox, renderer)[source]#
Gibt den Offset als Tupel (x, y) zurück.
Die Extent-Parameter müssen bereitgestellt werden, um den Fall zu behandeln, dass der Offset dynamisch durch eine aufrufbare Funktion bestimmt wird (siehe
set_offset).- Parameter:
- bbox
Bbox - renderer
RendererBasesubclass
- bbox
- set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, bbox_to_anchor=<UNSET>, child=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, gid=<UNSET>, height=<UNSET>, in_layout=<UNSET>, label=<UNSET>, mouseover=<UNSET>, offset=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, width=<UNSET>, zorder=<UNSET>)[source]#
Setzt mehrere Eigenschaften auf einmal.
Unterstützte Eigenschaften sind
Eigenschaft
Beschreibung
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
float oder None
bool
unknown
unknown
BboxBaseoder Nonebool
Patch oder (Path, Transform) oder None
str
float
bool
object
bool
(float, float) oder aufrufbar
liste von
AbstractPathEffectNone oder bool oder float oder callable
bool
(scale: float, length: float, randomness: float)
bool oder None
str
bool
float
float
- set_bbox_to_anchor(bbox, transform=None)[source]#
Setzt die Bounding Box, an die die Box verankert ist.
bbox kann eine Bbox-Instanz, eine Liste von [left, bottom, width, height] oder eine Liste von [left, bottom] sein, bei der Breite und Höhe als Null angenommen werden. Die Bbox wird mit der gegebenen Transformation in die Anzeige-Koordinate transformiert.
- zorder = 5#
- class matplotlib.offsetbox.AnchoredText(s, loc, *, pad=0.4, borderpad=0.5, prop=None, **kwargs)[source]#
Bases:
AnchoredOffsetboxAnchoredOffsetbox mit Text.
- Parameter:
- sstr
Text.
- locstr
Positions-Code. Siehe
AnchoredOffsetbox.- padfloat, default: 0.4
Innenabstand um den Text als Bruchteil der Schriftgröße.
- borderpadfloat, default: 0.5
Abstand zwischen dem Rahmen der Offset-Box und dem bbox_to_anchor.
- propdict, optional
Wörterbuch von Schlüsselwortargumenten, die an die
Text-Instanz übergeben werden, die in AnchoredText enthalten ist.- **kwargs
Alle anderen Parameter werden an
AnchoredOffsetboxweitergegeben.
- set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, bbox_to_anchor=<UNSET>, child=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, gid=<UNSET>, height=<UNSET>, in_layout=<UNSET>, label=<UNSET>, mouseover=<UNSET>, offset=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, width=<UNSET>, zorder=<UNSET>)[source]#
Setzt mehrere Eigenschaften auf einmal.
Unterstützte Eigenschaften sind
Eigenschaft
Beschreibung
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
float oder None
bool
unknown
unknown
BboxBaseoder Nonebool
Patch oder (Path, Transform) oder None
str
float
bool
object
bool
(float, float) oder aufrufbar
liste von
AbstractPathEffectNone oder bool oder float oder callable
bool
(scale: float, length: float, randomness: float)
bool oder None
str
bool
float
float
- class matplotlib.offsetbox.AnnotationBbox(offsetbox, xy, xybox=None, xycoords='data', boxcoords=None, *, frameon=True, pad=0.4, annotation_clip=None, box_alignment=(0.5, 0.5), bboxprops=None, arrowprops=None, fontsize=None, **kwargs)[source]#
Bases:
Artist,_AnnotationBaseContainer für eine
OffsetBox, die sich auf eine bestimmte Position xy bezieht.Optional kann ein Pfeil gezeichnet werden, der von der Offset-Box auf xy zeigt.
Dies ähnelt
Annotation, aber mitOffsetBoxanstelle vonText.- Parameter:
- offsetbox
OffsetBox - xy(float, float)
Der Punkt (x, y), der annotiert werden soll. Das Koordinatensystem wird durch xycoords bestimmt.
- xybox(float, float), default: xy
Die Position (x, y), an der der Text platziert werden soll. Das Koordinatensystem wird von boxcoords bestimmt.
- xycoordsEinzelner oder zweielementiger Tupel aus str oder
ArtistoderTransformoder aufrufbar, default: 'data' Das Koordinatensystem, in dem xy gegeben ist. Siehe den Parameter xycoords in
Annotationfür eine detaillierte Beschreibung.- boxcoordsEinzelner oder zweielementiger Tupel aus str oder
ArtistoderTransformoder aufrufbar, default: Wert von xycoords Das Koordinatensystem, in dem xybox gegeben ist. Siehe den Parameter textcoords in
Annotationfür eine detaillierte Beschreibung.- frameonbool, Standard: True
Standardmäßig wird der Text von einem weißen
FancyBboxPatchumgeben (zugänglich als Attribut patch derAnnotationBbox). Wenn frameon auf False gesetzt ist, wird dieser Patch unsichtbar gemacht.- annotation_clip: bool oder 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.
- padfloat, default: 0.4
Innenabstand um die Offset-Box.
- box_alignment(float, float)
Ein Tupel aus zwei Floats für eine vertikale und horizontale Ausrichtung der Offset-Box relativ zu boxcoords. Die untere linke Ecke ist (0, 0) und die obere rechte Ecke ist (1, 1).
- bboxpropsdict, optional
Ein Wörterbuch von Eigenschaften, die für die Bounding Box der Anmerkung gesetzt werden sollen, z.B. boxstyle und alpha. Siehe
FancyBboxPatchfür Details.- arrowprops: dict, optional
Pfeileigenschaften, siehe
Annotationfür die Beschreibung.- fontsize: float oder str, optional
Wird in Punkte umgerechnet und als mutation_scale an
FancyBboxPatchübergeben, um Attribute des Box-Stils zu skalieren (z.B. pad oder rounding_size). Der Name ist in Analogie zuTextgewählt, wo fontsize ebenfalls die Mutationsskala definiert. Wenn nicht angegeben, wirdrcParams["legend.fontsize"](Standard:'medium') verwendet. SieheText.set_fontsizefür gültige Werte.- **kwargs
Andere Eigenschaften von
AnnotationBbox. SieheAnnotationBbox.setfür eine Liste.
- offsetbox
- property anncoords#
- contains(mouseevent)[source]#
Testet, ob der Künstler das Mausereignis enthält.
- Parameter:
- mouseevent
MouseEvent
- mouseevent
- Gibt zurück:
- containsbool
Gibt an, ob Werte innerhalb des Radius liegen.
- detailsdict
Ein Künstler-spezifisches Wörterbuch mit Details zum Ereigniskontext, wie z. B. welche Punkte sich im Auswahlradius befinden. Details finden Sie in den einzelnen Künstler-Unterklassen.
- 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_visiblegibt False zurück).- Parameter:
- renderer
RendererBaseUnterklasse.
- renderer
Anmerkungen
Diese Methode wird in den Künstler-Unterklassen überschrieben.
- get_tightbbox(renderer=None)[source]#
Ähnlich wie
Artist.get_window_extent, aber inklusive jeglichen Beschneidens.- Parameter:
- renderer
RendererBasesubclass, optional Renderer, der zum Zeichnen der Figuren verwendet wird (d. h.
fig.canvas.get_renderer())
- renderer
- Gibt zurück:
Bboxoder NoneDie umschließende Bounding Box (in Figure-Pixelkoordinaten). Gibt None zurück, wenn durch Clipping keine Schnittmenge entsteht.
- 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.
- set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, annotation_clip=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, fontsize=<UNSET>, gid=<UNSET>, in_layout=<UNSET>, label=<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
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
float oder None
bool
annotation_clipbool oder None
BboxBaseoder Nonebool
Patch oder (Path, Transform) oder None
unknown
unknown
str
bool
object
bool
liste von
AbstractPathEffectNone oder bool oder float oder callable
bool
(scale: float, length: float, randomness: float)
bool oder None
str
bool
float
- set_fontsize(s=None)[source]#
Setzt die Schriftgröße in Punkte.
Wenn s nicht angegeben ist, wird es auf
rcParams["legend.fontsize"](Standard:'medium') zurückgesetzt.
- update_positions(renderer)[source]#
Aktualisiert die Pixelpositionen für den annotierten Punkt, den Text und den Pfeil.
- property xyann#
- zorder = 3#
- class matplotlib.offsetbox.AuxTransformBox(aux_transform)[Quelle]#
Bases:
OffsetBoxOffset-Box mit dem aux_transform. Ihre Kinder werden zuerst mit dem aux_transform transformiert und dann verschoben. Die absolute Koordinate des aux_transform ist von Bedeutung, da sie automatisch angepasst wird, sodass die linke untere Ecke des Begrenzungsrahmens der Kinder vor der Offset-Transformation auf (0, 0) gesetzt wird.
Dies ähnelt einem Zeichenbereich, mit dem Unterschied, dass das Ausmaß der Box nicht vordefiniert ist, sondern aus dem Fensterumfang ihrer Kinder berechnet wird. Darüber hinaus wird das Ausmaß der Kinder im transformierten Koordinatensystem berechnet.
- draw(renderer)[Quelle]#
Aktualisiert die Position der Kinder, falls erforderlich, und zeichnet sie auf den gegebenen renderer.
- get_bbox(renderer)[Quelle]#
Gibt die Bounding Box der Offset-Box zurück, wobei übergeordnete Offsets ignoriert werden.
- set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, gid=<UNSET>, height=<UNSET>, in_layout=<UNSET>, label=<UNSET>, mouseover=<UNSET>, offset=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, width=<UNSET>, zorder=<UNSET>)[Quelle]#
Setzt mehrere Eigenschaften auf einmal.
Unterstützte Eigenschaften sind
Eigenschaft
Beschreibung
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
float oder None
bool
BboxBaseoder Nonebool
Patch oder (Path, Transform) oder None
str
float
bool
object
bool
(float, float)
liste von
AbstractPathEffectNone oder bool oder float oder callable
bool
(scale: float, length: float, randomness: float)
bool oder None
unknown
str
bool
float
float
- class matplotlib.offsetbox.DraggableAnnotation(annotation, use_blit=False)[Quelle]#
Basen:
DraggableBase
- class matplotlib.offsetbox.DraggableBase(ref_artist, use_blit=False)[Quelle]#
Bases:
objectHilfsbasisklasse für einen ziehbaren Künstler (Legende, OffsetBox).
Abgeleitete Klassen müssen die folgenden Methoden überschreiben.
def save_offset(self): ''' Called when the object is picked for dragging; should save the reference position of the artist. ''' def update_offset(self, dx, dy): ''' Called during the dragging; (*dx*, *dy*) is the pixel offset from the point where the mouse drag started. '''
Optional können Sie die folgende Methode überschreiben.
def finalize_offset(self): '''Called when the mouse is released.'''
In der aktuellen Implementierung von
DraggableLegendundDraggableAnnotationplatziertupdate_offsetdie Künstler in Display-Koordinaten, undfinalize_offsetberechnet ihre Position in Achsenkoordinaten neu und setzt ein relevantes Attribut.- property canvas#
- property cids#
- class matplotlib.offsetbox.DraggableOffsetBox(ref_artist, offsetbox, use_blit=False)[Quelle]#
Basen:
DraggableBase
- class matplotlib.offsetbox.DrawingArea(width, height, xdescent=0.0, ydescent=0.0, clip=False)[Quelle]#
Bases:
OffsetBoxDie DrawingArea kann jeden Künstler als Kind enthalten. Die DrawingArea hat eine feste Breite und Höhe. Die Position der Kinder relativ zum Elternteil ist fest. Die Kinder können an den Grenzen des Elternteils abgeschnitten werden.
- Parameter:
- width, heightfloat
Breite und Höhe der Container-Box.
- xdescent, ydescentfloat
Abstieg der Box in x- und y-Richtung.
- clipbool
Ob die Kinder auf die Box zugeschnitten werden sollen.
- property clip_children#
Ob die Kinder dieser DrawingArea durch den Begrenzungsrahmen der DrawingArea zugeschnitten werden sollen.
- draw(renderer)[Quelle]#
Aktualisiert die Position der Kinder, falls erforderlich, und zeichnet sie auf den gegebenen renderer.
- get_bbox(renderer)[Quelle]#
Gibt die Bounding Box der Offset-Box zurück, wobei übergeordnete Offsets ignoriert werden.
- set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, gid=<UNSET>, height=<UNSET>, in_layout=<UNSET>, label=<UNSET>, mouseover=<UNSET>, offset=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, width=<UNSET>, zorder=<UNSET>)[Quelle]#
Setzt mehrere Eigenschaften auf einmal.
Unterstützte Eigenschaften sind
Eigenschaft
Beschreibung
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
float oder None
bool
BboxBaseoder Nonebool
Patch oder (Path, Transform) oder None
str
float
bool
object
bool
(float, float)
liste von
AbstractPathEffectNone oder bool oder float oder callable
bool
(scale: float, length: float, randomness: float)
bool oder None
unknown
str
bool
float
float
- class matplotlib.offsetbox.HPacker(pad=0.0, sep=0.0, width=None, height=None, align='baseline', mode='fixed', children=None)[Quelle]#
Basen:
PackerBaseHPacker packt seine Kinder horizontal und passt deren relative Positionen zur Zeichenzeit automatisch an.
+-------------------------------+ | Child 1 Child 2 Child 3 | +-------------------------------+
- Parameter:
- padfloat, Standard: 0.0
Der Randabstand in Punkten.
- sepfloat, Standard: 0.0
Der Abstand zwischen den Elementen in Punkten.
- width, heightfloat, optional
Breite und Höhe der Container-Box in Pixeln, wird berechnet, wenn *None*.
- align{'top', 'bottom', 'left', 'right', 'center', 'baseline'}, Standard: 'baseline'
Ausrichtung der Boxen.
- mode{'fixed', 'expand', 'equal'}, Standard: 'fixed'
Der Packmodus.
'fixed' packt die gegebenen
Artists eng mit einem Abstand von *sep*.'expand' nutzt den maximal verfügbaren Platz, um die Künstler mit gleichem Abstand dazwischen zu verteilen.
'equal': Jeder Künstler erhält einen gleichen Anteil des verfügbaren Platzes und wird darin linksbündig (oder obenbündig) ausgerichtet.
- childrenListe von
Artist Die zu packenden Künstler.
Anmerkungen
pad und sep sind in Punkten und werden mit der Renderer-DPI skaliert, während width und height in Pixeln angegeben sind.
- set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, gid=<UNSET>, height=<UNSET>, in_layout=<UNSET>, label=<UNSET>, mouseover=<UNSET>, offset=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, width=<UNSET>, zorder=<UNSET>)[Quelle]#
Setzt mehrere Eigenschaften auf einmal.
Unterstützte Eigenschaften sind
Eigenschaft
Beschreibung
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
float oder None
bool
BboxBaseoder Nonebool
Patch oder (Path, Transform) oder None
str
float
bool
object
bool
(float, float) oder aufrufbar
liste von
AbstractPathEffectNone oder bool oder float oder callable
bool
(scale: float, length: float, randomness: float)
bool oder None
str
bool
float
float
- class matplotlib.offsetbox.OffsetBox(*args, **kwargs)[Quelle]#
Bases:
ArtistDie OffsetBox ist ein einfacher Container-Künstler.
Die Kinderkünstler sollen an einer relativen Position zu ihrem Elternteil gezeichnet werden.
Als Künstler selbst werden alle Parameter an
Artistweitergegeben.- contains(mouseevent)[Quelle]#
Delegiert die Contains-Prüfung von Mausereignissen an die Kinder.
Als Container reagiert die
OffsetBoxselbst nicht auf Mausereignisse.- Parameter:
- mouseevent
MouseEvent
- mouseevent
- Gibt zurück:
- containsbool
Gibt an, ob Werte innerhalb des Radius liegen.
- detailsdict
Ein Künstler-spezifisches Wörterbuch mit Details zum Ereigniskontext, wie z. B. welche Punkte sich im Auswahlradius befinden. Details finden Sie in den einzelnen Künstler-Unterklassen.
Siehe auch
- draw(renderer)[Quelle]#
Aktualisiert die Position der Kinder, falls erforderlich, und zeichnet sie auf den gegebenen renderer.
- get_bbox(renderer)[Quelle]#
Gibt die Bounding Box der Offset-Box zurück, wobei übergeordnete Offsets ignoriert werden.
- get_offset(bbox, renderer)[Quelle]#
Gibt den Offset als Tupel (x, y) zurück.
Die Extent-Parameter müssen bereitgestellt werden, um den Fall zu behandeln, dass der Offset dynamisch durch eine aufrufbare Funktion bestimmt wird (siehe
set_offset).- Parameter:
- bbox
Bbox - renderer
RendererBasesubclass
- bbox
- get_window_extent(renderer=None)[Quelle]#
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.
- set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, gid=<UNSET>, height=<UNSET>, in_layout=<UNSET>, label=<UNSET>, mouseover=<UNSET>, offset=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, width=<UNSET>, zorder=<UNSET>)[Quelle]#
Setzt mehrere Eigenschaften auf einmal.
Unterstützte Eigenschaften sind
Eigenschaft
Beschreibung
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
float oder None
bool
BboxBaseoder Nonebool
Patch oder (Path, Transform) oder None
str
float
bool
object
bool
(float, float) oder aufrufbar
liste von
AbstractPathEffectNone oder bool oder float oder callable
bool
(scale: float, length: float, randomness: float)
bool oder None
str
bool
float
float
- set_figure(fig)[Quelle]#
Setzt die
Figurefür dieOffsetBoxund alle ihre Kinder.- Parameter:
- fig
Figure
- fig
- set_offset(xy)[Quelle]#
Setzt den Offset.
- Parameter:
- xy(float, float) oder aufrufbar
Die (x, y)-Koordinaten des Offsets in Display-Einheiten. Diese können entweder explizit als Tupel (x, y) angegeben werden oder durch eine Funktion, die den Umfang in den Offset umwandelt. Diese Funktion muss die Signatur haben.
def offset(width, height, xdescent, ydescent, renderer) -> (float, float)
- class matplotlib.offsetbox.OffsetImage(arr, *, zoom=1, cmap=None, norm=None, interpolation=None, origin=None, filternorm=True, filterrad=4.0, resample=False, dpi_cor=True, **kwargs)[source]#
Bases:
OffsetBox- draw(renderer)[source]#
Aktualisiert die Position der Kinder, falls erforderlich, und zeichnet sie auf den gegebenen renderer.
- get_bbox(renderer)[source]#
Gibt die Bounding Box der Offset-Box zurück, wobei übergeordnete Offsets ignoriert werden.
- set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, data=<UNSET>, gid=<UNSET>, height=<UNSET>, in_layout=<UNSET>, label=<UNSET>, mouseover=<UNSET>, offset=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, width=<UNSET>, zoom=<UNSET>, zorder=<UNSET>)[source]#
Setzt mehrere Eigenschaften auf einmal.
Unterstützte Eigenschaften sind
Eigenschaft
Beschreibung
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
float oder None
bool
BboxBaseoder Nonebool
Patch oder (Path, Transform) oder None
unknown
str
float
bool
object
bool
(float, float) oder aufrufbar
liste von
AbstractPathEffectNone oder bool oder float oder callable
bool
(scale: float, length: float, randomness: float)
bool oder None
str
bool
float
unknown
float
- class matplotlib.offsetbox.PackerBase(pad=0.0, sep=0.0, width=None, height=None, align='baseline', mode='fixed', children=None)[source]#
Bases:
OffsetBox- Parameter:
- padfloat, Standard: 0.0
Der Randabstand in Punkten.
- sepfloat, Standard: 0.0
Der Abstand zwischen den Elementen in Punkten.
- width, heightfloat, optional
Breite und Höhe der Container-Box in Pixeln, wird berechnet, wenn *None*.
- align{'top', 'bottom', 'left', 'right', 'center', 'baseline'}, Standard: 'baseline'
Ausrichtung der Boxen.
- mode{'fixed', 'expand', 'equal'}, Standard: 'fixed'
Der Packmodus.
'fixed' packt die gegebenen
Artists eng mit einem Abstand von *sep*.'expand' nutzt den maximal verfügbaren Platz, um die Künstler mit gleichem Abstand dazwischen zu verteilen.
'equal': Jeder Künstler erhält einen gleichen Anteil des verfügbaren Platzes und wird darin linksbündig (oder obenbündig) ausgerichtet.
- childrenListe von
Artist Die zu packenden Künstler.
Anmerkungen
pad und sep sind in Punkten und werden mit der Renderer-DPI skaliert, während width und height in Pixeln angegeben sind.
- set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, gid=<UNSET>, height=<UNSET>, in_layout=<UNSET>, label=<UNSET>, mouseover=<UNSET>, offset=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, width=<UNSET>, zorder=<UNSET>)[source]#
Setzt mehrere Eigenschaften auf einmal.
Unterstützte Eigenschaften sind
Eigenschaft
Beschreibung
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
float oder None
bool
BboxBaseoder Nonebool
Patch oder (Path, Transform) oder None
str
float
bool
object
bool
(float, float) oder aufrufbar
liste von
AbstractPathEffectNone oder bool oder float oder callable
bool
(scale: float, length: float, randomness: float)
bool oder None
str
bool
float
float
- class matplotlib.offsetbox.PaddedBox(child, pad=0.0, *, draw_frame=False, patch_attrs=None)[source]#
Bases:
OffsetBoxEin Container, um einen
Artistmit einem Innenabstand zu versehen.Die
PaddedBoxenthält einFancyBboxPatch, das zur Visualisierung beim Rendern verwendet wird.+----------------------------+ | | | | | | | <--pad--> Artist | | ^ | | pad | | v | +----------------------------+
- Attribute:
- padfloat
Der Abstand in Punkten.
- patch
FancyBboxPatch Wenn draw_frame True ist, wird dieses
FancyBboxPatchsichtbar gemacht und erstellt einen Rahmen um die Box.
- Parameter:
- child
Artist Der enthaltene
Artist.- padfloat, Standard: 0.0
Der Abstand in Punkten. Dieser wird mit der DPI des Renderers skaliert. Im Gegensatz dazu sind width und height in Pixeln und werden daher nicht skaliert.
- draw_framebool
Ob das enthaltene
FancyBboxPatchgezeichnet werden soll.- patch_attrsdict oder None
Zusätzliche Parameter, die an das enthaltene
FancyBboxPatchübergeben werden.
- child
- draw(renderer)[source]#
Aktualisiert die Position der Kinder, falls erforderlich, und zeichnet sie auf den gegebenen renderer.
- set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, gid=<UNSET>, height=<UNSET>, in_layout=<UNSET>, label=<UNSET>, mouseover=<UNSET>, offset=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, width=<UNSET>, zorder=<UNSET>)[source]#
Setzt mehrere Eigenschaften auf einmal.
Unterstützte Eigenschaften sind
Eigenschaft
Beschreibung
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
float oder None
bool
BboxBaseoder Nonebool
Patch oder (Path, Transform) oder None
str
float
bool
object
bool
(float, float) oder aufrufbar
liste von
AbstractPathEffectNone oder bool oder float oder callable
bool
(scale: float, length: float, randomness: float)
bool oder None
str
bool
float
float
- class matplotlib.offsetbox.TextArea(s, *, textprops=None, multilinebaseline=False)[source]#
Bases:
OffsetBoxDie TextArea ist ein Container-Artist für eine einzelne Textinstanz.
Der Text wird standardmäßig bei (0, 0) mit Grundlinie+links-Ausrichtung platziert. Die Breite und Höhe der TextArea-Instanz entspricht der Breite und Höhe ihres Text-Kindes.
- Parameter:
- sstr
Der anzuzeigende Text.
- textpropsdict, Standard: {}
Wörterbuch mit Schlüsselwortparametern, die an die
Text-Instanz in der TextArea übergeben werden.- multilinebaselinebool, Standard: False
Ob die Grundlinie für mehrzeiligen Text so angepasst wird, dass sie (ungefähr) mit einzeiligem Text zentriert ausgerichtet ist.
- draw(renderer)[source]#
Aktualisiert die Position der Kinder, falls erforderlich, und zeichnet sie auf den gegebenen renderer.
- get_bbox(renderer)[source]#
Gibt die Bounding Box der Offset-Box zurück, wobei übergeordnete Offsets ignoriert werden.
- set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, gid=<UNSET>, height=<UNSET>, in_layout=<UNSET>, label=<UNSET>, mouseover=<UNSET>, multilinebaseline=<UNSET>, offset=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, text=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, width=<UNSET>, zorder=<UNSET>)[source]#
Setzt mehrere Eigenschaften auf einmal.
Unterstützte Eigenschaften sind
Eigenschaft
Beschreibung
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
float oder None
bool
BboxBaseoder Nonebool
Patch oder (Path, Transform) oder None
str
float
bool
object
bool
unknown
(float, float)
liste von
AbstractPathEffectNone oder bool oder float oder callable
bool
(scale: float, length: float, randomness: float)
bool oder None
unknown
unknown
str
bool
float
float
- set_multilinebaseline(t)[source]#
Multilinebaseline setzen.
Wenn True, wird die Grundlinie für mehrzeiligen Text so angepasst, dass sie (ungefähr) mit einzeiligem Text zentriert ausgerichtet ist. Dies wird z. B. von der Legendenimplementierung verwendet, damit einzeilige Beschriftungen grundlinienausgerichtet sind, mehrzeilige Beschriftungen jedoch "zentriert" mit ihnen.
- class matplotlib.offsetbox.VPacker(pad=0.0, sep=0.0, width=None, height=None, align='baseline', mode='fixed', children=None)[source]#
Basen:
PackerBaseVPacker packt seine Kinder vertikal und passt deren relative Positionen zur Zeichenzeit automatisch an.
+---------+ | Child 1 | | Child 2 | | Child 3 | +---------+
- Parameter:
- padfloat, Standard: 0.0
Der Randabstand in Punkten.
- sepfloat, Standard: 0.0
Der Abstand zwischen den Elementen in Punkten.
- width, heightfloat, optional
Breite und Höhe der Container-Box in Pixeln, wird berechnet, wenn *None*.
- align{'top', 'bottom', 'left', 'right', 'center', 'baseline'}, Standard: 'baseline'
Ausrichtung der Boxen.
- mode{'fixed', 'expand', 'equal'}, Standard: 'fixed'
Der Packmodus.
'fixed' packt die gegebenen
Artists eng mit einem Abstand von *sep*.'expand' nutzt den maximal verfügbaren Platz, um die Künstler mit gleichem Abstand dazwischen zu verteilen.
'equal': Jeder Künstler erhält einen gleichen Anteil des verfügbaren Platzes und wird darin linksbündig (oder obenbündig) ausgerichtet.
- childrenListe von
Artist Die zu packenden Künstler.
Anmerkungen
pad und sep sind in Punkten und werden mit der Renderer-DPI skaliert, während width und height in Pixeln angegeben sind.
- set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, gid=<UNSET>, height=<UNSET>, in_layout=<UNSET>, label=<UNSET>, mouseover=<UNSET>, offset=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, width=<UNSET>, zorder=<UNSET>)[source]#
Setzt mehrere Eigenschaften auf einmal.
Unterstützte Eigenschaften sind
Eigenschaft
Beschreibung
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
float oder None
bool
BboxBaseoder Nonebool
Patch oder (Path, Transform) oder None
str
float
bool
object
bool
(float, float) oder aufrufbar
liste von
AbstractPathEffectNone oder bool oder float oder callable
bool
(scale: float, length: float, randomness: float)
bool oder None
str
bool
float
float