matplotlib事件处理基础(事件绑定、事件属性)

谈到用户界面交互总少不了事件，前面一系列文章介绍的鼠标光标、坐标、弹出式提示框等实现的底层其实都是事件处理，只不过matplotlib或其他包做了封装以便于应用。

matplotlib的事件处理模型基于GTK，matplotlib支持与wxpython、 tkinter、 qt、gtk等常见GUI后端的交互。

事件绑定

matplotlib的事件绑定有三个要素：

• canvas对象
• 事件名称
• 回调函数

matplotlib的事件绑定由canvas对象调用mpl_connect方法实现，mpl_connect方法有两个参数：事件名称、回调函数。即canvas对象.mpl_connect(事件名称，回调函数)

mpl_connect方法又称为事件管理器，它是FigureCanvasBase类的方法。FigureCanvasBase类属于matplotlib.backend_bases模块，作用是隔离绘图和后端底层，这样绘图时就不用考虑各个后端之间的差异。

canvas原意画布，figure原意图像，可以这样理解，figure是一切可见绘图元素的集合，而canvas是figure的容器，canvas的事件的响应、处理都是基于canvas的。

下面通过一个案例来简单说明事件绑定的应用。

import matplotlib.pyplot as plt

fig, ax = plt.subplots()
ax.plot([1,1])

def onclick(event):
  print('%s click: button=%d, x=%d, y=%d, xdata=%f, ydata=%f' %
     ('double' if event.dblclick else 'single', event.button,
      event.x, event.y, event.xdata, event.ydata))

cid = fig.canvas.mpl_connect('button_press_event', onclick)

plt.show()

运行后，在图像界面上单击鼠标，控制台会出现如下输出。

single click: button=1, x=123, y=80, xdata=0.222531, ydata=0.960511

在本案例中，fig为figure对象，fig的canvas属性可以返回当前图像所在的canvas对象，然后再调用mpl_connect方法，'button_press_event'为鼠标左键单击事件，onclick为回调函数。

事件

matplotlib中用到的事件类都继承自matplotlib.backend_bases.Event，主要事件如下表所示。

事件名称 类 描述 ‘button_press_event' MouseEvent 鼠标按键被按下 ‘button_release_event' MouseEvent 鼠标按键被释放 ‘draw_event' DrawEvent 画布绘图 ‘key_press_event' KeyEvent 键盘按键被按下 ‘key_release_event' KeyEvent 键盘按键被释放 ‘motion_notify_event' MouseEvent 鼠标移动 ‘pick_event' PickEvent 画布中的对象被选中 ‘resize_event' ResizeEvent 图形画布大小改变 ‘scroll_event' MouseEvent 鼠标滚轮被滚动 ‘figure_enter_event' LocationEvent 鼠标进入新的图形 ‘figure_leave_event' LocationEvent 鼠标离开图形 ‘axes_enter_event' LocationEvent 鼠标进入新的轴域 ‘axes_leave_event' LocationEvent 鼠标离开轴域

事件属性

因为matplotlib中用到的事件类都继承自matplotlib.backend_bases.Event，所以所有事件都拥有以下3个共同属性。
name：事件名称。
canvas：生成事件的canvas对象。
guiEvent：触发matplotlib事件的GUI事件，默认为None。
所有事件均定义在matplotlib.backend_bases模块中，其中常用的鼠标事件MouseEvent、键盘事件KeyEvent都继承自LocationEvent事件。LocationEvent事件有5个属性。

• x：x 位置，距离画布左端的像素数
• y：y 位置，距离画布底端的像素数
• inaxes：是否处于坐标系中，是则为鼠标所处于的子图实例，否则为None
• xdata：鼠标的x坐标
• ydata：鼠标的y坐标

键盘事件KeyEvent除继承自LocationEvent事件的5个属性外，还有1个key属性，表示按下的键，值范围为：None、任何字符、'shift'、win或者control。
鼠标事件MouseEvent 除继承自LocationEvent事件的5个属性外，还有以下属性

• key：表示鼠标事件触发时按下的键，值范围同键盘事件KeyEvent中的key属性。
• button：表示按下的鼠标按钮，值范围为：None、1、2、3、up、down（up、down用于滚动事件）。
• dblclick：表示是否双击，布尔值。

鼠标事件案例

鼠标点击画线，将鼠标点击相邻两点用直线连接，起始点为0,0。

from matplotlib import pyplot as plt

class LineBuilder:
  def __init__(self, line):
    self.line = line
    self.xs = list(line.get_xdata())
    self.ys = list(line.get_ydata())
    self.cid = line.figure.canvas.mpl_connect('button_press_event', self)

  def __call__(self, event):
    print('click', event)
    if event.inaxes!=self.line.axes: return
    self.xs.append(event.xdata)
    self.ys.append(event.ydata)
    self.line.set_data(self.xs, self.ys)
    self.line.figure.canvas.draw()

fig = plt.figure()
ax = fig.add_subplot(111)
ax.set_title('click to build line segments')
line, = ax.plot([0], [0]) # empty line
linebuilder = LineBuilder(line)

plt.show()