`matplotlib.legend_handler`#

Gestori di legenda predefiniti.

Importante

Questa è un'API legenda di basso livello, di cui la maggior parte degli utenti finali non ha bisogno.

Ti consigliamo di familiarizzare con la guida alla legenda prima di leggere questa documentazione.

I gestori della legenda dovrebbero essere un oggetto richiamabile con una firma successiva.

legend_handler(legend, orig_handle, fontsize, handlebox)

Dove legend è la legenda stessa, orig_handle è la trama originale, fontsize è la dimensione del carattere in pixel e handlebox è un'istanza di OffsetBox. All'interno della chiamata, dovresti creare artisti pertinenti (utilizzando le proprietà pertinenti da legend e/o orig_handle ) e aggiungerli all'handlebox. Gli artisti devono essere ridimensionati in base alla dimensione del carattere (nota che la dimensione è in pixel, cioè questo è un valore in scala dpi).

Questo modulo include la definizione di diverse classi di gestori di legende derivate dalla classe base (HandlerBase) con il seguente metodo:

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

classe matplotlib.legend_handler. HandlerBase ( xpad = 0.0 , ypad = 0.0 , update_func = None ) [fonte] #

Una classe base per i gestori di legenda predefiniti.

Le classi derivate hanno lo scopo di sovrascrivere il metodo create_artists , che ha una seguente firma:

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

Il metodo sovrascritto deve creare artisti della data trasformazione che si adatta alla dimensione data (xdescent, ydescent, larghezza, altezza) che vengono ridimensionati in base alla dimensione del carattere, se necessario.

adjust_drawing_area ( legend , orig_handle , xdescent , ydescent , width , height , fontsize ) [fonte] #

create_artists ( legend , orig_handle , xdescent , ydescent , width , height , fontsize , trans ) [fonte] #

legend_artist ( legend , orig_handle , fontsize , handlebox ) [fonte] #

Restituisci l'artista che questo HandlerBase genera per l'artista/handle originale specificato.

Parametri :

leggendaLegend: La leggenda per la quale vengono creati questi artisti leggendari.
orig_handle matplotlib.artist.Artisto simile: L'oggetto per il quale vengono creati questi artisti leggendari.
dimensione carattere int: La dimensione del carattere in pixel. Gli artisti che vengono creati dovrebbero essere ridimensionati in base alla dimensione del carattere data.
manigliamatplotlib.offsetbox.OffsetBox: La scatola che è stata creata per contenere gli artisti di questa voce leggendaria. Gli artisti creati nel legend_artistmetodo devono essere aggiunti a questo handlebox all'interno di questo metodo.

update_prop ( legend_handle , orig_handle , legend ) [fonte] #

classe matplotlib.legend_handler. HandlerCircleCollection ( yoffsets = None , sizes = None , ** kwargs ) [fonte] #

Gestore per CircleCollections.

Parametri :

numpunti int: Numero di punti da mostrare nella voce della legenda.
yoffsets array di float: Lunghezza numpoints elenco di offset y per ogni punto nella voce della legenda.
**kwargs: Argomenti delle parole chiave inoltrati a HandlerNpoints.

create_collection ( orig_handle , sizes , offsets , offset_transform ) [fonte] #

classe matplotlib.legend_handler. HandlerErrorbar ( xerr_size = 0.5 , yerr_size = None , marker_pad = 0.3 , numpoints = None , ** kwargs ) [fonte] #

Gestore per barre di errore.

Parametri :

marker_pad galleggiante: Riempimento tra i punti nella voce della legenda.
numpunti int: Numero di punti da mostrare nella voce della legenda.
**kwargs: Argomenti delle parole chiave inoltrati a HandlerBase.

create_artists ( legend , orig_handle , xdescent , ydescent , width , height , fontsize , trans ) [fonte] #

get_err_size ( legend , xdescent , ydescent , width , height , fontsize ) [fonte] #

classe matplotlib.legend_handler. HandlerLine2D ( marker_pad = 0.3 , numpoints = None , ** kwargs ) [fonte] #

Gestore per le Line2Distanze.

Guarda anche

HandlerLine2DCompound: Un'implementazione precedente del gestore, che utilizzava un artista per la linea e un altro per i marcatori.

Parametri :

marker_pad galleggiante: Riempimento tra i punti nella voce della legenda.
numpunti int: Numero di punti da mostrare nella voce della legenda.
**kwargs: Argomenti delle parole chiave inoltrati a HandlerBase.

create_artists ( legend , orig_handle , xdescent , ydescent , width , height , fontsize , trans ) [fonte] #

classe matplotlib.legend_handler. HandlerLine2DCompound ( marker_pad = 0.3 , numpoints = None , ** kwargs ) [fonte] #

Gestore originale per Line2Desempio, che si basa sulla combinazione di un artista solo linea con un artista solo marcatore. Potrebbe essere deprecato in futuro.

Parametri :

marker_pad galleggiante: Riempimento tra i punti nella voce della legenda.
numpunti int: Numero di punti da mostrare nella voce della legenda.
**kwargs: Argomenti delle parole chiave inoltrati a HandlerBase.

create_artists ( legend , orig_handle , xdescent , ydescent , width , height , fontsize , trans ) [fonte] #

classe matplotlib.legend_handler. HandlerLineCollection ( marker_pad = 0.3 , numpoints = None , ** kwargs ) [fonte] #

Gestore per le LineCollectionistanze.

Parametri :

marker_pad galleggiante: Riempimento tra i punti nella voce della legenda.
numpunti int: Numero di punti da mostrare nella voce della legenda.
**kwargs: Argomenti delle parole chiave inoltrati a HandlerBase.

create_artists ( legend , orig_handle , xdescent , ydescent , width , height , fontsize , trans ) [fonte] #

get_numpoints ( legenda ) [fonte] #

classe matplotlib.legend_handler. HandlerNpoints ( marker_pad = 0.3 , numpoints = None , ** kwargs ) [fonte] #

Un gestore della legenda che mostra numpoints punti nella voce della legenda.

Parametri :

marker_pad galleggiante: Riempimento tra i punti nella voce della legenda.
numpunti int: Numero di punti da mostrare nella voce della legenda.
**kwargs: Argomenti delle parole chiave inoltrati a HandlerBase.

get_numpoints ( legenda ) [fonte] #

get_xdata ( legend , xdescent , ydescent , width , height , fontsize ) [fonte] #

classe matplotlib.legend_handler. HandlerNpointsYoffsets ( numpoints = None , yoffsets = None , ** kwargs ) [fonte] #

Un gestore della legenda che mostra i numpoint nella legenda e consente loro di essere sfalsati individualmente nella direzione y.

Parametri :

numpunti int: Numero di punti da mostrare nella voce della legenda.
yoffsets array di float: Lunghezza numpoints elenco di offset y per ogni punto nella voce della legenda.
**kwargs: Argomenti delle parole chiave inoltrati a HandlerNpoints.

get_ydata ( legend , xdescent , ydescent , width , height , fontsize ) [fonte] #

classe matplotlib.legend_handler. HandlerPatch ( patch_func = None , ** kwargs ) [fonte] #

Gestore per le Patchistanze.

Parametri :

patch_func richiamabile, facoltativo

La funzione che crea la legenda chiave artista. patch_func dovrebbe avere la firma:

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

Successivamente l'artista creato avrà il suo update_prop metodo chiamato e verrà applicata la trasformazione appropriata.

**kwargs

Argomenti delle parole chiave inoltrati a HandlerBase.

create_artists ( legend , orig_handle , xdescent , ydescent , width , height , fontsize , trans ) [fonte] #

classe matplotlib.legend_handler. HandlerPathCollection ( yoffsets = None , sizes = None , ** kwargs ) [fonte] #

Gestore per PathCollections, utilizzato da scatter.

Parametri :

numpunti int: Numero di punti da mostrare nella voce della legenda.
yoffsets array di float: Lunghezza numpoints elenco di offset y per ogni punto nella voce della legenda.
**kwargs: Argomenti delle parole chiave inoltrati a HandlerNpoints.

create_collection ( orig_handle , sizes , offsets , offset_transform ) [fonte] #

classe matplotlib.legend_handler. HandlerPolyCollection ( xpad = 0.0 , ypad = 0.0 , update_func = None ) [fonte] #

Gestore per PolyCollectionutilizzato in fill_betweene stackplot.

create_artists ( legend , orig_handle , xdescent , ydescent , width , height , fontsize , trans ) [fonte] #

classe matplotlib.legend_handler. HandlerRegularPolyCollection ( yoffsets = None , sizes = None , ** kwargs ) [fonte] #

Gestore per RegularPolyCollections.

Parametri :

numpunti int: Numero di punti da mostrare nella voce della legenda.
yoffsets array di float: Lunghezza numpoints elenco di offset y per ogni punto nella voce della legenda.
**kwargs: Argomenti delle parole chiave inoltrati a HandlerNpoints.

create_artists ( legend , orig_handle , xdescent , ydescent , width , height , fontsize , trans ) [fonte] #

create_collection ( orig_handle , sizes , offsets , offset_transform ) [fonte] #

get_numpoints ( legenda ) [fonte] #

get_sizes ( legend , orig_handle , xdescent , ydescent , width , height , fontsize ) [fonte] #

update_prop ( legend_handle , orig_handle , legend ) [fonte] #

classe matplotlib.legend_handler. HandlerStem ( marker_pad = 0.3 , numpoints = None , bottom = None , yoffsets = None , ** kwargs ) [fonte] #

Gestore per grafici prodotti da stem.

Parametri :

marker_pad float, predefinito: 0.3: Riempimento tra i punti nella voce della legenda.
numpoints int, facoltativo: Numero di punti da mostrare nella voce della legenda.
galleggiante inferiore , opzionale
yoffsets array di float, facoltativo: Lunghezza numpoints elenco di offset y per ogni punto nella voce della legenda.
**kwargs: Argomenti delle parole chiave inoltrati a HandlerNpointsYoffsets.

create_artists ( legend , orig_handle , xdescent , ydescent , width , height , fontsize , trans ) [fonte] #

get_ydata ( legend , xdescent , ydescent , width , height , fontsize ) [fonte] #

classe matplotlib.legend_handler. HandlerStepPatch ( xpad = 0.0 , ypad = 0.0 , update_func = None ) [fonte] #

Gestore per le StepPatchistanze.

create_artists ( legend , orig_handle , xdescent , ydescent , width , height , fontsize , trans ) [fonte] #

classe matplotlib.legend_handler. HandlerTuple ( ndivide = 1 , pad = None , ** kwargs ) [fonte] #

Gestore per tupla.

Parametri :

ndivide int, predefinito: 1: Il numero di sezioni in cui suddividere l'area della legenda. Se None, usa la lunghezza della tupla di input.
pad float, predefinito: rcParams["legend.borderpad"](predefinito: 0.4): Imbottitura in unità di frazione della dimensione del carattere.
**kwargs: Argomenti delle parole chiave inoltrati a HandlerBase.

create_artists ( legend , orig_handle , xdescent , ydescent , width , height , fontsize , trans ) [fonte] #

matplotlib.legend_handler. update_from_first_child ( tgt , src ) [fonte] #

matplotlib.legend_handler#

`matplotlib.legend_handler`#