matplotlib.backend_managers#

clase matplotlib.backend_managers. ToolEvent ( nombre , remitente , herramienta , datos = Ninguno ) [fuente] #

Bases:object

Evento para manipulación de herramientas (añadir/quitar).

clase matplotlib.backend_managers. ToolManager ( figura = Ninguno ) [fuente] #

Bases:object

Administrador de acciones desencadenadas por interacciones del usuario (pulsación de teclas, clics en la barra de herramientas, ...) en una figura.

Atributos :
figureFigure

Figura que sujeta el lienzo.

bloqueo de teclasLockDraw

LockDrawobjeto para saber si canvaskey_press_event está bloqueado.

bloqueo de mensajeLockDraw

LockDrawobjeto para saber si el mensaje está disponible para escribir.

propiedad active_toggle #

Herramientas alternadas actualmente.

add_tool ( nombre , herramienta , * argumentos , ** kwargs ) [fuente] #

Agregar herramienta a ToolManager.

Si tiene éxito, agrega un nuevo evento tool_trigger_{name}donde {name}está el nombre de la herramienta; el evento se activa cada vez que se activa la herramienta.

Parámetros :
nombre str

El nombre de la herramienta, tratado como ID, tiene que ser único.

tipo de herramienta

Clase de la herramienta a añadir. En su lugar, se usará una subclase si se registró una para la clase de lienzo actual.

Ver también

matplotlib.backend_tools.ToolBase

La clase base para herramientas.

notas

args y kwargs se pasan directamente al constructor de herramientas.

lienzo de propiedad #

Lienzo gestionado por FigureManager.

figura de propiedad #

Figura que sujeta el lienzo.

get_tool ( nombre , advertir = Verdadero ) [fuente] #

Devuelve el objeto de la herramienta con el nombre dado.

Por conveniencia, esto pasa a través de objetos de herramientas.

Parámetros :
nombre str oToolBase

Nombre de la herramienta, o la propia herramienta.

advertir bool, predeterminado: Verdadero

Si se debe emitir una advertencia si no existe ninguna herramienta con el nombre dado.

Devoluciones :
ToolBaseo Ninguno

La herramienta o Ninguna si no existe ninguna herramienta con el nombre proporcionado.

get_tool_keymap ( nombre ) [fuente] #

Devuelve el mapa de teclas asociado con la herramienta especificada.

Parámetros :
nombre str

Nombre de la Herramienta.

Devoluciones :
lista de str

Lista de claves asociadas a la herramienta.

message_event ( mensaje , remitente = Ninguno ) [origen] #

Emite un ToolManagerMessageEvent.

remove_tool ( nombre ) [fuente] #

Eliminar la herramienta llamada nombre .

Parámetros :
nombre str

Nombre de la herramienta.

set_figure ( figura , update_tools = True ) [fuente] #

Vincule la figura dada a las herramientas.

Parámetros :
figuraFigure
update_tools booleano , predeterminado: Verdadero

Forzar herramientas para actualizar la figura.

toolmanager_connect ( s , func ) [fuente] #

Conecte el evento con la cadena s para func .

Parámetros :
calle s

El nombre del evento. Se reconocen los siguientes eventos:

  • 'tool_message_event'

  • 'tool_removed_event'

  • 'tool_added_event'

Por cada herramienta añadida se crea un nuevo evento

  • 'tool_trigger_TOOLNAME', donde TOOLNAME es el id de la herramienta.

función invocable

Función de devolución de llamada para el evento del administrador de herramientas con firma:

def func(event: ToolEvent) -> Any
Devoluciones :
cid

El ID de devolución de llamada para la conexión. Esto se puede usar en toolmanager_disconnect.

toolmanager_disconnect ( cid ) [fuente] #

Desconecte el id de devolución de llamada cid .

Ejemplo de uso:

cid = toolmanager.toolmanager_connect('tool_trigger_zoom', onpress)
#...later
toolmanager.toolmanager_disconnect(cid)
herramientas de propiedad #

Un nombre de herramienta de mapeo de dictado -> herramienta controlada.

trigger_tool ( nombre , remitente = Ninguno , evento de lienzo = Ninguno , datos = Ninguno ) [fuente] #

Dispare una herramienta y emita el tool_trigger_{name}evento.

Parámetros :
nombre str

Nombre de la herramienta.

objeto emisor

Objeto que desea activar la herramienta.

evento canvasevent

Evento de Canvas original o Ninguno.

objeto de datos

Datos adicionales para pasar a la herramienta al activar.

update_keymap ( nombre , clave ) [fuente] #

Configure el mapa de teclas para asociarlo con la herramienta especificada.

Parámetros :
nombre str

Nombre de la Herramienta.

clave str o lista de str

Claves para asociar a la herramienta.

clase matplotlib.backend_managers. ToolManagerMessageEvent ( nombre , remitente , mensaje ) [origen] #

Bases:object

Mensajes de transporte de eventos del administrador de herramientas.

Los mensajes generalmente se muestran al usuario en la barra de herramientas.

clase matplotlib.backend_managers. ToolTriggerEvent ( nombre , remitente , herramienta , canvasevent = Ninguno , datos = Ninguno ) [fuente] #

Bases:ToolEvent

Evento para informar que se ha disparado una herramienta.