matplotlib.legend_handler

Gestionnaires de légende par défaut.

Important

Il s'agit d'une API de légende de bas niveau, dont la plupart des utilisateurs finaux n'ont pas besoin.

Nous vous recommandons de vous familiariser avec le guide des légendes avant de lire cette documentation.

Les gestionnaires de légende sont censés être un objet appelable avec une signature suivante.

legend_handler(legend, orig_handle, fontsize, handlebox)

Où legend est la légende elle-même, orig_handle est le tracé d'origine, fontsize est la taille de police en pixels et handlebox est une instance de OffsetBox. Dans l'appel, vous devez créer des artistes pertinents (en utilisant les propriétés pertinentes de la légende et/ou orig_handle ) et les ajouter dans le handlebox. Les artistes doivent être mis à l'échelle en fonction de la taille de la police (notez que la taille est en pixels, c'est-à-dire qu'il s'agit d'une valeur mise à l'échelle en dpi).

Ce module inclut la définition de plusieurs classes de gestionnaire de légende dérivées de la classe de base (HandlerBase) avec la méthode suivante :

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

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

Une classe de base pour les gestionnaires de légende par défaut.

Les classes dérivées sont destinées à remplacer la méthode create_artists , qui a la signature suivante :

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

La méthode remplacée doit créer des artistes de la transformation donnée qui correspondent à la dimension donnée (xdescent, ydescent, width, height) qui sont mis à l'échelle par fontsize si nécessaire.

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 )

Renvoie l'artiste que cette HandlerBase génère pour l'artiste/handle d'origine donné.

Paramètres :

LégendeLegend

La légende pour laquelle ces artistes de légende sont créés.

orig_handle matplotlib.artist.Artistou similaire

L'objet pour lequel ces artistes de légende sont créés.

taille de police entier

La taille de la police en pixels. Les artistes en cours de création doivent être mis à l'échelle en fonction de la taille de police donnée.

poignéematplotlib.offsetbox.OffsetBox

La boîte qui a été créée pour contenir les artistes de cette entrée de légende. Les artistes créés dans la legend_artistméthode doivent être ajoutés à cette poignée à l'intérieur de cette méthode.

update_prop ( légende_handle , orig_handle , légende )

classe matplotlib.legend_handler. HandlerCircleCollection ( yoffsets = Aucun , tailles = Aucun , ** kwargs )

Gestionnaire pour CircleCollections.

Paramètres :

nombres entiers

Nombre de points à afficher dans l'entrée de légende.

yoffsets tableau de flottants

Longueur numpoints liste des décalages y pour chaque point dans l'entrée de légende.

**kwargs

Arguments de mots-clés transmis à HandlerNpoints.

create_collection ( poignée_orig , tailles , décalages , transformation_décalage )

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

Gestionnaire pour les barres d'erreur.

Paramètres :

marqueur_pad flotteur

Remplissage entre les points dans l'entrée de la légende.

nombres entiers

Nombre de points à afficher dans l'entrée de légende.

**kwargs

Arguments de mots-clés transmis à HandlerBase.

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

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

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

Gestionnaire d' Line2Dinstances.

Voir également

HandlerLine2DCompound

Une implémentation de gestionnaire antérieure, qui utilisait un artiste pour la ligne et un autre pour le(s) marqueur(s).

Paramètres :

marqueur_pad flotteur

Remplissage entre les points dans l'entrée de la légende.

nombres entiers

Nombre de points à afficher dans l'entrée de légende.

**kwargs

Arguments de mots-clés transmis à HandlerBase.

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

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

Gestionnaire d'origine pour Line2Dles instances, qui repose sur la combinaison d'une ligne uniquement avec un artiste uniquement marqueur. Peut être obsolète à l'avenir.

Paramètres :

marqueur_pad flotteur

Remplissage entre les points dans l'entrée de la légende.

nombres entiers

Nombre de points à afficher dans l'entrée de légende.

**kwargs

Arguments de mots-clés transmis à HandlerBase.

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

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

Gestionnaire d' LineCollectioninstances.

Paramètres :

marqueur_pad flotteur

Remplissage entre les points dans l'entrée de la légende.

nombres entiers

Nombre de points à afficher dans l'entrée de légende.

**kwargs

Arguments de mots-clés transmis à HandlerBase.

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

get_numpoints ( légende )

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

Un gestionnaire de légende qui affiche numpoints points dans l'entrée de légende.

Paramètres :

marqueur_pad flotteur

Remplissage entre les points dans l'entrée de la légende.

nombres entiers

Nombre de points à afficher dans l'entrée de légende.

**kwargs

Arguments de mots-clés transmis à HandlerBase.

get_numpoints ( légende )

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

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

Un gestionnaire de légende qui affiche les nombres de points dans la légende et leur permet d'être décalés individuellement dans la direction y.

Paramètres :

nombres entiers

Nombre de points à afficher dans l'entrée de légende.

yoffsets tableau de flottants

Longueur numpoints liste des décalages y pour chaque point dans l'entrée de légende.

**kwargs

Arguments de mots-clés transmis à HandlerNpoints.

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

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

Gestionnaire d' Patchinstances.

Paramètres :

patch_func appelable, facultatif

La fonction qui crée l'artiste clé de légende. patch_func doit avoir la signature :

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

Par la suite, l'artiste créé verra sa update_prop méthode appelée et la transformation appropriée sera appliquée.

**kwargs

Arguments de mots-clés transmis à HandlerBase.

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

classe matplotlib.legend_handler. HandlerPathCollection ( yoffsets = Aucun , tailles = Aucun , ** kwargs )

Gestionnaire pour PathCollections, qui sont utilisés par scatter.

Paramètres :

nombres entiers

Nombre de points à afficher dans l'entrée de légende.

yoffsets tableau de flottants

Longueur numpoints liste des décalages y pour chaque point dans l'entrée de légende.

**kwargs

Arguments de mots-clés transmis à HandlerNpoints.

create_collection ( poignée_orig , tailles , décalages , transformation_décalage )

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

Gestionnaire pour PolyCollectionutilisé dans fill_betweenet stackplot.

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

classe matplotlib.legend_handler. HandlerRegularPolyCollection ( yoffsets = Aucun , tailles = Aucun , ** kwargs )

Gestionnaire pour RegularPolyCollections.

Paramètres :

nombres entiers

Nombre de points à afficher dans l'entrée de légende.

yoffsets tableau de flottants

Longueur numpoints liste des décalages y pour chaque point dans l'entrée de légende.

**kwargs

Arguments de mots-clés transmis à HandlerNpoints.

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

create_collection ( poignée_orig , tailles , décalages , transformation_décalage )

get_numpoints ( légende )

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

update_prop ( légende_handle , orig_handle , légende )

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

Gestionnaire pour les tracés produits par stem.

Paramètres :

marqueur_pad flottant, par défaut : 0,3

Remplissage entre les points dans l'entrée de la légende.

numpoints entier , facultatif

Nombre de points à afficher dans l'entrée de légende.

flotteur inférieur , en option

yoffsets tableau de flottants, facultatif

Longueur numpoints liste des décalages y pour chaque point dans l'entrée de légende.

**kwargs

Arguments de mots-clés transmis à HandlerNpointsYoffsets.

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

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

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

Gestionnaire d' StepPatchinstances.

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

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

Gestionnaire pour Tuple.

Paramètres :

diviser entier , par défaut : 1

Le nombre de sections dans lesquelles diviser la zone de légende. Si aucun, utilisez la longueur du tuple d'entrée.

pad flottant, par défaut : rcParams["legend.borderpad"](par défaut : 0.4)

Remplissage en unités de fraction de taille de police.

**kwargs

Arguments de mots-clés transmis à HandlerBase.

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

matplotlib.legend_handler. update_from_first_child ( cible , src )