Python中的 Matplotlib.axis.Axis.format_cursor_data()函数

简介

Matplotlib.axis.Axis.format_cursor_data()函数是一个可以使用的函数，它允许用户自定义光标位置处的数据格式。

光标通常是当用户将鼠标悬停在图表中的某个位置时，在图表上显示该位置的数据。

format_cursor_data()函数以光标位置的数据为参数并返回格式化字符串。

语法

def format_cursor_data(data):

光标数据的类型取决于所使用的工具包和功能。例如，如果光标是在 matplotlib 中使用的，则数据是一个包含 x 和 y 值的元组 (x, y)。类似地，如果您使用的是 pandas，光标数据将是一行或一个数据点的所有列名称和值的字典。

参数

data：元组或字典，取决于所使用的工具包和功能。光标数据允许 format_cursor_data() 函数知道如何解释光标。

返回值

一个格式化的字符串，光标数据位于该字符串的参数中。

使用示例

使用 Matplotlib 绘制一个简单的折线图，并且当您在图表上悬停鼠标时，会在底部的工具栏中看到当前光标位置的 x 和 y 值。在这种情况下，使用下面的代码，您可以将格式化的字符串添加到“NavigationToolbar2”的“update()”方法中。

import matplotlib.pyplot as plt

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

def on_hover(event):
    if event.inaxes is not None:
        x, y = event.xdata, event.ydata
        fig.canvas.toolbar.set_message(f'x={x:,.2f}, y={y:,.2f}')

fig.canvas.mpl_connect('motion_notify_event', on_hover)
plt.show()

要自定义光标位置处的数据格式，请传递一个格式字符串。例如，要格式化光标数据的方案是省略 y 值，使用下面的代码将 x 值格式化为整数。

from typing import Tuple
import matplotlib.axis as maxis
import matplotlib.transforms as mtransforms

class CustomFormatter(maxis.Formatter):
    def __call__(self, x: float, pos: float) -> str:
        return f'x = {x:.0f}'
 
    def format_cursor_data(self, data: Tuple[float, float]) ->str:
        x, y = data
        return f'x = {x:.0f}'

fig, ax = plt.subplots()
line, = ax.plot([1, 2, 3], [1, 2, 3])
ax.xaxis.set_major_formatter(CustomFormatter())

fig.canvas.toolbar.update()

plt.show()

在这个例子中，“x”会显示为没有小数点和数字分组格式的整数。

结论

通过使用 Matplotlib.axis.Axis.format_cursor_data()函数，我们可以自定义光标位置的数据格式；例如，在 Matplotlib 的 plots 上，在底部的工具栏中显示当前光标位置的信息，这使得我们可以更好地了解我们绘制的图表内容。