`matplotlib.legend_handler`#

Controladores de leyenda predeterminados.

Importante

Esta es una API de leyenda de bajo nivel, que la mayoría de los usuarios finales no necesitan.

Le recomendamos que se familiarice con la guía de leyendas antes de leer esta documentación.

Se espera que los controladores de leyenda sean un objeto invocable con una firma siguiente.

legend_handler(legend, orig_handle, fontsize, handlebox)

Donde legend es la leyenda misma, orig_handle es el gráfico original, fontsize es el tamaño de fuente en píxeles y handlebox es una instancia de OffsetBox. Dentro de la llamada, debe crear artistas relevantes (usando las propiedades relevantes de la leyenda y/o orig_handle ) y agregarlos al handlebox. Los artistas deben escalarse de acuerdo con el tamaño de fuente (tenga en cuenta que el tamaño está en píxeles, es decir, este es un valor escalado en dpi).

Este módulo incluye la definición de varias clases de manejadores de leyendas derivadas de la clase base (HandlerBase) con el siguiente método:

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

clase matplotlib.legend_handler. HandlerBase ( xpad = 0.0 , ypad = 0.0 , update_func = Ninguno ) [fuente] #

Una clase base para los controladores de leyenda predeterminados.

Las clases derivadas están destinadas a anular el método create_artists , que tiene la siguiente firma:

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

El método anulado necesita crear artistas de la transformación dada que se ajuste a la dimensión dada (xdescent, ydescent, ancho, alto) que se escalan por tamaño de fuente si es necesario.

Adjust_drawing_area ( leyenda , orig_handle , xdescent , ydescent , ancho , alto , tamaño de fuente ) [fuente] #

create_artists ( leyenda , orig_handle , xdescent , ydescent , ancho , alto , tamaño de fuente , trans ) [fuente] #

legend_artist ( leyenda , orig_handle , tamaño de fuente , handlebox ) [fuente] #

Devuelve el artista que genera este HandlerBase para el artista/identificador original proporcionado.

Parámetros :

leyendaLegend: La leyenda para la que se están creando estos artistas de leyenda.
orig_handle matplotlib.artist.Artisto similar: El objeto para el que se crean estos artistas de leyenda.
tamaño de fuente int: El tamaño de fuente en píxeles. Los artistas que se crean deben escalarse de acuerdo con el tamaño de fuente dado.
manillarmatplotlib.offsetbox.OffsetBox: La caja que ha sido creada para contener a los artistas de esta entrada de leyenda. Los artistas creados en el legend_artistmétodo deben agregarse a este cuadro de control dentro de este método.

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

clase matplotlib.legend_handler. HandlerCircleCollection ( yoffsets = Ninguno , tamaños = Ninguno , ** kwargs ) [fuente] #

Manejador para CircleCollections.

Parámetros :

numpuntos int: Número de puntos a mostrar en la entrada de la leyenda.
yoffsets matriz de flotadores: Longitud numpoints lista de compensaciones y para cada punto en la entrada de la leyenda.
**kwargs: Argumentos de palabras clave reenviados a HandlerNpoints.

create_collection ( orig_handle , tamaños , compensaciones , offset_transform ) [fuente] #

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

Manejador para barras de error.

Parámetros :

marcador_pad flotante: Relleno entre puntos en la entrada de la leyenda.
numpuntos int: Número de puntos a mostrar en la entrada de la leyenda.
**kwargs: Argumentos de palabras clave reenviados a HandlerBase.

create_artists ( leyenda , orig_handle , xdescent , ydescent , ancho , alto , tamaño de fuente , trans ) [fuente] #

get_err_size ( leyenda , xdescent , ydescent , ancho , alto , tamaño de fuente ) [fuente] #

clase matplotlib.legend_handler. HandlerLine2D ( marker_pad = 0.3 , numpoints = Ninguno , ** kwargs ) [fuente] #

Controlador de Line2Dinstancias.

Ver también

HandlerLine2DCompound: Una implementación de controlador anterior, que usaba un artista para la línea y otro para los marcadores.

Parámetros :

marcador_pad flotante: Relleno entre puntos en la entrada de la leyenda.
numpuntos int: Número de puntos a mostrar en la entrada de la leyenda.
**kwargs: Argumentos de palabras clave reenviados a HandlerBase.

create_artists ( leyenda , orig_handle , xdescent , ydescent , ancho , alto , tamaño de fuente , trans ) [fuente] #

clase matplotlib.legend_handler. HandlerLine2DCompound ( marker_pad = 0.3 , numpoints = Ninguno , ** kwargs ) [fuente] #

Controlador original para Line2Dinstancias, que se basa en combinar un artista de solo línea con un artista de solo marcador. Puede quedar obsoleto en el futuro.

Parámetros :

marcador_pad flotante: Relleno entre puntos en la entrada de la leyenda.
numpuntos int: Número de puntos a mostrar en la entrada de la leyenda.
**kwargs: Argumentos de palabras clave reenviados a HandlerBase.

create_artists ( leyenda , orig_handle , xdescent , ydescent , ancho , alto , tamaño de fuente , trans ) [fuente] #

clase matplotlib.legend_handler. HandlerLineCollection ( marker_pad = 0.3 , numpoints = Ninguno , ** kwargs ) [fuente] #

Controlador de LineCollectioninstancias.

Parámetros :

marcador_pad flotante: Relleno entre puntos en la entrada de la leyenda.
numpuntos int: Número de puntos a mostrar en la entrada de la leyenda.
**kwargs: Argumentos de palabras clave reenviados a HandlerBase.

create_artists ( leyenda , orig_handle , xdescent , ydescent , ancho , alto , tamaño de fuente , trans ) [fuente] #

get_numpoints ( leyenda ) [fuente] #

clase matplotlib.legend_handler. HandlerNpoints ( marker_pad = 0.3 , numpoints = Ninguno , ** kwargs ) [fuente] #

Un controlador de leyenda que muestra puntos numéricos en la entrada de la leyenda.

Parámetros :

marcador_pad flotante: Relleno entre puntos en la entrada de la leyenda.
numpuntos int: Número de puntos a mostrar en la entrada de la leyenda.
**kwargs: Argumentos de palabras clave reenviados a HandlerBase.

get_numpoints ( leyenda ) [fuente] #

get_xdata ( leyenda , xdescent , ydescent , ancho , alto , tamaño de fuente ) [fuente] #

clase matplotlib.legend_handler. HandlerNpointsYoffsets ( numpoints = Ninguno , yoffsets = Ninguno , ** kwargs ) [fuente] #

Un controlador de leyenda que muestra puntos numéricos en la leyenda y permite que se desplacen individualmente en la dirección y.

Parámetros :

numpuntos int: Número de puntos a mostrar en la entrada de la leyenda.
yoffsets matriz de flotadores: Longitud numpoints lista de compensaciones y para cada punto en la entrada de la leyenda.
**kwargs: Argumentos de palabras clave reenviados a HandlerNpoints.

get_ydata ( leyenda , xdescent , ydescent , ancho , alto , tamaño de fuente ) [fuente] #

clase matplotlib.legend_handler. HandlerPatch ( patch_func = Ninguno , ** kwargs ) [fuente] #

Controlador de Patchinstancias.

Parámetros :

patch_func invocable, opcional

La función que crea la leyenda artista clave. patch_func debe tener la firma:

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

Posteriormente, se llamará al artista creado update_prop y se aplicará la transformación adecuada.

**kwargs

Argumentos de palabras clave reenviados a HandlerBase.

create_artists ( leyenda , orig_handle , xdescent , ydescent , ancho , alto , tamaño de fuente , trans ) [fuente] #

clase matplotlib.legend_handler. HandlerPathCollection ( yoffsets = Ninguno , tamaños = Ninguno , ** kwargs ) [fuente] #

Controlador para PathCollections, que son utilizados por scatter.

Parámetros :

numpuntos int: Número de puntos a mostrar en la entrada de la leyenda.
yoffsets matriz de flotadores: Longitud numpoints lista de compensaciones y para cada punto en la entrada de la leyenda.
**kwargs: Argumentos de palabras clave reenviados a HandlerNpoints.

create_collection ( orig_handle , tamaños , compensaciones , offset_transform ) [fuente] #

clase matplotlib.legend_handler. HandlerPolyCollection ( xpad = 0.0 , ypad = 0.0 , update_func = Ninguno ) [fuente] #

Manejador para PolyCollectionusado en fill_betweeny stackplot.

create_artists ( leyenda , orig_handle , xdescent , ydescent , ancho , alto , tamaño de fuente , trans ) [fuente] #

clase matplotlib.legend_handler. HandlerRegularPolyCollection ( yoffsets = Ninguno , tamaños = Ninguno , ** kwargs ) [fuente] #

Manejador para RegularPolyCollections.

Parámetros :

numpuntos int: Número de puntos a mostrar en la entrada de la leyenda.
yoffsets matriz de flotadores: Longitud numpoints lista de compensaciones y para cada punto en la entrada de la leyenda.
**kwargs: Argumentos de palabras clave reenviados a HandlerNpoints.

create_artists ( leyenda , orig_handle , xdescent , ydescent , ancho , alto , tamaño de fuente , trans ) [fuente] #

create_collection ( orig_handle , tamaños , compensaciones , offset_transform ) [fuente] #

get_numpoints ( leyenda ) [fuente] #

get_sizes ( leyenda , orig_handle , xdescent , ydescent , ancho , alto , tamaño de fuente ) [fuente] #

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

clase matplotlib.legend_handler. HandlerStem ( marker_pad = 0.3 , numpoints = Ninguno , bottom = Ninguno , yoffsets = Ninguno , ** kwargs ) [fuente] #

Manejador para parcelas producidas por stem.

Parámetros :

marcador_pad flotante, por defecto: 0.3: Relleno entre puntos en la entrada de la leyenda.
numpuntos int, opcional: Número de puntos a mostrar en la entrada de la leyenda.
flotador inferior , opcional
yoffsets matriz de flotadores, opcional: Longitud numpoints lista de compensaciones y para cada punto en la entrada de la leyenda.
**kwargs: Argumentos de palabras clave reenviados a HandlerNpointsYoffsets.

create_artists ( leyenda , orig_handle , xdescent , ydescent , ancho , alto , tamaño de fuente , trans ) [fuente] #

get_ydata ( leyenda , xdescent , ydescent , ancho , alto , tamaño de fuente ) [fuente] #

clase matplotlib.legend_handler. HandlerStepPatch ( xpad = 0.0 , ypad = 0.0 , update_func = Ninguno ) [fuente] #

Controlador de StepPatchinstancias.

create_artists ( leyenda , orig_handle , xdescent , ydescent , ancho , alto , tamaño de fuente , trans ) [fuente] #

clase matplotlib.legend_handler. HandlerTuple ( ndivide = 1 , pad = Ninguno , ** kwargs ) [fuente] #

Manejador para Tuple.

Parámetros :

ndivide int, por defecto: 1: El número de secciones en las que dividir el área de la leyenda. Si es Ninguno, utilice la longitud de la tupla de entrada.
pad float, predeterminado: rcParams["legend.borderpad"](predeterminado: 0.4): Relleno en unidades de fracción del tamaño de fuente.
**kwargs: Argumentos de palabras clave reenviados a HandlerBase.

create_artists ( leyenda , orig_handle , xdescent , ydescent , ancho , alto , tamaño de fuente , trans ) [fuente] #

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

matplotlib.legend_handler#

`matplotlib.legend_handler`#