matplotlib.legend_handler

Standard-Legendenhandler.

Wichtig

Dies ist eine Legenden-API auf niedriger Ebene, die die meisten Endbenutzer nicht benötigen.

Wir empfehlen, dass Sie sich mit dem Legendenhandbuch vertraut machen, bevor Sie diese Dokumentation lesen.

Von Legendenhandlern wird erwartet, dass sie ein aufrufbares Objekt mit einer folgenden Signatur sind.

legend_handler(legend, orig_handle, fontsize, handlebox)

Wobei legend die Legende selbst ist, orig_handle das ursprüngliche Diagramm ist , fontsize die Schriftgröße in Pixel ist und handlebox eine OffsetBox-Instanz ist. Innerhalb des Aufrufs sollten Sie relevante Künstler erstellen (unter Verwendung relevanter Eigenschaften aus der Legende und/oder orig_handle ) und sie der Handlebox hinzufügen. Die Künstler müssen entsprechend der Schriftgröße skaliert werden (beachten Sie, dass die Größe in Pixel angegeben ist, dh dies ist ein dpi-skalierter Wert).

Dieses Modul enthält die Definition mehrerer Legenden-Handler-Klassen, die von der Basisklasse (HandlerBase) mit der folgenden Methode abgeleitet wurden:

def legend_artist(self, legend, orig_handle, fontsize, handlebox)

Klasse matplotlib.legend_handler. HandlerBase ( xpad = 0.0 , ypad = 0.0 , update_func = None )

Eine Basisklasse für standardmäßige Legendenhandler.

Die abgeleiteten Klassen sollen die create_artists- Methode überschreiben, die die folgende Signatur hat:

def create_artists(self, legend, orig_handle,
                   xdescent, ydescent, width, height, fontsize,
                   trans):

Die überschriebene Methode muss Grafiker der angegebenen Transformation erstellen, die in die angegebene Dimension (xdescent, ydescent, width, height) passen, die bei Bedarf nach Schriftgröße skaliert werden.

adjust_drawing_area ( legend , orig_handle , xdescent , ydescent , width , height , fontsize )

create_artists ( legend , orig_handle , xdescent , ydescent , width , height , fontsize , trans )

legend_artist ( legend , orig_handle , fontsize , handlebox )

Gibt den Künstler zurück, den diese HandlerBase für den angegebenen ursprünglichen Künstler/Handle generiert.

Parameter :

LegendeLegend

Die Legende, für die diese Legendenkünstler geschaffen werden.

orig_handle matplotlib.artist.Artistoder ähnlich

Das Objekt, für das diese legendären Künstler geschaffen werden.

Schriftgröße int

Die Schriftgröße in Pixel. Die zu erstellenden Künstler sollten entsprechend der vorgegebenen Schriftgröße skaliert werden.

Griffkastenmatplotlib.offsetbox.OffsetBox

Die Box, die geschaffen wurde, um die Künstler dieses Legendeneintrags aufzunehmen. Künstler, die in der legend_artistMethode erstellt wurden, müssen dieser Handlebox innerhalb dieser Methode hinzugefügt werden.

update_prop ( legend_handle , orig_handle , legend )

Klasse matplotlib.legend_handler. HandlerCircleCollection ( yoffsets = None , Größen = None , ** kwargs )

Handler für CircleCollections.

Parameter :

Anzahl Punkte int

Anzahl der im Legendeneintrag anzuzeigenden Punkte.

yoffsets Array von Gleitkommazahlen

Länge numpoints Liste von y-Offsets für jeden Punkt im Legendeneintrag.

**Kwarg

Keyword-Argumente werden an weitergeleitet HandlerNpoints.

create_collection ( orig_handle , sizes , offsets , offset_transform )

Klasse matplotlib.legend_handler. HandlerErrorbar ( xerr_size = 0.5 , yerr_size = None , marker_pad = 0.3 , numpoints = None , ** kwargs )

Handler für Fehlerbalken.

Parameter :

marker_pad float

Auffüllen zwischen Punkten im Legendeneintrag.

Anzahl Punkte int

Anzahl der im Legendeneintrag anzuzeigenden Punkte.

**Kwarg

Keyword-Argumente werden an weitergeleitet HandlerBase.

create_artists ( legend , orig_handle , xdescent , ydescent , width , height , fontsize , trans )

get_err_size ( legend , xdescent , ydescent , width , height , fontsize )

Klasse matplotlib.legend_handler. HandlerLine2D ( marker_pad = 0.3 , numpoints = None , ** kwargs )

Handler für Line2DInstanzen.

Siehe auch

HandlerLine2DCompound

Eine frühere Handler-Implementierung, die einen Künstler für die Linie und einen anderen für die Markierung(en) verwendete.

Parameter :

marker_pad float

Auffüllen zwischen Punkten im Legendeneintrag.

Anzahl Punkte int

Anzahl der im Legendeneintrag anzuzeigenden Punkte.

**Kwarg

Keyword-Argumente werden an weitergeleitet HandlerBase.

create_artists ( legend , orig_handle , xdescent , ydescent , width , height , fontsize , trans )

Klasse matplotlib.legend_handler. HandlerLine2DCompound ( marker_pad = 0.3 , numpoints = None , ** kwargs )

Original-Handler zum Line2DBeispiel, der darauf angewiesen ist, einen Nur-Linien-Künstler mit einem Nur-Marker-Künstler zu kombinieren. Kann in Zukunft veraltet sein.

Parameter :

marker_pad float

Auffüllen zwischen Punkten im Legendeneintrag.

Anzahl Punkte int

Anzahl der im Legendeneintrag anzuzeigenden Punkte.

**Kwarg

Keyword-Argumente werden an weitergeleitet HandlerBase.

create_artists ( legend , orig_handle , xdescent , ydescent , width , height , fontsize , trans )

Klasse matplotlib.legend_handler. HandlerLineCollection ( marker_pad = 0.3 , numpoints = None , ** kwargs )

Handler für LineCollectionInstanzen.

Parameter :

marker_pad float

Auffüllen zwischen Punkten im Legendeneintrag.

Anzahl Punkte int

Anzahl der im Legendeneintrag anzuzeigenden Punkte.

**Kwarg

Keyword-Argumente werden an weitergeleitet HandlerBase.

create_artists ( legend , orig_handle , xdescent , ydescent , width , height , fontsize , trans )

get_numpoints ( Legende )

Klasse matplotlib.legend_handler. HandlerNpoints ( marker_pad = 0.3 , numpoints = None , ** kwargs )

Ein Legenden-Handler, der numpoints Punkte im Legendeneintrag anzeigt.

Parameter :

marker_pad float

Auffüllen zwischen Punkten im Legendeneintrag.

Anzahl Punkte int

Anzahl der im Legendeneintrag anzuzeigenden Punkte.

**Kwarg

Keyword-Argumente werden an weitergeleitet HandlerBase.

get_numpoints ( Legende )

get_xdata ( legend , xdescent , ydescent , width , height , fontsize )

Klasse matplotlib.legend_handler. HandlerNpointsYoffsets ( numpoints = None , yoffsets = None , ** kwargs )

Ein Legenden-Handler, der Numpoints in der Legende anzeigt und deren individuelles Versetzen in y-Richtung ermöglicht.

Parameter :

Anzahl Punkte int

Anzahl der im Legendeneintrag anzuzeigenden Punkte.

yoffsets Array von Gleitkommazahlen

Länge numpoints Liste von y-Offsets für jeden Punkt im Legendeneintrag.

**Kwarg

Keyword-Argumente werden an weitergeleitet HandlerNpoints.

get_ydata ( legend , xdescent , ydescent , width , height , fontsize )

Klasse matplotlib.legend_handler. HandlerPatch ( patch_func = None , ** kwargs )

Handler für PatchInstanzen.

Parameter :

patch_func aufrufbar, optional

Die Funktion, die den Legendenschlüsselkünstler erstellt. patch_func sollte die Signatur haben:

def patch_func(legend=legend, orig_handle=orig_handle,
               xdescent=xdescent, ydescent=ydescent,
               width=width, height=height, fontsize=fontsize)

Anschließend wird die update_prop Methode des erstellten Künstlers aufgerufen und die entsprechende Transformation angewendet.

**Kwarg

Keyword-Argumente werden an weitergeleitet HandlerBase.

create_artists ( legend , orig_handle , xdescent , ydescent , width , height , fontsize , trans )

Klasse matplotlib.legend_handler. HandlerPathCollection ( yoffsets = None , Größen = None , ** kwargs )

Handler für PathCollections, die von verwendet werden scatter.

Parameter :

Anzahl Punkte int

Anzahl der im Legendeneintrag anzuzeigenden Punkte.

yoffsets Array von Gleitkommazahlen

Länge numpoints Liste von y-Offsets für jeden Punkt im Legendeneintrag.

**Kwarg

Keyword-Argumente werden an weitergeleitet HandlerNpoints.

create_collection ( orig_handle , sizes , offsets , offset_transform )

Klasse matplotlib.legend_handler. HandlerPolyCollection ( xpad = 0.0 , ypad = 0.0 , update_func = None )

Handler für PolyCollectiondie Verwendung in fill_betweenund stackplot.

create_artists ( legend , orig_handle , xdescent , ydescent , width , height , fontsize , trans )

Klasse matplotlib.legend_handler. HandlerRegularPolyCollection ( yoffsets = None , Größen = None , ** kwargs )

Handler für RegularPolyCollections.

Parameter :

Anzahl Punkte int

Anzahl der im Legendeneintrag anzuzeigenden Punkte.

yoffsets Array von Gleitkommazahlen

Länge numpoints Liste von y-Offsets für jeden Punkt im Legendeneintrag.

**Kwarg

Keyword-Argumente werden an weitergeleitet HandlerNpoints.

create_artists ( legend , orig_handle , xdescent , ydescent , width , height , fontsize , trans )

create_collection ( orig_handle , sizes , offsets , offset_transform )

get_numpoints ( Legende )

get_sizes ( legend , orig_handle , xdescent , ydescent , width , height , fontsize )

update_prop ( legend_handle , orig_handle , legend )

Klasse matplotlib.legend_handler. HandlerStem ( marker_pad = 0.3 , numpoints = None , bottom = None , yoffsets = None , ** kwargs )

Handler für Plots, die von erstellt wurden stem.

Parameter :

marker_pad float, Standard: 0,3

Auffüllen zwischen Punkten im Legendeneintrag.

numpoints int, optional

Anzahl der im Legendeneintrag anzuzeigenden Punkte.

Bodenschwimmer , optional

yoffsets Array von Floats, optional

Länge numpoints Liste von y-Offsets für jeden Punkt im Legendeneintrag.

**Kwarg

Keyword-Argumente werden an weitergeleitet HandlerNpointsYoffsets.

create_artists ( legend , orig_handle , xdescent , ydescent , width , height , fontsize , trans )

get_ydata ( legend , xdescent , ydescent , width , height , fontsize )

Klasse matplotlib.legend_handler. HandlerStepPatch ( xpad = 0.0 , ypad = 0.0 , update_func = None )

Handler für StepPatchInstanzen.

create_artists ( legend , orig_handle , xdescent , ydescent , width , height , fontsize , trans )

Klasse matplotlib.legend_handler. HandlerTuple ( ndivide = 1 , pad = None , ** kwargs )

Handler für Tupel.

Parameter :

ndivide int, Standard: 1

Die Anzahl der Abschnitte, in die der Legendenbereich unterteilt werden soll. Wenn None, verwenden Sie die Länge des Eingabetupels.

Pad Float, Standard: rcParams["legend.borderpad"](Standard: 0.4)

Auffüllen in Einheiten von Bruchteilen der Schriftgröße.

**Kwarg

Keyword-Argumente werden an weitergeleitet HandlerBase.

create_artists ( legend , orig_handle , xdescent , ydescent , width , height , fontsize , trans )

matplotlib.legend_handler. update_from_first_child ( tgt , src )