matplotlib.backend_tools

Classes base abstratas definem as primitivas para Ferramentas. Essas ferramentas são usadas pormatplotlib.backend_managers.ToolManager

ToolBase

Ferramenta sem estado simples

ToolToggleBase

Ferramenta que possui dois estados, apenas uma ferramenta Alternar pode estar ativa a qualquer momento para o mesmo matplotlib.backend_managers.ToolManager

classe matplotlib.backend_tools. AxisScaleBase ( * args , ** kwargs )

Bases:ToolToggleBase

Base Ferramenta para alternar entre linear e logarítmica.

desativar ( evento = Nenhum )

Desative a ferramenta de alternância.

triggerchame este método quando toggledfor True.

Isso pode acontecer em diferentes circunstâncias.

• Clique no botão da ferramenta da barra de ferramentas.

• Ligue para matplotlib.backend_managers.ToolManager.trigger_tool.

• Outra ToolToggleBaseferramenta derivada é acionada (do mesmo ToolManager).

habilitar ( evento = Nenhum )

Ative a ferramenta de alternância.

triggerchama esse método quando toggledé False.

gatilho ( remetente , evento , dados = Nenhum )

Chamadas enableou disablecom base no toggledvalor.

classe matplotlib.backend_tools. ConfigureSubplotsBase ( toolmanager , nome )

Bases:ToolBase

Ferramenta base para a configuração de subparcelas.

descrição = 'Configurar subtramas'

Descrição da Ferramenta.

str: dica de ferramenta usada se a ferramenta estiver incluída em uma barra de ferramentas.

imagem = 'subtramas'

Nome do arquivo da imagem.

str: Nome do arquivo da imagem a ser usada em uma barra de ferramentas. Se Nenhum, o nome é usado como um rótulo no botão da barra de ferramentas.

classe matplotlib.backend_tools. Cursores ( valor )

Bases:IntEnum

Tipos de cursor independentes de back-end.

MÃO = 2

MOVE = 4

PONTEIRO = 1

RESIZE_HORIZONTAL = 6

RESIZE_VERTICAL = 7

SELECT_REGION = 3

ESPERA = 5

classe matplotlib.backend_tools. RubberbandBase ( gerenciador de ferramentas , nome )

Bases:ToolBase

Desenhe e remova um elástico.

draw_rubberband ( * dados )

Desenhe elástico.

Este método deve ser implementado por back-end.

remove_rubberband ( )

Remova o elástico.

Este método deve ser implementado por back-end.

gatilho ( remetente , evento , dados = Nenhum )

Chamada draw_rubberbandou remove_rubberbandcom base em dados.

classe matplotlib.backend_tools. SaveFigureBase ( gerenciador de ferramentas , nome )

Bases:ToolBase

Ferramenta básica para salvar figuras.

propriedade default_keymap

descrição = 'Salvar a figura'

Descrição da Ferramenta.

str: dica de ferramenta usada se a ferramenta estiver incluída em uma barra de ferramentas.

imagem = 'salvar arquivo'

Nome do arquivo da imagem.

str: Nome do arquivo da imagem a ser usada em uma barra de ferramentas. Se Nenhum, o nome é usado como um rótulo no botão da barra de ferramentas.

classe matplotlib.backend_tools. SetCursorBase ( * args , ** kwargs )

Bases:ToolBase

Mude para o cursor atual enquanto estiver em eixos.

Essa ferramenta rastreia todas as ToolToggleBaseferramentas derivadas e chama set_cursorquando uma ferramenta é acionada.

set_cursor ( cursor )

[ Obsoleto ] Defina o cursor.

Notas

Obsoleto desde a versão 3.5: Use FigureCanvasBase.set_cursorem seu lugar.

set_figure ( figura )

classe matplotlib.backend_tools. ToolBack ( toolmanager , nome )

Bases:ViewsPositionsBase

Volte para cima na pilha de limites de visualização.

propriedade default_keymap

descrição = 'Voltar à visualização anterior '

Descrição da Ferramenta.

str: dica de ferramenta usada se a ferramenta estiver incluída em uma barra de ferramentas.

imagem = 'voltar'

Nome do arquivo da imagem.

str: Nome do arquivo da imagem a ser usada em uma barra de ferramentas. Se Nenhum, o nome é usado como um rótulo no botão da barra de ferramentas.

classe matplotlib.backend_tools. ToolBase ( toolmanager , nome )

Bases:object

Classe de ferramenta base.

Uma ferramenta base, implementa apenas triggermétodo ou nenhum método. A ferramenta é instanciada por matplotlib.backend_managers.ToolManager.

tela de propriedade

A tela da figura afetada por esta ferramenta ou Nenhum.

default_keymap = Nenhum

Mapa de teclas para associar a esta ferramenta.

list[str]: Lista de teclas que acionarão esta ferramenta quando um evento de pressionamento de tecla for emitido em self.figure.canvas. Observe que esse atributo é pesquisado na instância e, portanto, pode ser uma propriedade (usada, por exemplo, pelas ferramentas integradas para carregar o rcParams no momento da instanciação).

descrição = Nenhum

Descrição da Ferramenta.

str: dica de ferramenta usada se a ferramenta estiver incluída em uma barra de ferramentas.

destruir ( )

[ Descontinuado ] Destrua a ferramenta.

Este método é chamado por ToolManager.remove_tool.

Notas

Obsoleto desde a versão 3.6: em vez disso, use tool_removed_event.

figura da propriedade

A Figura afetada por esta ferramenta ou Nenhuma.

imagem = Nenhum

Nome do arquivo da imagem.

str: Nome do arquivo da imagem a ser usada em uma barra de ferramentas. Se Nenhum, o nome é usado como um rótulo no botão da barra de ferramentas.

nome da propriedade

O ID da ferramenta (str, deve ser único entre as ferramentas de um gerenciador de ferramentas).

set_figure ( figura )

gerenciador de ferramentas de propriedade

O ToolManagerque controla esta ferramenta.

gatilho ( remetente , evento , dados = Nenhum )

Chamado quando esta ferramenta é usada.

Este método é chamado por ToolManager.trigger_tool.

Parâmetros :

eventoEvent

O evento de tela que fez com que essa ferramenta fosse chamada.

objeto remetente

Objeto que solicitou o acionamento da ferramenta.

objeto de dados

Dados extras.

classe matplotlib.backend_tools. ToolCopyToClipboardBase ( toolmanager , nome )

Bases:ToolBase

Ferramenta para copiar a figura para a área de transferência.

propriedade default_keymap

description = 'Copiar a figura da tela para a área de transferência'

Descrição da Ferramenta.

str: dica de ferramenta usada se a ferramenta estiver incluída em uma barra de ferramentas.

gatilho ( * args , ** kwargs )

Chamado quando esta ferramenta é usada.

Este método é chamado por ToolManager.trigger_tool.

Parâmetros :

eventoEvent

O evento de tela que fez com que essa ferramenta fosse chamada.

objeto remetente

Objeto que solicitou o acionamento da ferramenta.

objeto de dados

Dados extras.

classe matplotlib.backend_tools. ToolCursorPosition ( * args , ** kwargs )

Bases:ToolBase

Envia mensagem com a posição atual do ponteiro.

Esta ferramenta é executada em segundo plano relatando a posição do cursor.

send_message ( evento )

Ligue matplotlib.backend_managers.ToolManager.message_event.

set_figure ( figura )

classe matplotlib.backend_tools. ToolForward ( gerenciador de ferramentas , nome )

Bases:ViewsPositionsBase

Avance na pilha de lim de visualização.

propriedade default_keymap

descrição = 'Avançar para a próxima visualização'

Descrição da Ferramenta.

str: dica de ferramenta usada se a ferramenta estiver incluída em uma barra de ferramentas.

imagem = 'encaminhar'

Nome do arquivo da imagem.

str: Nome do arquivo da imagem a ser usada em uma barra de ferramentas. Se Nenhum, o nome é usado como um rótulo no botão da barra de ferramentas.

classe matplotlib.backend_tools. ToolFullScreen ( toolmanager , nome )

Bases:ToolBase

Ferramenta para alternar tela cheia.

propriedade default_keymap

description = 'Alternar modo de tela cheia'

Descrição da Ferramenta.

str: dica de ferramenta usada se a ferramenta estiver incluída em uma barra de ferramentas.

gatilho ( remetente , evento , dados = Nenhum )

Chamado quando esta ferramenta é usada.

Este método é chamado por ToolManager.trigger_tool.

Parâmetros :

eventoEvent

O evento de tela que fez com que essa ferramenta fosse chamada.

objeto remetente

Objeto que solicitou o acionamento da ferramenta.

objeto de dados

Dados extras.

classe matplotlib.backend_tools. ToolGrid ( gerenciador de ferramentas , nome )

Bases:ToolBase

Ferramenta para alternar as grades principais da figura.

propriedade default_keymap

descrição = 'Alternar grades principais

Descrição da Ferramenta.

str: dica de ferramenta usada se a ferramenta estiver incluída em uma barra de ferramentas.

gatilho ( remetente , evento , dados = Nenhum )

Chamado quando esta ferramenta é usada.

Este método é chamado por ToolManager.trigger_tool.

Parâmetros :

eventoEvent

O evento de tela que fez com que essa ferramenta fosse chamada.

objeto remetente

Objeto que solicitou o acionamento da ferramenta.

objeto de dados

Dados extras.

classe matplotlib.backend_tools. ToolHelpBase ( gerenciador de ferramentas , nome )

Bases:ToolBase

propriedade default_keymap

description = 'Imprimir lista de ferramentas , atalhos e descrição'

Descrição da Ferramenta.

str: dica de ferramenta usada se a ferramenta estiver incluída em uma barra de ferramentas.

static format_shortcut ( key_sequence )

Converta uma string de atalho da notação usada em rc config para a notação padrão para exibição de atalhos, por exemplo, 'ctrl+a' -> 'Ctrl+A'.

imagem = 'ajuda'

Nome do arquivo da imagem.

str: Nome do arquivo da imagem a ser usada em uma barra de ferramentas. Se Nenhum, o nome é usado como um rótulo no botão da barra de ferramentas.

classe matplotlib.backend_tools. ToolHome ( gerenciador de ferramentas , nome )

Bases:ViewsPositionsBase

Restaure os limites de visualização originais.

propriedade default_keymap

descrição = 'Redefinir exibição original '

Descrição da Ferramenta.

str: dica de ferramenta usada se a ferramenta estiver incluída em uma barra de ferramentas.

imagem = 'casa'

Nome do arquivo da imagem.

str: Nome do arquivo da imagem a ser usada em uma barra de ferramentas. Se Nenhum, o nome é usado como um rótulo no botão da barra de ferramentas.

classe matplotlib.backend_tools. ToolMinorGrid ( gerenciador de ferramentas , nome )

Bases:ToolBase

Ferramenta para alternar as grades principais e secundárias da figura.

propriedade default_keymap

description = 'Alternar grades principais e secundárias

Descrição da Ferramenta.

str: dica de ferramenta usada se a ferramenta estiver incluída em uma barra de ferramentas.

gatilho ( remetente , evento , dados = Nenhum )

Chamado quando esta ferramenta é usada.

Este método é chamado por ToolManager.trigger_tool.

Parâmetros :

eventoEvent

O evento de tela que fez com que essa ferramenta fosse chamada.

objeto remetente

Objeto que solicitou o acionamento da ferramenta.

objeto de dados

Dados extras.

classe matplotlib.backend_tools. ToolPan ( * args )

Bases:ZoomPanBase

Eixos panorâmicos com o botão esquerdo do mouse, zoom com o botão direito.

cursor = 4

Cursor para usar quando a ferramenta estiver ativa.

propriedade default_keymap

description = 'Pan eixos com o botão esquerdo do mouse, zoom com o botão direito'

Descrição da Ferramenta.

str: dica de ferramenta usada se a ferramenta estiver incluída em uma barra de ferramentas.

imagem = 'mover'

Nome do arquivo da imagem.

str: Nome do arquivo da imagem a ser usada em uma barra de ferramentas. Se Nenhum, o nome é usado como um rótulo no botão da barra de ferramentas.

radio_group = 'padrão'

Atributo para agrupar 'rádio' como ferramentas (mutuamente exclusivas).

strque identifica o grupo ou None se não pertencer a um grupo.

classe matplotlib.backend_tools. ToolQuit ( gerenciador de ferramentas , nome )

Bases:ToolBase

Ferramenta para chamar o método de destruição do gerenciador de figuras.

propriedade default_keymap

descrição = 'Sair da figura'

Descrição da Ferramenta.

str: dica de ferramenta usada se a ferramenta estiver incluída em uma barra de ferramentas.

gatilho ( remetente , evento , dados = Nenhum )

Chamado quando esta ferramenta é usada.

Este método é chamado por ToolManager.trigger_tool.

Parâmetros :

eventoEvent

O evento de tela que fez com que essa ferramenta fosse chamada.

objeto remetente

Objeto que solicitou o acionamento da ferramenta.

objeto de dados

Dados extras.

classe matplotlib.backend_tools. ToolQuitAll ( gerenciador de ferramentas , nome )

Bases:ToolBase

Ferramenta para chamar o método de destruição do gerenciador de figuras.

propriedade default_keymap

descrição = 'Sair de todas as figuras'

Descrição da Ferramenta.

str: dica de ferramenta usada se a ferramenta estiver incluída em uma barra de ferramentas.

gatilho ( remetente , evento , dados = Nenhum )

Chamado quando esta ferramenta é usada.

Este método é chamado por ToolManager.trigger_tool.

Parâmetros :

eventoEvent

O evento de tela que fez com que essa ferramenta fosse chamada.

objeto remetente

Objeto que solicitou o acionamento da ferramenta.

objeto de dados

Dados extras.

matplotlib.backend_tools. ToolSetCursor

pseudônimo deSetCursorBase

classe matplotlib.backend_tools. ToolToggleBase ( * args , ** kwargs )

Bases:ToolBase

Ferramenta alternável.

Sempre que é acionado, ele alterna entre habilitar e desabilitar.

Parâmetros :

``*args``

Argumento de comprimento variável a ser usado pela ferramenta.

``**kwargs``

toggledse presente e verdadeiro, define o estado inicial da ferramenta Argumentos de palavra-chave arbitrários a serem consumidos pela ferramenta

cursor = Nenhum

Cursor para usar quando a ferramenta estiver ativa.

default_toggled = Falso

Padrão de estado alternado.

desativar ( evento = Nenhum )

Desative a ferramenta de alternância.

triggerchame este método quando toggledfor True.

Isso pode acontecer em diferentes circunstâncias.

• Clique no botão da ferramenta da barra de ferramentas.

• Ligue para matplotlib.backend_managers.ToolManager.trigger_tool.

• Outra ToolToggleBaseferramenta derivada é acionada (do mesmo ToolManager).

habilitar ( evento = Nenhum )

Ative a ferramenta de alternância.

triggerchama esse método quando toggledé False.

radio_group = Nenhum

Atributo para agrupar 'rádio' como ferramentas (mutuamente exclusivas).

strque identifica o grupo ou None se não pertencer a um grupo.

set_figure ( figura )

propriedade alternada

Estado da ferramenta alternada.

gatilho ( remetente , evento , dados = Nenhum )

Chamadas enableou disablecom base no toggledvalor.

classe matplotlib.backend_tools. ToolViewsPositions ( * args , ** kwargs )

Bases:ToolBase

Ferramenta auxiliar para lidar com alterações em visualizações e posições.

Funciona em segundo plano e deve ser usado por todas as ferramentas que precisam acessar o histórico de visualizações e posições da figura, por exemplo

• ToolZoom

• ToolPan

• ToolHome

• ToolBack

• ToolForward

add_figure ( figura )

Adicione a figura atual à pilha de visualizações e posições.

voltar ( )

Volte um passo na pilha de exibições e posições.

claro ( figura )

Redefina a pilha de eixos.

encaminhar ( )

Avance um passo na pilha de visualizações e posições.

casa ( )

Recupere a primeira visualização e posição da pilha.

push_current ( figura = Nenhum )

Empurre os limites de exibição atuais e posicione-os em suas respectivas pilhas.

update_home_views ( figure = None )

Certifique-se de que self.home_viewshaja uma entrada para todos os eixos presentes na figura.

update_view ( )

Atualize os limites de visualização e a posição de cada eixo a partir da posição atual da pilha. Se algum eixo estiver presente na figura que não esteja na posição atual da pilha, use os limites da visualização inicial para esses eixos e não atualize nenhuma posição.

classe matplotlib.backend_tools. ToolXScale ( * args , ** kwargs )

Bases:AxisScaleBase

Ferramenta para alternar entre as escalas linear e logarítmica no eixo X.

propriedade default_keymap

descrição = 'Alternar escala do eixo X

Descrição da Ferramenta.

str: dica de ferramenta usada se a ferramenta estiver incluída em uma barra de ferramentas.

set_scale ( machado , escala )

classe matplotlib.backend_tools. ToolYScale ( * args , ** kwargs )

Bases:AxisScaleBase

Ferramenta para alternar entre as escalas linear e logarítmica no eixo Y.

propriedade default_keymap

descrição = 'Alternar escala do eixo Y

Descrição da Ferramenta.

str: dica de ferramenta usada se a ferramenta estiver incluída em uma barra de ferramentas.

set_scale ( machado , escala )

classe matplotlib.backend_tools. ToolZoom ( * args )

Bases:ZoomPanBase

Uma ferramenta para zoom usando um seletor de retângulo.

cursor = 3

Cursor para usar quando a ferramenta estiver ativa.

propriedade default_keymap

descrição = 'Zoom para retângulo'

Descrição da Ferramenta.

str: dica de ferramenta usada se a ferramenta estiver incluída em uma barra de ferramentas.

imagem = 'zoom_to_rect'

Nome do arquivo da imagem.

str: Nome do arquivo da imagem a ser usada em uma barra de ferramentas. Se Nenhum, o nome é usado como um rótulo no botão da barra de ferramentas.

radio_group = 'padrão'

Atributo para agrupar 'rádio' como ferramentas (mutuamente exclusivas).

strque identifica o grupo ou None se não pertencer a um grupo.

classe matplotlib.backend_tools. ViewsPositionsBase ( toolmanager , nome )

Bases:ToolBase

Classe base para ToolHome, ToolBacke ToolForward.

gatilho ( remetente , evento , dados = Nenhum )

Chamado quando esta ferramenta é usada.

Este método é chamado por ToolManager.trigger_tool.

Parâmetros :

eventoEvent

O evento de tela que fez com que essa ferramenta fosse chamada.

objeto remetente

Objeto que solicitou o acionamento da ferramenta.

objeto de dados

Dados extras.

classe matplotlib.backend_tools. ZoomPanBase ( * args )

Bases:ToolToggleBase

Classe base para ToolZoome ToolPan.

desativar ( evento = Nenhum )

Solte a tela e desconecte os eventos de imprensa/liberação.

habilitar ( evento = Nenhum )

Conecte eventos de imprensa/lançamento e bloqueie a tela.

scroll_zoom ( evento )

gatilho ( remetente , evento , dados = Nenhum )

Chamadas enableou disablecom base no toggledvalor.

matplotlib.backend_tools. add_tools_to_container ( container , tools = [['navigation', ['home', 'back', 'forward']], ['zoompan', ['pan', 'zoom', 'subplots']], ['io ', ['salvar', 'ajuda']]] )

Adicione várias ferramentas ao contêiner.

Parâmetros :

recipiente recipiente

backend_bases.ToolContainerBaseobjeto que receberá as ferramentas adicionadas.

lista de ferramentas , opcional

Liste no formulário onde as ferramentas serão exibidas no grupo1. Consulte para obter detalhes.[[group1, [tool1, tool2 ...]], [group2, [...]]][tool1, tool2, ...]backend_bases.ToolContainerBase.add_tool

matplotlib.backend_tools. add_tools_to_manager ( toolmanager , tools={'back': <class 'matplotlib.backend_tools.ToolBack'> , 'copy': <class 'matplotlib.backend_tools.ToolCopyToClipboardBase'> , 'cursor': <class 'matplotlib.backend_tools.SetCursorBase' > , 'forward': <class 'matplotlib.backend_tools.ToolForward'> , 'fullscreen': <class 'matplotlib.backend_tools.ToolFullScreen'> , 'grid': <class 'matplotlib.backend_tools.ToolGrid' 'matplotlib.backend_tools.ToolMinorGrid'> , 'help': <class 'matplotlib.backend_tools.ToolHelpBase'> , 'home': <class 'matplotlib.backend_tools.ToolHome'> , 'pan': <class 'matplotlib.backend_tools. ToolPan'> , 'position': <class 'matplotlib.backend_tools.ToolCursorPosition'> , 'quit': <class 'matplotlib.backend_tools.ToolQuit'> , 'quit_all': <class 'matplotlib.backend_tools.ToolQuitAll'> , ' elástico de borracha': <class 'matplotlib.backend_tools.RubberbandBase'> , 'salvar': <class 'matplotlib.backend_tools.SaveFigureBase'> , ' subplots': < class ' matplotlib.backend_tools.ConfigureSubplotsBase'> , 'viewpos': <class 'matplotlib.backend_tools.ToolViewsPositions'> , 'xscale': <class 'matplotlib. backend_tools.ToolXScale'> , 'yscale': <class 'matplotlib.backend_tools.ToolYScale'> , 'zoom': <class 'matplotlib.backend_tools.ToolZoom'>} )

Adicione várias ferramentas a um arquivo ToolManager.

Parâmetros :

gerente de ferramentasbackend_managers.ToolManager

Gerenciador ao qual as ferramentas são adicionadas.

ferramentas {str: class_like}, opcional

As ferramentas para adicionar em um dict {name: tool}, veja backend_managers.ToolManager.add_toolpara mais informações.

matplotlib.backend_tools. cursores

pseudônimo deCursors