matplotlib.widgets.CheckButtons#

class matplotlib.widgets.CheckButtons(ax, labels, actives=None, *, layout=None, useblit=True, label_props=None, frame_props=None, check_props=None)[源代码]#

基类：_Buttons

一种 GUI 中立的复选框集合。

为了使复选框保持响应，你必须保留该对象的引用。

使用 on_clicked 方法连接到 CheckButtons。

属性：
axAxes

组件的父级 Axes 对象。

labelslist of Text

复选框的文本标签对象。

将复选框添加到 Axes 实例 ax 中。

参数:
axAxes

组件的父级 Axes 对象。

labelsstr 列表

复选框的标签。

activeslist of bool, optional

按钮的初始选中状态。该列表必须与 labels 长度相同。如果不提供，所有按钮默认均不选中。

layoutNone 或 "vertical" 或 "horizontal" 或 (int, int), 默认: None

复选框的布局。选项包括

  • None: 使用传统的垂直布局（默认）。

  • "vertical": 将按钮排列在单列中，并根据文本宽度动态定位。

  • "horizontal": 将按钮排列在单行中，并根据文本宽度动态定位。

  • (rows, cols) 元组: 将按钮排列在指定行列数的网格中。按钮从左到右、从上到下放置，并进行动态定位。

"vertical"、"horizontal" 和 (rows, cols) 布局选项会创建 mtext.Text 对象以确定精确的文本尺寸，然后将其添加到 Axes 中。这通常是可以的，但可能会产生副作用并对性能产生轻微影响。因此，默认的 None 值避免了此过程。

于版本 3.11 新增。

useblitbool, 默认: True

如果后端支持，使用位块传输（blitting）以加快绘图速度。详见教程 通过位块传输实现更快的渲染。

版本 3.7 新增。

label_propsdict of lists, 可选

用于标签的 Text 属性字典。每个字典值应至少包含一个元素的列表。如果列表长度为 M，其值会循环使用，即第 N 个标签获取第 (N mod M) 个属性。

版本 3.7 新增。

frame_propsdict, 可选

用于复选框边框的散点 Collection 属性字典。默认尺寸为 (标签字体大小 / 2)**2，黑色边框颜色，无填充色，线宽为 1.0。

版本 3.7 新增。

check_propsdict, 可选

用于复选框勾选标记的散点 Collection 属性字典。默认尺寸为 (标签字体大小 / 2)**2，黑色，线宽为 1.0。

版本 3.7 新增。

clear()[源代码]#

取消选中所有复选框。

get_checked_labels()[源代码]#

返回用户当前选中的标签列表。

get_status()[源代码]#

返回所有复选框状态（True/False）的列表。

set_active(index, state=None)[源代码]#

通过索引修改复选框的状态。

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

参数:
index整数

要切换的复选框索引。

statebool, 可选

如果为布尔值，则明确设置状态。如果不提供值，则切换当前状态。

引发:
ValueError

如果 index 无效。

TypeError

如果 state 不是布尔值。

set_check_props(props)[源代码]#

设置复选框勾选标记的属性。

版本 3.7 新增。

参数:
propsdict

用于复选框勾选标记的 Collection 属性字典。

set_frame_props(props)[源代码]#

设置复选框边框的属性。

版本 3.7 新增。

参数:
propsdict

用于复选框边框的 Collection 属性字典。

使用 matplotlib.widgets.CheckButtons 的示例#

复选按钮

复选按钮