matplotlib.widgets#

matplotlib.widgets的继承图

GUI 中性小部件#

设计用于任何 GUI 后端的小部件。所有这些小部件都要求您预定义一个matplotlib.axes.Axes 实例并将其作为第一个参数传递。Matplotlib 不会在布局方面过于聪明——你必须弄清楚你希望你的轴有多宽和多高来容纳你的小部件。

matplotlib.widgets。AxesWidget ( ax ) [来源] #

基地:Widget

小部件连接到单个Axes.

为了保证小部件保持响应并且不被垃圾收集,用户应该维护对对象的引用。

这是必要的,因为回调注册表只维护函数的弱引用,这些函数是小部件的成员函数。如果没有对小部件对象的引用,它可能会被垃圾收集,这将断开回调。

属性
斧头Axes

小部件的父轴。

帆布FigureCanvasBase

小部件的父图形画布。

active布尔

小部件是否处于活动状态?

connect_event (事件,回调) [来源] #

将回调函数与事件连接起来。

应该使用它来代替,figure.canvas.mpl_connect因为此函数存储回调 id 以供以后清理。

disconnect_events ( ) [来源] #

断开此小部件创建的所有事件。

matplotlib.widgets。按钮( ax , label , image = None , color = '0.85' , hovercolor = '0.95' ) [source] #

基地:AxesWidget

一个 GUI 中性按钮。

要使按钮保持响应,您必须保留对它的引用。呼叫on_clicked以连接到按钮。

属性
斧头

matplotlib.axes.Axes按钮渲染成。

标签

一个matplotlib.text.Text实例。

颜色

未悬停时按钮的颜色。

悬停颜色

悬停时按钮的颜色。

参数
斧头Axes

Axes按钮将被放置到的实例。

标签str

按钮文本。

类似图像阵列或 PIL 图像

放置在按钮中的图像,如果不是None。参数直接转发到imshow

颜色颜色

未激活时按钮的颜色。

悬停颜色颜色

鼠标悬停时按钮的颜色。

断开连接( cid ) [来源] #

删除连接 id 为cid的回调函数。

on_clicked ( func ) [来源] #

将回调函数func连接到按钮单击事件。

返回一个连接id,可以用来断开回调。

matplotlib.widgets。CheckButtons ( ax , labels , actives = None ) [source] #

基地:AxesWidget

一组 GUI 中性的复选按钮。

要使复选按钮保持响应,您必须保留对此对象的引用。

on_clicked使用该方法连接到 CheckButtons 。

属性
斧头Axes

小部件的父轴。

标签列表Text
矩形列表Rectangle
( , ) 对的列表Line2DLine2D

复选框中 x 的行列表。这些行存在于每个框,但set_visible(False)在其框未被选中时具有。

matplotlib.axes.Axes向实例ax添加复选按钮。

参数
斧头Axes

小部件的父轴。

str的标签列表

检查按钮的标签。

bool的活动列表,可选

按钮的初始检查状态。该列表的长度必须与标签相同。如果没有给出,则所有按钮都未选中。

断开连接( cid ) [来源] #

删除连接 ID 为cid的观察者。

get_status ( ) [来源] #

返回所有复选按钮的状态(真/假)元组。

on_clicked ( func ) [来源] #

将回调函数func连接到按钮单击事件。

返回一个连接id,可以用来断开回调。

set_active ( index ) [来源] #

按索引切换(激活或停用)复选按钮。

eventson如果为 True,将触发回调。

参数
索引整数

要切换的复选按钮的索引。

提高
值错误

如果索引无效。

matplotlib.widgets。光标( ax , horizOn = True , vertOn = True , useblit = False , ** lineprops ) [来源] #

基地:AxesWidget

跨越轴并随鼠标光标移动的十字准线光标。

要使光标保持响应,您必须保留对它的引用。

参数
斧头matplotlib.axes.Axes

Axes光标附加到。

horizOn布尔值,默认值:True

是否绘制水平线。

vertOn布尔值,默认值:True

是否绘制垂直线。

使用 blit布尔值,默认值:False

如果后端支持,使用 blitting 更快地绘制。有关详细信息,请参阅使用 blitting 更快的渲染教程。

其他参数
**线道具

Line2D控制线条外观的属性。另请参阅axhline

例子

请参阅光标

清除(事件) [来源] #

清除光标的内部事件处理程序。

onmove (事件) [来源] #

鼠标移动时绘制光标的内部事件处理程序。

matplotlib.widgets。EllipseSelector ( ax , onselect , drawtype=<deprecated parameter> , minspanx=0 , minspany=0 , useblit=False , lineprops=<deprecated parameter> , props=None , spancoords='data' , button=None , grab_range=10 , handle_props=None , interactive=False , state_modifier_keys=None , drag_from_anywhere=False , ignore_event_outside= False ,use_data_coordinates=False ) [来源] #

基地:RectangleSelector

选择轴的椭圆区域。

要使光标保持响应,您必须保留对它的引用。

在选择之外的相同坐标处触发的按下和释放事件将清除选择器,但 ignore_event_outside=True.

参数
斧头Axes

小部件的父轴。

选择功能

在发布事件和创建、更改或删除选择之后调用的回调函数。它必须有签名:

def onselect(eclick: MouseEvent, erelease: MouseEvent)

其中eclickereleaseMouseEvent是开始和完成选择的鼠标单击和释放 。

minspanx浮点数,默认值:0

x-span 小于或等于minspanx的选择将被删除(当已经存在时)或取消。

minspany浮点数,默认值:0

y-span 小于或等于minspanx的选择将被删除(当已经存在时)或取消。

使用 blit布尔值,默认值:False

是否使用 blitting 来加快绘图速度(如果后端支持)。有关详细信息,请参阅使用 blitting 更快的渲染教程 。

道具字典,可选

绘制椭圆的属性。查看 matplotlib.patches.Patch有效属性。默认:

dict(facecolor='red', edgecolor='black', alpha=0.2, fill=True)

spancoords {“数据”,“像素”},默认值:“数据”

是否在数据或像素坐标中解释minspanxminspany 。

按钮MouseButton,列表MouseButton,默认:所有按钮

触发矩形选择的按钮。

grab_range浮点数,默认值:10

可以激活交互式工具手柄的距离(以像素为单位)。

handle_props字典,可选

绘制交互式句柄(标记艺术家)的属性。请参阅中的标记参数以matplotlib.lines.Line2D获取有效属性。默认值定义在mpl.rcParams除了默认值markeredgecolor将与 propsedgecolor中的属性相同。

交互式布尔,默认值:False

是否绘制一组允许在绘制后与小部件交互的句柄。

state_modifier_keys字典,可选

影响小部件行为的键盘修饰符。值修改了默认值,它们是:

  • “move”:移动现有的形状,默认:无修饰符。

  • "clear":清除当前形状,默认:"escape"。

  • “square”:使形状为正方形,默认:“shift”。

  • “center”:改变其中心周围的形状,默认:“ctrl”。

  • "rotate":围绕中心旋转形状,在 -45° 和 45° 之间,默认值:"r"。

“正方形”和“中心”可以组合。正方形可以在数据或显示坐标中定义,由 use_data_coordinates创建选择器时指定的参数确定。

drag_from_anywhere布尔值,默认值:False

如果True,则可以通过单击其范围内的任意位置来移动小部件。

ignore_event_outside布尔值,默认值:False

如果True,则在跨度选择器之外触发的事件将被忽略。

use_data_coordinates布尔值,默认值:False

如果True,则选择器的“方形”形状是在数据坐标中定义的,而不是在显示坐标中。

例子

矩形和椭圆选择器

属性 draw_shape [来源] #
matplotlib.widgets。套索( ax , xy , callback = None , useblit = True ) [source] #

基地:AxesWidget

任意形状的选择曲线。

所选路径可用于 contains_point从图像中选择数据点。

与 不同LassoSelector的是,这必须使用起点xy进行初始化,并且Lasso事件在释放时被销毁。

参数
斧头Axes

小部件的父轴。

xy (浮点数,浮点数)

套索开始的坐标。

使用 blit布尔值,默认值:True

是否使用 blitting 来加快绘图速度(如果后端支持)。有关详细信息,请参阅使用 blitting 更快的渲染教程 。

回调可调用

每当释放套索时,都会调用回调函数并传递所选路径的顶点。

onmove (事件) [来源] #
onrelease (事件) [来源] #
matplotlib.widgets。LassoSelector ( ax , onselect = None , useblit = True , props = None , button = None ) [来源] #

基地:_SelectorWidget

任意形状的选择曲线。

为了让选择器保持响应,您必须保留对它的引用。

所选路径可用于contains_point 从图像中选择数据点。

与 相比LassoLassoSelector使用类似于RectangleSelectorand的接口编写SpanSelector,并将继续与 Axes 交互,直到断开连接。

示例用法:

ax = plt.subplot()
ax.plot(x, y)

def onselect(verts):
    print(verts)
lasso = LassoSelector(ax, onselect)
参数
斧头Axes

小部件的父轴。

选择功能

每当释放套索时,都会调用onselect函数并传递所选路径的顶点。

使用 blit布尔值,默认值:True

是否使用 blitting 来加快绘图速度(如果后端支持)。有关详细信息,请参阅使用 blitting 更快的渲染教程 。

道具字典,可选

绘制线的属性,请参阅matplotlib.lines.Line2D 有效属性。默认值在 中定义mpl.rcParams

按钮MouseButton或列表MouseButton,可选

用于矩形选择的鼠标按钮。默认为None,对应所有按钮。

onpress (事件) [来源] #

[已弃用]

笔记

3.5 版后已弃用:请改用 press。

onrelease (事件) [来源] #

[已弃用]

笔记

3.5 版后已弃用:改用 release。

matplotlib.widgets。LockDraw [来源] #

基地:object

某些小部件(例如光标)会在画布上绘制,这在所有情况下都不可取,例如当工具栏处于缩放至矩形模式并绘制矩形时。canvas.widgetlock(widget)为了避免这种情况,小部件可以在画布上绘制之前获取画布的锁定;这将阻止其他小部件同时这样做(如果它们也尝试先获取锁)。

可用( o ) [来源] #

返回绘图是否可用于o

isowner ( o ) [来源] #

返回o是否拥有这个锁。

锁定( ) [来源] #

返回锁当前是否由所有者持有。

释放( o ) [来源] #

从o释放锁。

matplotlib.widgets。MultiCursor ( canvas , axes , * , useblit = True , horizOn = False , vertOn = True , ** lineprops ) [来源] #

基地:Widget

提供在多个轴之间共享的垂直(默认)和/或水平线光标。

要使光标保持响应,您必须保留对它的引用。

参数
画布对象

此参数完全未使用,仅保留用于向后兼容。

列表matplotlib.axes.Axes

Axes光标附加到。

使用 blit布尔值,默认值:True

如果后端支持,使用 blitting 更快地绘制。有关详细信息,请参阅使用 blitting 更快的渲染教程 。

horizOn布尔值,默认值:False

是否绘制水平线。

vertOn布尔值,默认值:True

是否绘制垂直线。

其他参数
**线道具

Line2D控制线条外观的属性。另请参阅axhline

例子

请参阅多光标

背景( ) [来源] #

[已弃用]

笔记

自 3.6 版起已弃用:

属性 画布[来源] #
清除(事件) [来源] #

清除光标。

连接( ) [来源] #

连接事件。

断开连接( ) [来源] #

断开事件。

onmove (事件) [来源] #
matplotlib.widgets。PolygonSelector ( ax , onselect , useblit = False , props = None , handle_props = None , grab_range = 10 , * , draw_bounding_box = False , box_handle_props = None , box_props = None ) [来源] #

基地:_SelectorWidget

选择轴的多边形区域。

每次单击鼠标放置顶点,并通过完成多边形进行选择(单击第一个顶点)。绘制完成后,可以通过鼠标左键单击和拖动来移动单个顶点,或者通过单击鼠标右键将其移除。

此外,可以使用以下修饰键:

  • 按住ctrl并单击并拖动一个顶点以在多边形完成之前重新定位它。

  • 按住shift键并单击并拖动 Axes 中的任意位置以移动所有顶点。

  • esc键开始一个新的多边形。

为了让选择器保持响应,您必须保留对它的引用。

参数
斧头Axes

小部件的父轴。

选择功能

当多边形完成或完成后修改时,调用onselect函数并将顶点列表作为 元组传递。(xdata, ydata)

使用 blit布尔值,默认值:False

是否使用 blitting 来加快绘图速度(如果后端支持)。有关详细信息,请参阅使用 blitting 更快的渲染教程 。

道具字典,可选

绘制线的属性,请参阅matplotlib.lines.Line2D 有效属性。默认:

dict(color='k', linestyle='-', linewidth=2, alpha=0.5)

handle_props字典,可选

在多边形顶点绘制的标记的艺术家属性。请参阅中的标记参数以matplotlib.lines.Line2D获取有效属性。默认值定义在mpl.rcParams除了默认值markeredgecolor将与 propscolor中的属性相同。

grab_range浮点数,默认值:10

如果鼠标单击在顶点的grab_range像素内,则选择顶点(以完成多边形或移动顶点)。

draw_bounding_box布尔值,可选

如果True,一旦完成,将在多边形选择器周围绘制一个边界框。此框可用于移动和调整选择器的大小。

box_handle_props字典,可选

为框手柄设置的属性。有关更多信息,请参阅 handle_props参数的文档RectangleSelector

box_props字典,可选

为框设置的属性。有关更多信息,请参阅props 参数的文档RectangleSelector

笔记

如果删除点后只剩下一个点,则选择器将恢复为不完整状态,您可以从现有点开始绘制新多边形。

例子

多边形选择器 使用多边形选择器从集合中选择索引

属性 线[来源] #
onmove (事件) [来源] #

光标移动事件处理程序和验证程序。

属性 vertex_select_radius [来源] #
属性 顶点#

多边形顶点,作为对列表。(x, y)

matplotlib.widgets。RadioButtons ( ax , labels , active = 0 , activecolor = 'blue' ) [source] #

基地:AxesWidget

一个 GUI 中性单选按钮。

要使按钮保持响应,您必须保留对此对象的引用。

on_clicked使用该方法连接到 RadioButtons 。

属性
斧头Axes

小部件的父轴。

activecolor颜色

所选按钮的颜色。

标签列表Text

按钮标签。

圈子名单Circle

按钮。

value_selected str

当前选定按钮的标签文本。

将单选按钮添加到Axes.

参数
斧头Axes

要将按钮添加到的轴。

str的标签列表

按钮标签。

主动整数

最初选择的按钮的索引。

activecolor颜色

所选按钮的颜色。

断开连接( cid ) [来源] #

删除连接 ID 为cid的观察者。

on_clicked ( func ) [来源] #

将回调函数func连接到按钮单击事件。

返回一个连接id,可以用来断开回调。

set_active ( index ) [来源] #

选择带有数字索引的按钮。

eventson如果为 True,将触发回调。

matplotlib.widgets。RangeSlider ( ax , label , valmin , valmax , valinit = None , valfmt = None , closedmin = True , closedmax = True , dragging = True , valstep = None , orientation = 'horizo​​ntal' , track_color = 'lightgrey' , handle_style = None , **kwargs ) [来源] #

基地:SliderBase

表示浮点值范围的滑块。通过val属性将范围的最小值和最大值定义为 (min, max) 的元组。

创建一个滑块,定义 Axes ax中 [ valmin , valmax ] 中包含的范围。要使滑块保持响应,您必须保持对它的引用。调用以连接到滑块事件。on_changed()

属性
浮点数的val元组

滑块值。

参数
斧头_

放置滑块的轴。

标签str

滑块标签。

华尔敏浮动

滑块的最小值。

valmax浮点数

滑块的最大值。

float 或 None 的valinit元组,默认值:None

滑块的初始位置。如果没有,初始位置将位于范围的第 25 个和第 75 个百分位数。

valfmt str,默认值:无

%-format 用于格式化滑块值的字符串。如果没有, ScalarFormatter则使用 a 代替。

closedmin布尔值,默认值:True

滑块间隔是否在底部闭合。

closedmax布尔值,默认值:True

滑块间隔是否在顶部闭合。

拖动bool,默认值:True

如果为 True,则可以用鼠标拖动滑块。

valstep浮点数,默认值:无

如果给定,滑块将捕捉到valstep的倍数。

方向{'horizo​​ntal', 'vertical'},默认值:'horizo​​ntal'

滑块的方向。

track_color颜色,默认值:'lightgrey'

背景轨道的颜色。可以通过track属性访问该轨道以进行进一步的样式设置。

handle_style字典

滑块手柄的属性。默认值为

钥匙

价值

默认

描述

脸色

颜色

'白色的'

滑块手柄的面颜色。

边缘颜色

颜色

'.75'

滑块手柄的边缘颜色。

尺寸

整数

10

滑块手柄的大小(以磅为单位)。

其他值将被转换为 marker{foo} 并传递给 Line2D构造函数。例如将导致.handle_style = {'style'='x'}markerstyle = 'x'

笔记

额外的 kwargs 被传递到self.poly哪个是 Polygon绘制滑块旋钮的。请参阅 Polygon文档以获取有效的属性名称(facecoloredgecoloralpha等)。

on_changed ( func ) [来源] #

将func作为回调函数连接到滑块值的更改。

参数
函数可调用

更改滑块时调用的函数。该函数必须接受一个形状为 (2,) 的 numpy 数组作为其参数。

返回
整数

连接 ID(可用于断开func)。

set_max ( max ) [来源] #

将滑块的下限值设置为max

参数
最大浮动
set_min ( min ) [来源] #

将滑块的下限值设置为min

参数
最小浮动
set_val ( val ) [来源] #

将滑块值设置为val

参数
val元组或类似浮点数的数组
matplotlib.widgets。RectangleSelector ( ax , onselect , drawtype=<deprecated parameter> , minspanx=0 , minspany=0 , useblit=False , lineprops=<deprecated parameter> , props=None , spancoords='data' , button=None , grab_range=10 , handle_props=None , interactive=False , state_modifier_keys=None , drag_from_anywhere=False , ignore_event_outside= False ,use_data_coordinates=False ) [来源] #

基地:_SelectorWidget

选择轴的矩形区域。

要使光标保持响应,您必须保留对它的引用。

在选择之外的相同坐标处触发的按下和释放事件将清除选择器,但 ignore_event_outside=True.

参数
斧头Axes

小部件的父轴。

选择功能

在发布事件和创建、更改或删除选择之后调用的回调函数。它必须有签名:

def onselect(eclick: MouseEvent, erelease: MouseEvent)

其中eclickereleaseMouseEvent是开始和完成选择的鼠标单击和释放 。

minspanx浮点数,默认值:0

x-span 小于或等于minspanx的选择将被删除(当已经存在时)或取消。

minspany浮点数,默认值:0

y-span 小于或等于minspanx的选择将被删除(当已经存在时)或取消。

使用 blit布尔值,默认值:False

是否使用 blitting 来加快绘图速度(如果后端支持)。有关详细信息,请参阅使用 blitting 更快的渲染教程 。

道具字典,可选

绘制矩形的属性。查看 matplotlib.patches.Patch有效属性。默认:

dict(facecolor='red', edgecolor='black', alpha=0.2, fill=True)

spancoords {“数据”,“像素”},默认值:“数据”

是否在数据或像素坐标中解释minspanxminspany 。

按钮MouseButton,列表MouseButton,默认:所有按钮

触发矩形选择的按钮。

grab_range浮点数,默认值:10

可以激活交互式工具手柄的距离(以像素为单位)。

handle_props字典,可选

绘制交互式句柄(标记艺术家)的属性。请参阅中的标记参数以matplotlib.lines.Line2D获取有效属性。默认值定义在mpl.rcParams除了默认值markeredgecolor将与 propsedgecolor中的属性相同。

交互式布尔,默认值:False

是否绘制一组允许在绘制后与小部件交互的句柄。

state_modifier_keys字典,可选

影响小部件行为的键盘修饰符。值修改了默认值,它们是:

  • “move”:移动现有的形状,默认:无修饰符。

  • "clear":清除当前形状,默认:"escape"。

  • “square”:使形状为正方形,默认:“shift”。

  • “center”:改变其中心周围的形状,默认:“ctrl”。

  • "rotate":围绕中心旋转形状,在 -45° 和 45° 之间,默认值:"r"。

“正方形”和“中心”可以组合。正方形可以在数据或显示坐标中定义,由 use_data_coordinates创建选择器时指定的参数确定。

drag_from_anywhere布尔值,默认值:False

如果True,则可以通过单击其范围内的任意位置来移动小部件。

ignore_event_outside布尔值,默认值:False

如果True,则在跨度选择器之外触发的事件将被忽略。

use_data_coordinates布尔值,默认值:False

如果True,则选择器的“方形”形状是在数据坐标中定义的,而不是在显示坐标中。

例子

>>> import matplotlib.pyplot as plt
>>> import matplotlib.widgets as mwidgets
>>> fig, ax = plt.subplots()
>>> ax.plot([1, 2, 3], [10, 50, 100])
>>> def onselect(eclick, erelease):
...     print(eclick.xdata, eclick.ydata)
...     print(erelease.xdata, erelease.ydata)
>>> props = dict(facecolor='blue', alpha=0.5)
>>> rect = mwidgets.RectangleSelector(ax, onselect, interactive=True,
                                      props=props)
>>> fig.show()
>>> selector.add_state('square')

另请参阅:矩形和椭圆选择器

属性 active_handle [来源] #
物业 中心#

数据坐标中矩形的中心。

属性 #

数据坐标中矩形的角从左下角开始,顺时针移动。

属性 draw_shape [来源] #
属性 drawtype [来源] #
属性 edge_centers #

数据坐标中矩形边缘的中点从左开始,逆时针移动。

属性 范围#

在旋转前由边界框定义的数据坐标中返回 (xmin, xmax, ymin, ymax)。

属性 几何#

返回一个形状为 (2, 5) 的数组,其中包含从左上角开始和结束的矩形四个角的x ( ) 和 y ( ) 数据坐标。RectangleSelector.geometry[1, :]RectangleSelector.geometry[0, :]

属性 交互[来源] #
属性 maxdist [来源] #
属性 轮换#

以 [-45°, 45°] 为单位的旋转度数。旋转的范围有限,以保持实现简单。

属性 to_draw [来源] #
matplotlib.widgets。滑块( ax , label , valmin , valmax , valinit = 0.5 , valfmt = None , closedmin = True , closedmax = True , slidermin = None , slidermax = None , dragging = True , valstep = None , orientation = 'horizo​​ntal' , * ,initcolor = 'r' , track_color = 'lightgrey' , handle_style = None , ** kwargs ) [来源] #

基地:SliderBase

表示浮点范围的滑块。

在 Axes ax中创建一个从valminvalmax的滑块。要使滑块保持响应,您必须保持对它的引用。调用 以连接到滑块事件。on_changed()

属性
val浮点数

滑块值。

参数
斧头_

放置滑块的轴。

标签str

滑块标签。

华尔敏浮动

滑块的最小值。

valmax浮点数

滑块的最大值。

valinit浮点数,默认值:0.5

滑块初始位置。

valfmt str,默认值:无

%-format 用于格式化滑块值的字符串。如果没有, ScalarFormatter则使用 a 代替。

closedmin布尔值,默认值:True

滑块间隔是否在底部闭合。

closedmax布尔值,默认值:True

滑块间隔是否在顶部闭合。

slidermin滑块,默认值:无

不允许当前滑块的值小于 Slider slidermin的值。

slidermax滑块,默认:无

不允许当前滑块的值大于 Slider slidermax的值。

拖动bool,默认值:True

如果为 True,则可以用鼠标拖动滑块。

valstep浮点数或类似数组,默认值:无

如果是浮点数,滑块将捕捉到valstep的倍数。如果是数组,则滑块将捕捉到数组中的值。

方向{'horizo​​ntal', 'vertical'},默认值:'horizo​​ntal'

滑块的方向。

初始颜色颜色,默认值:'r'

valinit位置的线条颜色。设置'none' 为无线路。

track_color颜色,默认值:'lightgrey'

背景轨道的颜色。可以通过track属性访问该轨道以进行进一步的样式设置。

handle_style字典

滑块手柄的属性。默认值为

钥匙

价值

默认

描述

脸色

颜色

'白色的'

滑块手柄的面颜色。

边缘颜色

颜色

'.75'

滑块手柄的边缘颜色。

尺寸

整数

10

滑块手柄的大小(以磅为单位)。

其他值将被转换为 marker{foo} 并传递给 Line2D构造函数。例如将导致.handle_style = {'style'='x'}markerstyle = 'x'

笔记

额外的 kwargs 被传递到self.poly哪个是 Polygon绘制滑块旋钮的。请参阅 Polygon文档以获取有效的属性名称(facecoloredgecoloralpha等)。

on_changed ( func ) [来源] #

将func作为回调函数连接到滑块值的更改。

参数
函数可调用

更改滑块时调用的函数。该函数必须接受一个浮点数作为其参数。

返回
整数

连接 ID(可用于断开func)。

set_val ( val ) [来源] #

将滑块值设置为val

参数
val浮点数
matplotlib.widgets。SliderBase ( ax , orientation , closedmin , closedmax , valmin , valmax , valfmt , dragging , valstep ) [source] #

基地:AxesWidget

构造 Slider 小部件的基类。不适合直接使用。

要使滑块保持响应,您必须保持对它的引用。

断开连接( cid ) [来源] #

删除连接 ID 为cid的观察者。

参数
cid整数

要删除的观察者的连接 ID。

重置( ) [来源] #

将滑块重置为初始值。

matplotlib.widgets。SpanSelector ( ax , onselect , direction , minspan = 0 , useblit = False , props = None , onmove_callback = None , interactive = False , button = None , handle_props = None , grab_range = 10 , state_modifier_keys = None , drag_from_anywhere =False , ignore_event_outside = False , snap_values = None ) [来源] #

基地:_SelectorWidget

在单个轴上直观地选择最小/最大范围并使用这些值调用函数。

为保证选择器保持响应,请保留对它的引用。

为了关闭 SpanSelector,设置span_selector.active为 False。要重新打开它,请将其设置为 True。

在选择之外的相同坐标处触发的按下和释放事件将清除选择器,但 ignore_event_outside=True.

参数
斧头matplotlib.axes.Axes
onselect可调用

在发布事件和创建、更改或删除选择之后调用的回调函数。它必须有签名:

def on_select(min: float, max: float) -> Any
方向{“水平”,“垂直”}

绘制跨度选择器的方向。

minspan浮点数,默认值:0

如果 selection 小于或等于minspan,则选择被删除(当已经存在时)或取消。

使用 blit布尔值,默认值:False

如果为 True,请使用后端相关的 blitting 功能来更快地更新画布。有关详细信息,请参阅使用 blitting 更快的渲染教程 。

道具字典,可选

matplotlib.patches.Patch属性字典。默认:

dict(facecolor='red', alpha=0.5)

onmove_callback func(min, max), min/max 为浮点数,默认:无

在选择跨度时在鼠标移动时调用。

span_stays布尔值,默认值:False

如果为 True,则释放鼠标后跨度保持可见。已弃用,请改用交互式

交互式布尔,默认值:False

是否绘制一组允许在绘制后与小部件交互的句柄。

按钮MouseButton或列表MouseButton,默认:所有按钮

激活跨度选择器的鼠标按钮。

handle_props字典,默认值:无

跨度边缘的手柄线的属性。仅在interactive为 True 时使用。查看matplotlib.lines.Line2D有效属性。

grab_range浮点数,默认值:10

可以激活交互式工具手柄的距离(以像素为单位)。

state_modifier_keys字典,可选

影响小部件行为的键盘修饰符。值修改了默认值,它们是:

  • "clear":清除当前形状,默认:"escape"。

drag_from_anywhere布尔值,默认值:False

如果True,则可以通过单击其范围内的任意位置来移动小部件。

ignore_event_outside布尔值,默认值:False

如果True,则在跨度选择器之外触发的事件将被忽略。

snap_values一维数组,可选

将选择器边缘捕捉到给定值。

例子

>>> import matplotlib.pyplot as plt
>>> import matplotlib.widgets as mwidgets
>>> fig, ax = plt.subplots()
>>> ax.plot([1, 2, 3], [10, 50, 100])
>>> def onselect(vmin, vmax):
...     print(vmin, vmax)
>>> span = mwidgets.SpanSelector(ax, onselect, 'horizontal',
...                              props=dict(facecolor='blue', alpha=0.5))
>>> fig.show()

另请参阅:跨度选择器

属性 active_handle [来源] #
connect_default_events ( ) [来源] #

将主要的画布事件连接到方法。

物业 方向#

跨度选择器的方向:“垂直”或“水平”。

属性 范围#

返回范围选择器的范围。

new_axes ( ax ) [来源] #

将 SpanSelector 设置为在新轴上运行。

属性 pressv [来源] #
属性 prev [来源] #
属性 rect [来源] #
属性 rectprops [来源] #
属性 span_stays [来源] #
matplotlib.widgets。SubplotTool ( targetfig , toolfig ) [来源] #

基地:Widget

用于调整 a 的子图参数的工具matplotlib.figure.Figure

参数
目标无花果Figure

要调整的图形实例。

工具图Figure

要嵌入 subplot 工具的图形实例。

matplotlib.widgets。TextBox ( ax , label , initial = '' , color = '.95' , hovercolor = '1' , label_pad = 0.01 , textalignment = 'left' ) [source] #

基地:AxesWidget

一个 GUI 中性文本输入框。

要使文本框保持响应,您必须保留对它的引用。

每当文本更改时调用on_text_change以进行更新。

on_submit每当用户点击输入或离开文本输入字段时调用更新。

属性
斧头Axes

小部件的父轴。

标签Text
颜色颜色

不悬停时文本框的颜色。

悬停颜色颜色

悬停时文本框的颜色。

参数
斧头Axes

Axes按钮将被放置到的实例。

标签str

此文本框的标签。

初始字符串

文本框中的初始值。

颜色颜色

盒子的颜色。

悬停颜色颜色

鼠标悬停时框的颜色。

label_pad浮动

标签与文本框右侧之间的距离。

textalignment {'left','center','right'}

文本的水平位置。

属性 DIST_FROM_LEFT [来源] #
begin_typing ( x ) [来源] #
断开连接( cid ) [来源] #

删除连接 ID 为cid的观察者。

on_submit ( func ) [来源] #

当用户点击进入或离开提交框时,使用事件调用此 函数

返回一个可用于断开连接的连接 ID。

on_text_change ( func ) [来源] #

当文本改变时,用事件调用这个函数。

返回一个可用于断开连接的连接 ID。

position_cursor ( x ) [来源] #
set_val ( val ) [来源] #
stop_typing ( ) [来源] #
属性 文本#
matplotlib.widgets。ToolHandles ( ax , x , y , marker = 'o' , marker_props = None , useblit = True ) [来源] #

基地:object

画布工具的控制手柄。

参数
斧头matplotlib.axes.Axes

Matplotlib 显示工具句柄的轴。

x, y一维数组

控制手柄的坐标。

标记str,默认值:'o'

用于显示句柄的标记形状。见matplotlib.pyplot.plot

marker_props字典,可选

其他标记属性。见matplotlib.lines.Line2D

使用 blit布尔值,默认值:True

是否使用 blitting 来加快绘图速度(如果后端支持)。有关详细信息,请参阅使用 blitting 更快的渲染教程 。

房地产 艺术家#
最接近的( x , y ) [来源] #

返回到最近索引的索引和像素距离。

set_animated ( val ) [来源] #
set_data ( pts , y = None ) [来源] #

设置手柄的 x 和 y 位置。

set_visible ( val ) [来源] #
属性 x #
属性 y #
matplotlib.widgets。ToolLineHandles ( ax , position , direction , line_props = None , useblit = True ) [source] #

基地:object

画布工具的控制手柄。

参数
斧头matplotlib.axes.Axes

Matplotlib 显示工具句柄的轴。

位置一维数组

数据坐标中句柄的位置。

方向{“水平”,“垂直”}

手柄的方向,“垂直”或“水平”

line_props字典,可选

附加线属性。见matplotlib.lines.Line2D

使用 blit布尔值,默认值:True

是否使用 blitting 来加快绘图速度(如果后端支持)。有关详细信息,请参阅使用 blitting 更快的渲染教程 。

房地产 艺术家#
最接近的( x , y ) [来源] #

返回到最近句柄的索引和像素距离。

参数
x, y浮动

x, y 位置,从该位置计算距离以确定最近的句柄

返回
index,句柄的距离索引及其距离

位置 x, y

物业 方向#

手柄方向:“垂直”或“水平”。

属性 位置#

句柄在数据坐标中的位置。

删除( ) [来源] #

从图中删除手柄艺术家。

set_animated () [来源] #

设置手柄艺术家的动画状态。

set_data (位置) [来源] #

设置手柄的 x 或 y 位置,具体取决于线条是垂直还是水平。

参数
位置长度为 2 的元组

设置句柄在数据坐标中的位置

set_visible () [来源] #

设置手柄艺术家的可见性状态。

matplotlib.widgets。小部件[来源] #

基地:object

GUI 中性小部件的抽象基类。

属性 活跃#

小部件是否处于活动状态?

drawon =#
事件=#
get_active ( ) [来源] #

获取小部件是否处于活动状态。

忽略(事件) [来源] #

返回是否应该忽略事件。

此方法应在任何事件回调开始时调用。

set_active (主动) [来源] #

设置小部件是否处于活动状态。