`matplotlib.legend_handler`#

Manipuladores de legenda padrão.

Importante

Esta é uma API de legenda de baixo nível, que a maioria dos usuários finais não precisa.

Recomendamos que você esteja familiarizado com o guia de legendas antes de ler esta documentação.

Espera-se que os manipuladores de legenda sejam um objeto que pode ser chamado com uma assinatura a seguir.

legend_handler(legend, orig_handle, fontsize, handlebox)

Onde legend é a própria legenda, orig_handle é o gráfico original, fontsize é o tamanho da fonte em pixels e handlebox é uma instância de OffsetBox. Dentro da chamada, você deve criar artistas relevantes (usando propriedades relevantes da legenda e/ou orig_handle ) e adicioná-los ao handlebox. Os artistas precisam ser dimensionados de acordo com o tamanho da fonte (observe que o tamanho é em pixel, ou seja, esse é o valor dimensionado em dpi).

Este módulo inclui a definição de várias classes de manipulador de legendas derivadas da classe base (HandlerBase) com o seguinte método:

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

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

Uma classe base para manipuladores de legenda padrão.

As classes derivadas destinam-se a substituir o método create_artists , que possui a seguinte assinatura:

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

O método substituído precisa criar artistas da transformação fornecida que se encaixe na dimensão especificada (xdescent, ydescent, width, height) que são redimensionados pelo tamanho da fonte, se necessário.

Adjust_drawing_area ( lenda , orig_handle , xdescent , ydescent , largura , altura , tamanho da fonte ) [fonte] #

create_artists ( legend , orig_handle , xdescent , ydescent , largura , altura , fontsize , trans ) [fonte] #

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

Retorna o artista que este HandlerBase gera para o artista/identificador original fornecido.

Parâmetros :

lendaLegend: A lenda para a qual esses artistas lendários estão sendo criados.
orig_handle matplotlib.artist.Artistou similar: O objeto para o qual esses artistas lendários estão sendo criados.
tamanho da fonte int: O tamanho da fonte em pixels. Os artistas que estão sendo criados devem ser dimensionados de acordo com o tamanho da fonte fornecido.
alçamatplotlib.offsetbox.OffsetBox: A caixa que foi criada para conter os artistas desta lenda. Artistas criados no legend_artistmétodo devem ser adicionados a este handlebox dentro deste método.

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

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

Manipulador para CircleCollections.

Parâmetros :

numpoints int: Número de pontos a serem exibidos na entrada da legenda.
yoffsets array de floats: Lista de numpoints de comprimento de deslocamentos y para cada ponto na entrada da legenda.
** kwargs: Argumentos de palavra-chave encaminhados para HandlerNpoints.

create_collection ( orig_handle , tamanhos , deslocamentos , offset_transform ) [fonte] #

classe matplotlib.legend_handler. HandlerErrorbar ( xerr_size = 0,5 , yerr_size = Nenhum , marcador_pad = 0,3 , numpoints = Nenhum , ** kwargs ) [fonte] #

Manipulador para Errorbars.

Parâmetros :

marcador_pad flutuante: Preenchimento entre pontos na entrada da legenda.
numpoints int: Número de pontos a serem exibidos na entrada da legenda.
** kwargs: Argumentos de palavra-chave encaminhados para HandlerBase.

create_artists ( legend , orig_handle , xdescent , ydescent , largura , altura , fontsize , trans ) [fonte] #

get_err_size ( lenda , xdescente , ydescente , largura , altura , tamanho da fonte ) [fonte] #

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

Manipulador para Line2Dinstâncias.

Veja também

HandlerLine2DCompound: Uma implementação de manipulador anterior, que usava um artista para a linha e outro para o(s) marcador(es).

Parâmetros :

marcador_pad flutuante: Preenchimento entre pontos na entrada da legenda.
numpoints int: Número de pontos a serem exibidos na entrada da legenda.
** kwargs: Argumentos de palavra-chave encaminhados para HandlerBase.

create_artists ( legend , orig_handle , xdescent , ydescent , largura , altura , fontsize , trans ) [fonte] #

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

Manipulador original para Line2Dinstâncias, que depende da combinação de um artista somente de linha com um artista somente de marcador. Pode ser obsoleto no futuro.

Parâmetros :

marcador_pad flutuante: Preenchimento entre pontos na entrada da legenda.
numpoints int: Número de pontos a serem exibidos na entrada da legenda.
** kwargs: Argumentos de palavra-chave encaminhados para HandlerBase.

create_artists ( legend , orig_handle , xdescent , ydescent , largura , altura , fontsize , trans ) [fonte] #

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

Manipulador para LineCollectioninstâncias.

Parâmetros :

marcador_pad flutuante: Preenchimento entre pontos na entrada da legenda.
numpoints int: Número de pontos a serem exibidos na entrada da legenda.
** kwargs: Argumentos de palavra-chave encaminhados para HandlerBase.

create_artists ( legend , orig_handle , xdescent , ydescent , largura , altura , fontsize , trans ) [fonte] #

get_numpoints ( legenda ) [fonte] #

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

Um manipulador de legenda que mostra pontos numpoints na entrada da legenda.

Parâmetros :

marcador_pad flutuante: Preenchimento entre pontos na entrada da legenda.
numpoints int: Número de pontos a serem exibidos na entrada da legenda.
** kwargs: Argumentos de palavra-chave encaminhados para HandlerBase.

get_numpoints ( legenda ) [fonte] #

get_xdata ( lenda , xdescente , ydescente , largura , altura , tamanho da fonte ) [fonte] #

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

Um manipulador de legenda que mostra numpoints na legenda e permite que eles sejam deslocados individualmente na direção y.

Parâmetros :

numpoints int: Número de pontos a serem exibidos na entrada da legenda.
yoffsets array de floats: Lista de numpoints de comprimento de deslocamentos y para cada ponto na entrada da legenda.
** kwargs: Argumentos de palavra-chave encaminhados para HandlerNpoints.

get_ydata ( lenda , xdescente , ydescente , largura , altura , tamanho da fonte ) [fonte] #

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

Manipulador para Patchinstâncias.

Parâmetros :

patch_func chamável, opcional

A função que cria o artista de chave de legenda. patch_func deve ter a assinatura:

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

Posteriormente o artista criado terá seu update_prop método chamado e a transformação apropriada será aplicada.

** kwargs

Argumentos de palavra-chave encaminhados para HandlerBase.

create_artists ( legend , orig_handle , xdescent , ydescent , largura , altura , fontsize , trans ) [fonte] #

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

Manipulador para PathCollections, que são usados por scatter.

Parâmetros :

numpoints int: Número de pontos a serem exibidos na entrada da legenda.
yoffsets array de floats: Lista de numpoints de comprimento de deslocamentos y para cada ponto na entrada da legenda.
** kwargs: Argumentos de palavra-chave encaminhados para HandlerNpoints.

create_collection ( orig_handle , tamanhos , deslocamentos , offset_transform ) [fonte] #

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

Manipulador para PolyCollectionusado em fill_betweene stackplot.

create_artists ( legend , orig_handle , xdescent , ydescent , largura , altura , fontsize , trans ) [fonte] #

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

Manipulador para RegularPolyCollections.

Parâmetros :

numpoints int: Número de pontos a serem exibidos na entrada da legenda.
yoffsets array de floats: Lista de numpoints de comprimento de deslocamentos y para cada ponto na entrada da legenda.
** kwargs: Argumentos de palavra-chave encaminhados para HandlerNpoints.

create_artists ( legend , orig_handle , xdescent , ydescent , largura , altura , fontsize , trans ) [fonte] #

create_collection ( orig_handle , tamanhos , deslocamentos , offset_transform ) [fonte] #

get_numpoints ( legenda ) [fonte] #

get_sizes ( lenda , orig_handle , xdescent , ydescent , largura , altura , fontsize ) [fonte] #

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

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

Manipulador para gráficos produzidos por stem.

Parâmetros :

marcador_pad flutuante, padrão: 0,3: Preenchimento entre pontos na entrada da legenda.
numpoints int, opcional: Número de pontos a serem exibidos na entrada da legenda.
flutuador inferior , opcional
yoffsets array de floats, opcional: Lista de numpoints de comprimento de deslocamentos y para cada ponto na entrada da legenda.
** kwargs: Argumentos de palavra-chave encaminhados para HandlerNpointsYoffsets.

create_artists ( legend , orig_handle , xdescent , ydescent , largura , altura , fontsize , trans ) [fonte] #

get_ydata ( lenda , xdescente , ydescente , largura , altura , tamanho da fonte ) [fonte] #

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

Manipulador para StepPatchinstâncias.

create_artists ( legend , orig_handle , xdescent , ydescent , largura , altura , fontsize , trans ) [fonte] #

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

Manipulador para Tuple.

Parâmetros :

divide int, padrão: 1: O número de seções nas quais dividir a área da legenda. Se Nenhum, use o comprimento da tupla de entrada.
pad float, padrão: rcParams["legend.borderpad"](padrão: 0.4): Preenchimento em unidades de fração do tamanho da fonte.
** kwargs: Argumentos de palavra-chave encaminhados para HandlerBase.

create_artists ( legend , orig_handle , xdescent , ydescent , largura , altura , fontsize , trans ) [fonte] #

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

matplotlib.legend_handler#

`matplotlib.legend_handler`#