`ipywidgets`#

特性#

用于自定义效果的额外 traitlets

html小部件的特性类型。

class ipywidgets.widgets.trait_types.ByteMemoryView(default_value=traitlets.Undefined, allow_none=False, read_only=None, help=None, config=None, **kwargs)[source]#

基类: TraitType

字节内存视图的一个特性。

声明一个traitlet。

如果 allow_none 为 True，那么除了任何通常有效的值之外，None 也是一个有效值。默认值取决于子类。对于大多数特征类型，allow_none 的默认值为 False。

If read_only is True, attempts to directly modify a trait attribute raises a TraitError.

如果 help 是一个字符串，它记录了该属性的用途。

额外的元数据可以通过使用 .tag() 便捷方法或使用 traitlet 实例的 .metadata 字典与 traitlet 关联。

class ipywidgets.widgets.trait_types.CByteMemoryView(default_value=traitlets.Undefined, allow_none=False, read_only=None, help=None, config=None, **kwargs)[source]#

基础类: ByteMemoryView

字节内存视图特性的一个强制转换版本。

声明一个traitlet。

如果 allow_none 为 True，那么除了任何通常有效的值之外，None 也是一个有效值。默认值取决于子类。对于大多数特征类型，allow_none 的默认值为 False。

If read_only is True, attempts to directly modify a trait attribute raises a TraitError.

如果 help 是一个字符串，它记录了该属性的用途。

额外的元数据可以通过使用 .tag() 便捷方法或使用 traitlet 实例的 .metadata 字典与 traitlet 关联。

class ipywidgets.widgets.trait_types.Color(default_value=traitlets.Undefined, allow_none=False, read_only=None, help=None, config=None, **kwargs)[source]#

基础类: Unicode

一个包含有效HTML颜色的字符串，例如'blue', '#060482', '#A80'

声明一个traitlet。

如果 allow_none 为 True，那么除了任何通常有效的值之外，None 也是一个有效值。默认值取决于子类。对于大多数特征类型，allow_none 的默认值为 False。

If read_only is True, attempts to directly modify a trait attribute raises a TraitError.

如果 help 是一个字符串，它记录了该属性的用途。

额外的元数据可以通过使用 .tag() 便捷方法或使用 traitlet 实例的 .metadata 字典与 traitlet 关联。

default_value = traitlets.Undefined#

class ipywidgets.widgets.trait_types.Date(default_value=traitlets.Undefined, allow_none=False, read_only=None, help=None, config=None, **kwargs)[source]#

基类: TraitType

一个特质类型，持有Python日期对象

声明一个traitlet。

如果 allow_none 为 True，那么除了任何通常有效的值之外，None 也是一个有效值。默认值取决于子类。对于大多数特征类型，allow_none 的默认值为 False。

If read_only is True, attempts to directly modify a trait attribute raises a TraitError.

如果 help 是一个字符串，它记录了该属性的用途。

额外的元数据可以通过使用 .tag() 便捷方法或使用 traitlet 实例的 .metadata 字典与 traitlet 关联。

klass#: date的别名

class ipywidgets.widgets.trait_types.Datetime(default_value=traitlets.Undefined, allow_none=False, read_only=None, help=None, config=None, **kwargs)[source]#

基类: TraitType

一种特征类型，持有一个 Python datetime 对象

声明一个traitlet。

如果 allow_none 为 True，那么除了任何通常有效的值之外，None 也是一个有效值。默认值取决于子类。对于大多数特征类型，allow_none 的默认值为 False。

If read_only is True, attempts to directly modify a trait attribute raises a TraitError.

如果 help 是一个字符串，它记录了该属性的用途。

额外的元数据可以通过使用 .tag() 便捷方法或使用 traitlet 实例的 .metadata 字典与 traitlet 关联。

klass#: datetime 的别名

class ipywidgets.widgets.trait_types.InstanceDict(klass=None, args=None, kw=None, allow_none=False, read_only=None, help=None, **kwargs)[source]#

基类：Instance

一个实例特质，将字典强制转换为实例。

这允许将实例指定为字典，用于初始化实例。

此外，即使未指定 args 和 kwargs，我们也默认使用一个平凡实例。

构造一个Instance trait。

此特性允许值为特定类或其子类的实例。我们的实现与enthough.traits的实现有很大不同，因为我们不允许将实例用于klass，并且我们以不同的方式处理args和kw参数。

参数#

klassclass, str: 构成该特性的基础类。类名也可以指定为字符串，比如 'foo.bar.Bar'。
argstuple: 用于生成默认值的位置参数。
kwdict: 用于生成默认值的关键字参数。
allow_nonebool [ default False ]: 指示是否允许 None 作为值。
**kwargs: 传递给 ClassBasedTraitType 的额外参数

备注#

如果 args 和 kw 都为 None，则默认值为 None。如果 args 是一个元组且 kw 是一个字典，那么默认值将创建为 klass(*args, **kw)。如果 args 或 kw 中恰好有一个是 None，则 None 将分别替换为 () 或 {}。

class ipywidgets.widgets.trait_types.NumberFormat(default_value=traitlets.Undefined, allow_none=False, read_only=None, help=None, config=None, **kwargs)[source]#

基础类: Unicode

一个包含数字格式说明符的字符串，例如 '.3f'

这个traitlet持有一个可以传递给d3-format JavaScript库的字符串。允许的格式类似于Python格式说明符（PEP 3101）。

声明一个traitlet。

如果 allow_none 为 True，那么除了任何通常有效的值之外，None 也是一个有效值。默认值取决于子类。对于大多数特征类型，allow_none 的默认值为 False。

If read_only is True, attempts to directly modify a trait attribute raises a TraitError.

如果 help 是一个字符串，它记录了该属性的用途。

额外的元数据可以通过使用 .tag() 便捷方法或使用 traitlet 实例的 .metadata 字典与 traitlet 关联。

default_value = traitlets.Undefined#

class ipywidgets.widgets.trait_types.Time(default_value=traitlets.Undefined, allow_none=False, read_only=None, help=None, config=None, **kwargs)[source]#

基类: TraitType

一个特质类型，持有Python时间对象

声明一个traitlet。

如果 allow_none 为 True，那么除了任何通常有效的值之外，None 也是一个有效值。默认值取决于子类。对于大多数特征类型，allow_none 的默认值为 False。

If read_only is True, attempts to directly modify a trait attribute raises a TraitError.

如果 help 是一个字符串，它记录了该属性的用途。

额外的元数据可以通过使用 .tag() 便捷方法或使用 traitlet 实例的 .metadata 字典与 traitlet 关联。

klass#: date的别名

class ipywidgets.widgets.trait_types.TypedTuple(trait=None, default_value=traitlets.Undefined, help=None, read_only=None, config=None, **kwargs)[source]#

基础类: Container

一个用于具有类型检查元素的任意长度元组的特性。

从列表、集合或元组创建一个容器特征类型。

默认值是通过执行List(default_value)创建的，这会创建default_value的一个副本。

trait 可以指定，这将限制容器中的元素类型为该 TraitType。

如果仅提供一个参数且不是Trait，则将其作为 default_value：

c = List([1, 2, 3])

参数#

traitTraitType [ optional ]: 用于限制容器内容类型的类型。如果未指定，则不会检查类型。
default_valueSequenceType [ optional ]: 特性的默认值。必须是列表/元组/集合，并将转换为容器类型。
allow_nonebool [ default False ]: 是否允许该值为None
**kwargsany: 用于扩展 Trait 的其他键（例如配置）

klass#: 别名 tuple

ipywidgets.widgets.trait_types.date_from_json(js, manager)[source]#: 反序列化一个Javascript日期。

ipywidgets.widgets.trait_types.date_to_json(pydate, manager)[source]#

序列化一个Python日期对象。

该字典的属性将被传递给 JavaScript Date 构造函数。

ipywidgets.widgets.trait_types.datetime_from_json(js, manager)[source]#: 从 JSON 反序列化 Python 日期时间对象。

ipywidgets.widgets.trait_types.datetime_to_json(pydt, manager)[source]#

将Python datetime对象序列化为json。

使用字符串实例化 JavaScript Date 对象时，会假定该字符串是 UTC 字符串，而使用构造函数参数实例化时，会假定它是本地时间：

>>> cdate = new Date('2015-05-12')
Mon May 11 2015 20:00:00 GMT-0400 (Eastern Daylight Time)
>>> cdate = new Date(2015, 4, 12) // Months are 0-based indices in JS
Tue May 12 2015 00:00:00 GMT-0400 (Eastern Daylight Time)

该字典的属性将被传递给 JavaScript Date 构造函数。

ipywidgets.widgets.trait_types.naive_from_json(js, manager)[source]#: 从JSON反序列化一个朴素的Python datetime对象。

ipywidgets.widgets.trait_types.naive_to_json(pydt, manager)[source]#

将一个朴素的 Python datetime 对象序列化为 json。

使用字符串实例化 JavaScript Date 对象时，会假定该字符串是 UTC 字符串，而使用构造函数参数实例化时，会假定它是本地时间：

>>> cdate = new Date('2015-05-12')
Mon May 11 2015 20:00:00 GMT-0400 (Eastern Daylight Time)
>>> cdate = new Date(2015, 4, 12) // Months are 0-based indices in JS
Tue May 12 2015 00:00:00 GMT-0400 (Eastern Daylight Time)

该字典的属性将被传递给 JavaScript Date 构造函数。

ipywidgets.widgets.trait_types.time_from_json(js, manager)[source]#: 从json反序列化Python时间对象。

ipywidgets.widgets.trait_types.time_to_json(pyt, manager)[source]#: 将 Python 时间对象序列化为 json。

Widget 基类#

小部件的基础类

基础小工具类。允许用户在后台创建小工具，并在Jupyter笔记本前端呈现。

class ipywidgets.widgets.widget.CallbackDispatcher(*args, **kwargs)[source]#

基础类: LoggingHasTraits

用于注册和运行回调的结构

__call__(*args, **kwargs)[source]#: 调用所有已注册的回调函数。

register_callback(callback, remove=False)[source]#

(取消)注册回调函数

参数#

callback: 方法句柄: 要注册或取消注册的方法。
remove=假: bool: 是否取消注册回调。

class ipywidgets.widgets.widget.LoggingHasTraits(*args, **kwargs)[source]#

基础类: HasTraits

用于记录日志的HasTraits的父类。子类具有日志特性，默认行为是从当前运行的应用程序获取日志记录器。

class ipywidgets.widgets.widget.Widget(**kwargs)[source]#

基础类: LoggingHasTraits

公共构造函数

__del__()[source]#: 对象销毁

__init__(**kwargs)[source]#: 公共构造函数

__repr__()[source]#: 返回 repr(self)。

add_traits(**traits)[source]#: 动态地向Widget添加特质属性。

close()[source]#

关闭方法。

关闭底层通信通道。当通信通道关闭时，所有小部件视图都会自动从前端移除。

static get_manager_state(drop_defaults=False, widgets=None)[source]#

返回用于嵌入的小部件管理器的完整状态

Parameters:

drop_defaults – 当为True时，不会包含默认值
widgets – 包含要纳入状态的部件列表（当为 None 时表示所有部件）

Returns:

get_state(key=None, drop_defaults=False)[source]#

获取小部件状态，或其一部分。

参数#

keyunicode or iterable (optional): 要获取的单个属性名称或可迭代的属性名称。

返回#

状态：状态字典元数据：字典

每个字段的元数据：{key: metadata}

static handle_comm_opened(comm, msg)[source]#: 静态方法，在小部件构造时调用。

classmethod handle_control_comm_opened(comm, msg)[source]#: 类方法，当在“jupyter.widget.control”通信通道上接收到comm-open消息时调用

hold_sync()[source]#: 在最外层的上下文管理器退出之前，保持同步任何状态

keys#: 被同步的特性。

property model_id#

获取此widget的模型ID。

如果 Comm 尚未存在，将会自动创建一个 Comm。

notify_change(change)[source]#: 当一个属性发生变化时被调用。

on_msg(callback, remove=False)[source]#

（取消）注册自定义消息接收回调。

参数#

回调函数: 可调用对象

当消息到达时，回调函数将被传入三个参数：

callback(widget, content, buffers)

移除: 布尔型

如果应该取消注册回调，则为True。

static on_widget_constructed(callback)[source]#

在部件被构造时注册要调用的回调函数。

回调函数必须具有以下签名： callback(widget)

open()[source]#: 如果前端尚未打开，则打开一个通信。

send(content, buffers=None)[source]#

向前端的小部件模型发送一条自定义消息。

参数#

contentdict: 消息发送的内容。
bufferslist of binary buffers: 随消息发送的二进制缓冲区

send_state(key=None)[source]#

如果存在前端，则将小部件状态或其一部分发送给前端。

参数#

keyunicode, or iterable (optional): 与前端同步的单个属性名称或属性名称的可迭代对象。

set_state(sync_data)[source]#: 当从前端接收到一个状态时调用。

ipywidgets.widgets.widget.envset(name, default)[source]#: 如果给定的环境变量已开启，返回 True，否则返回 False。如果环境变量已设置，当它被赋予除 'no'、'n'、'false'、'off'、'0' 或 '0.0'（不区分大小写）以外的值时，将返回 True。如果环境变量未设置，则返回默认值。

ipywidgets.widgets.widget.register(widget)[source]#: 一个装饰器，用于在部件注册表中注册部件类。

包含ValueWidget类

class ipywidgets.widgets.valuewidget.ValueWidget(**kwargs)[source]#

基础类: Widget

可用于交互式函数输入的窗口小部件

公共构造函数

get_interact_value()[source]#: 返回此控件的值，该值应传递给交互式函数。自定义控件可以更改此方法以处理原始值 self.value。

value#: 小部件的值。

包含 DOMWidget 类

class ipywidgets.widgets.domwidget.DOMWidget(**kwargs)[source]#

基础类: Widget

可以插入DOM中的小部件

参数#

提示文本: 字符串: 工具提示标题
layout: Layout 实例字典: 小部件布局

公共构造函数

add_class(className)[source]#

向小部件的顶级元素添加一个类。

如果该类已经存在，则不添加。

blur()[source]#: 模糊小部件。

focus()[source]#: 专注于小部件。

remove_class(className)[source]#

从控件（widget）的顶层元素移除一个类。

如果类不存在，则不删除它。

tabbable#: 控件是否可制表？

tooltip#: 工具提示标题。

交互式#

自动生成小部件用户界面的观点

使用小部件与函数交互。

class ipywidgets.widgets.interaction.fixed(**kwargs)[source]#

基础类: HasTraits

一个伪部件，其值是固定的，且从不与客户端同步。

__init__(value, **kwargs)[source]#

description#: 任意Python对象

get_interact_value()[source]#: 返回此控件的值，该值应传递给交互式函数。自定义控件可以更改此方法以处理原始值 self.value。

value#: 任意Python对象

class ipywidgets.widgets.interaction.interactive(**kwargs)[source]#

基础类：VBox

一个VBox容器，包含一组与函数绑定的交互式控件。

参数#

__interact_ffunction: 绑定交互式控件的函数。**kwargs应与函数签名匹配。
__optionsdict: 一个选项字典。目前，唯一支持的键是 "manual" (默认为 False)，"manual_name" (默认为 "Run Interact") 和 "auto_display" (默认为 False)。
**kwargsvarious, optional: 为每个关键字参数创建一个交互式控件，前提是该参数是一个有效的控件缩写。

请注意，前两个参数特意以双下划线开头，以避免与通过**kwargs传递的关键字参数混淆。

公共构造函数

__init__(_interactive__interact_f, _interactive__options={}, **kwargs)[source]#: 公共构造函数

find_abbreviations(kwargs)[source]#: 找出给定函数和关键词参数的缩写。返回 (名称, 缩写, 默认值) 元组。

update(*args)[source]#

调用交互函数并用函数调用的结果更新输出部件。

参数#

*argsignored: 此方法作为traitlets回调使用时必需。

classmethod widget_from_abbrev(abbrev, default)[source]#: 根据缩写或部件构建一个ValueWidget实例。

static widget_from_annotation(t)[source]#: 根据类型注解和可选的默认值创建控件。

static widget_from_iterable(o)[source]#: 从可迭代对象创建控件。不应对字符串或元组执行此操作。

static widget_from_single_value(o)[source]#: 从单个值创建小部件，可用作参数默认值。

static widget_from_tuple(o)[source]#: 从元组缩写创建小部件。

widgets_from_abbreviations(seq)[source]#: 给定一系列(名称, 缩写, 默认值)元组, 返回一个Widget序列

ipywidgets.widgets.interaction.interactive_output(f, controls)[source]#

将小部件控件连接到函数。

此函数不会为小部件生成用户界面（不同于interact）。这使用户能够自定义小部件的用户界面布局。用户界面布局必须手动定义和显示。

ipywidgets.widgets.interaction.show_inline_matplotlib_plots()[source]#

如果使用内联后端，立即显示matplotlib绘图。

使用 ipywidgets 6.0 时，当使用 ipykernel 附带的内联后端时，matplotlib 图表与交互功能配合不佳。基本上，内联后端仅在完整单元执行后才显示图表，这与在交互函数内部绘制图表不兼容。详情请参阅 jupyter-widgets/ipywidgets# 和 ipython/ipython#10376。此函数会在后端为内联后端时显示任何 matplotlib 图表。

核心部件#

核心部件

Bool类.

使用小部件表示一个布尔值。

class ipywidgets.widgets.widget_bool.Checkbox(**kwargs)[source]#

基类: _Bool

以复选框形式显示一个布尔型值。

参数#

value{True,False}: 复选框的值：True-已选中，False-未选中
descriptionstr: 复选框旁边显示的描述
indent{True,False}: 缩进控件以与其他带有描述的控件对齐。style.description_width属性控制此宽度以与其他控件保持一致。

公共构造函数

indent#: 缩进控件以与其他带有描述的控件对齐。

style#: 样式自定义

class ipywidgets.widgets.widget_bool.CheckboxStyle(**kwargs)[source]#

基类: DescriptionStyle, CoreWidget

复选框小部件样式。

公共构造函数

background#: 背景规范。

class ipywidgets.widgets.widget_bool.ToggleButton(**kwargs)[source]#

基类: _Bool

以切换按钮的形式显示一个布尔值。

参数#

value{True,False}: 切换按钮的值：True-已按下，False-未按下
descriptionstr: 按钮上显示的描述
图标: str: font-awesome 图标名称
style: DescriptionStyle的实例: 样式自定义
button_style: 枚举: 按钮预设样式

公共构造函数

button_style#: 使用预定义的按钮样式。

icon#: Font-awesome 图标。

style#: 样式自定义

class ipywidgets.widgets.widget_bool.ToggleButtonStyle(**kwargs)[source]#

基类: DescriptionStyle, CoreWidget

ToggleButton 小部件样式。

公共构造函数

font_family#: 切换按钮文本字体族。

font_size#: 切换按钮文本字体大小。

font_style#: 切换按钮文本字体样式。

font_variant#: 切换按钮文本字体变体。

font_weight#: 切换按钮文本字体粗细。

text_color#: 切换按钮文本颜色

text_decoration#: 切换按钮文本装饰。

class ipywidgets.widgets.widget_bool.Valid(**kwargs)[source]#

基类: _Bool

以绿色勾选（True / 有效）或红色叉号（False / 无效）的形式显示布尔值。

参数#

值：{True,False}: 有效小部件的值

公共构造函数

readout#: 当值为False时显示的消息

Box小部件。

这些窗口小部件是容器，可用于将其他窗口小部件组合在一起并控制其相对布局。

class ipywidgets.widgets.widget_box.Box(**kwargs)[source]#

基础类: DOMWidget, CoreWidget

在组内显示多个小部件。

这些小组件水平排列。

参数#

children: 可迭代的Widget实例: 要显示的小部件列表
box_style: str: 可选项为 'success'、'info'、'warning' 或 'danger'，或者为空字符串 ''。为方框应用预定义样式。默认为空字符串 ''，表示不应用任何预定义样式。

示例#

>>> import ipywidgets as widgets
>>> title_widget = widgets.HTML('<em>Box Example</em>')
>>> slider = widgets.IntSlider()
>>> widgets.Box([title_widget, slider])

公共构造函数

__init__(children=(), **kwargs)[source]#: 公共构造函数

box_style#: 为方框使用预定义的样式。

children#: 小部件子项列表

class ipywidgets.widgets.widget_box.GridBox(**kwargs)[source]#

基础类: Box

使用网格盒子模型按行和列显示多个小部件。

参数#

{box_params}

示例#

>>> import ipywidgets as widgets
>>> title_widget = widgets.HTML('<em>Grid Box Example</em>')
>>> slider = widgets.IntSlider()
>>> button1 = widgets.Button(description='1')
>>> button2 = widgets.Button(description='2')
>>> # Create a grid with two columns, splitting space equally
>>> layout = widgets.Layout(grid_template_columns='1fr 1fr')
>>> widgets.GridBox([title_widget, slider, button1, button2], layout=layout)

公共构造函数

class ipywidgets.widgets.widget_box.HBox(**kwargs)[source]#

基础类: Box

使用弹性盒子模型水平显示多个部件。

参数#

children: 可迭代的Widget实例: 要显示的小部件列表
box_style: str: 可选项为 'success'、'info'、'warning' 或 'danger'，或者为空字符串 ''。为方框应用预定义样式。默认为空字符串 ''，表示不应用任何预定义样式。

示例#

>>> import ipywidgets as widgets
>>> title_widget = widgets.HTML('<em>Horizontal Box Example</em>')
>>> slider = widgets.IntSlider()
>>> widgets.HBox([title_widget, slider])

公共构造函数

class ipywidgets.widgets.widget_box.VBox(**kwargs)[source]#

基础类: Box

使用弹性盒子模型垂直显示多个控件。

参数#

children: 可迭代的Widget实例: 要显示的小部件列表
box_style: str: 可选项为 'success'、'info'、'warning' 或 'danger'，或者为空字符串 ''。为方框应用预定义样式。默认为空字符串 ''，表示不应用任何预定义样式。

示例#

>>> import ipywidgets as widgets
>>> title_widget = widgets.HTML('<em>Vertical Box Example</em>')
>>> slider = widgets.IntSlider()
>>> widgets.VBox([title_widget, slider])

公共构造函数

按钮类。

在前端使用小部件表示一个按钮。允许用户监听按钮上的点击事件，并在触发点击时执行后端代码。

class ipywidgets.widgets.widget_button.Button(**kwargs)[source]#

基础类: DOMWidget, CoreWidget

按钮组件。

此部件有一个on_click方法，可让您监听用户点击按钮的操作。点击事件本身是无状态的。

参数#

描述: str: 按钮上显示的描述
图标: str: Font Awesome 图标名称，无需 'fa-' 前缀
disabled: 布尔值: 用户交互是否已启用

公共构造函数

__init__(**kwargs)[source]#: 公共构造函数

button_style#: 使用预定义的按钮样式。

click()[source]#

以编程方式触发点击事件。

这将调用注册到被点击按钮部件实例上的回调函数。

description#: 按钮标签。

disabled#: 启用或禁用用户更改。

icon#: Font-awesome 图标名称，不包含 'fa-' 前缀。

on_click(callback, remove=False)[source]#

注册一个回调函数，在按钮被点击时执行。

回调函数将使用一个参数被调用，即被点击的按钮小部件实例。

参数#

remove: bool (可选): 设置为 true 以从回调列表中移除该回调。

class ipywidgets.widgets.widget_button.ButtonStyle(**kwargs)[source]#

基类: Style, CoreWidget

按钮样式组件。

公共构造函数

button_color#: 按钮的颜色

font_family#: 按钮文本字体类型。

font_size#: 按钮文本字体大小。

font_style#: 按钮文本字体样式。

font_variant#: 按钮文本字体变体。

font_weight#: 按钮文本字体粗细。

text_color#: 按钮文本颜色。

text_decoration#: 按钮文本装饰。

颜色类。

表示一个HTML颜色。

class ipywidgets.widgets.widget_color.ColorPicker(**kwargs)[source]#

基础类：DescriptionWidget, ValueWidget, CoreWidget

公共构造函数

concise#: 显示仅包含颜色选择器的简化版本。

disabled#: 启用或禁用用户更改。

value#: 颜色值。

控制器类。

代表一个游戏手柄或操纵杆控制器。

class ipywidgets.widgets.widget_controller.Axis(**kwargs)[source]#

基类: DOMWidget, ValueWidget, CoreWidget

表示游戏手柄或操纵杆的轴。

公共构造函数

value#: 轴的值。

class ipywidgets.widgets.widget_controller.Button(**kwargs)[source]#

基类: DOMWidget, ValueWidget, CoreWidget

表示游戏手柄或操纵杆按钮。

公共构造函数

pressed#: 按钮是否被按下。

value#: 按钮的值。

class ipywidgets.widgets.widget_controller.Controller(**kwargs)[source]#

基础类: DOMWidget, CoreWidget

代表一个游戏控制器。

公共构造函数

axes#: 游戏手柄上的轴。

buttons#: 手柄上的按钮。

connected#: 游戏手柄是否已连接。

index#: 控制器的ID编号。

mapping#: 控件映射的名称。

name#: 控制器的名称。

timestamp#: 此游戏手柄数据上次更新的时间。

Core中提供的小部件的基础小部件类

class ipywidgets.widgets.widget_core.CoreWidget(**kwargs)[source]#

基础类: Widget

公共构造函数

颜色类。

表示一个HTML颜色。

class ipywidgets.widgets.widget_date.DatePicker(**kwargs)[source]#

基础类：DescriptionWidget, ValueWidget, CoreWidget

显示一个用于选择日期的小部件。

参数#

值: datetime.date: 该小部件的当前值。
disabled: 布尔值: 是否禁用用户更改。

示例#

>>> import datetime
>>> import ipywidgets as widgets
>>> date_pick = widgets.DatePicker()
>>> date_pick.value = datetime.date(2019, 7, 9)

公共构造函数

disabled#: 启用或禁用用户更改。

step#: 选择器使用的日期步长，单位为天，或为“任意”。

时间和日期时间选择器控件

class ipywidgets.widgets.widget_datetime.DatetimePicker(**kwargs)[source]#

基础类：DescriptionWidget, ValueWidget, CoreWidget

显示一个用于选择日期时间的小部件。

参数#

值: datetime.datetime: 该小部件的当前值。
disabled: 布尔值: 是否禁用用户更改。
最小：日期时间: 允许的日期时间下限
最大时间点: datetime.datetime: 允许的上部日期时间界限

示例#

>>> import datetime
>>> import ipydatetime
>>> datetime_pick = ipydatetime.DatetimePicker()
>>> datetime_pick.value = datetime.datetime(2018, 09, 5, 12, 34, 3)

公共构造函数

disabled#: 启用或禁用用户更改。

class ipywidgets.widgets.widget_datetime.NaiveDatetimePicker(**kwargs)[source]#

基础类：DatetimePicker

显示一个用于选择原生日期时间（即不考虑时区）的小部件。

参数#

值: datetime.datetime: 该小部件的当前值。
disabled: 布尔值: 是否禁用用户更改。
最小：日期时间: 允许的日期时间下限
最大时间点: datetime.datetime: 允许的上部日期时间界限

示例#

>>> import datetime
>>> import ipydatetime
>>> datetime_pick = ipydatetime.NaiveDatetimePicker()
>>> datetime_pick.value = datetime.datetime(2018, 09, 5, 12, 34, 3)

公共构造函数

包含 DOMWidget 类

class ipywidgets.widgets.widget_description.DescriptionStyle(**kwargs)[source]#

基类: Style, CoreWidget, Widget

描述样式控件。

公共构造函数

description_width#: 控件旁边描述的宽度。

class ipywidgets.widgets.widget_description.DescriptionWidget(**kwargs)[source]#

基础类: DOMWidget, CoreWidget

侧面带有描述标签的小部件。

公共构造函数

__init__(*args, **kwargs)[source]#: 公共构造函数

description#: 控件的描述。

description_allow_html#: 在描述中接受HTML。

property description_tooltip#: 工具提示信息。 .. 已弃用 :: 8.0.0

使用工具提示属性替代。

style#: 样式自定义

Float类。

表示使用小部件实现的无边界浮点数。

class ipywidgets.widgets.widget_float.BoundedFloatText(**kwargs)[source]#

基础类: _BoundedFloat

在文本框内显示浮点数值。数值必须在指定范围内。

对于不需要在特定范围内的文本框值，使用 FloatText。

参数#

valuefloat: 显示值
minfloat: 显示的可能值范围的最小值
maxfloat: 显示的可能值范围的最大值
stepfloat: 增量的步长（如果为None，则允许任何步长）
descriptionstr: 在文本框旁边显示的描述

公共构造函数

continuous_update#: 在用户输入时更新值。如果为False，则在提交时更新，例如按下回车键或离开输入框。

disabled#: 启用或禁用用户更改

step#: 增加值的最小步长

class ipywidgets.widgets.widget_float.FloatLogSlider(**kwargs)[source]#

基础类：_BoundedLogFloat

具有指定范围的对数浮点值的滑块/轨迹条。

参数#

valuefloat: 滑块的位置
basefloat: 对数刻度的底数。默认值为10
minfloat: 滑块在对数刻度下的最小位置，即实际最小值为基数 ** 最小值
maxfloat: 滑块在对数刻度上的最大位置，即实际最大值为 base ** max
stepfloat: trackbar 的步长，表示指数的步长，而非实际值
descriptionstr: 滑块名称
orientation{‘horizontal’, ‘vertical’}: 默认为‘horizontal’，滑块的方向
readout{True, False}: 默认值为 True，在滑动条旁边显示其当前值
behaviorstr: 滑块手柄和连接器的拖动行为。默认值是 'drag-tap'。
readout_formatstr: 默认值为 '.3g'，用于格式化函数的说明符，该函数用于以人类可读的形式表示滑块值，其设计灵感来源于 Python 3 的格式规范迷你语言（PEP 3101）。

公共构造函数

base#: 对数的底数

behavior#: 滑块拖动行为。

continuous_update#: 在用户拖动滑块时更新控件的值。

disabled#: 启用或禁用用户更改

orientation#: 垂直或水平。

readout#: 在滑块旁边显示其当前值。

readout_format#: 读取格式

step#: 指数的增量最小值

class ipywidgets.widgets.widget_float.FloatProgress(**kwargs)[source]#

基础类: _BoundedFloat

显示一个进度条。

参数#

valuefloat: 进度条范围内的位置
minfloat: 滑块的最小位置
maxfloat: 滑块的最大位置
descriptionstr: 进度条的名称
orientation{‘horizontal’, ‘vertical’}: 默认是 'horizontal'，进度条的方向
bar_style: {'success', 'info', 'warning', 'danger', ''}: 进度条的颜色，默认为''（蓝色）颜色有：'success'-绿色，'info'-浅蓝色，'warning'-橙色，'danger'-红色

公共构造函数

bar_style#: 为进度条使用预定义的样式。

orientation#: 垂直或水平。

class ipywidgets.widgets.widget_float.FloatRangeSlider(**kwargs)[source]#

基础类: _BoundedFloatRange

表示由最小值和最大值限定的一对浮点数的滑块/跟踪条。

参数#

valuefloat tuple: 滑块显示的范围
minfloat: 滑块的最小位置
maxfloat: 滑块的最大位置
stepfloat: 滑动条步长
descriptionstr: 滑块名称
orientation{‘horizontal’, ‘vertical’}: 默认是‘horizontal’
readout{True, False}: 默认值为 True，在滑动条旁边显示其当前值
behaviorstr: 滑块手柄和连接器的拖动行为。默认值是 'drag-tap'。
readout_formatstr: 默认值为‘.2f’，是用于表示滑块值以供人工阅读的格式化函数的说明符，参考了Python 3的格式规范迷你语言（PEP 3101）。

公共构造函数

behavior#: 滑块拖动行为。

continuous_update#: 在用户滑动滑块时更新小部件的值。

disabled#: 启用或禁用用户更改

orientation#: 垂直或水平。

readout#: 在滑块旁边显示其当前值。

readout_format#: 读取格式

step#: 增加值的最小步长

class ipywidgets.widgets.widget_float.FloatSlider(**kwargs)[source]#

基础类: _BoundedFloat

带有指定范围的浮点数值滑块/轨迹条。

参数#

valuefloat: 滑块的位置
minfloat: 滑块的最小位置
maxfloat: 滑块的最大位置
stepfloat: 滑动条步长
descriptionstr: 滑块名称
orientation{‘horizontal’, ‘vertical’}: 默认为‘horizontal’，滑块的方向
readout{True, False}: 默认值为 True，在滑动条旁边显示其当前值
behaviorstr: 滑块手柄和连接器的拖动行为。默认值是 'drag-tap'。
readout_formatstr: 默认值为‘.2f’，是用于表示滑块值以供人工阅读的格式化函数的说明符，参考了Python 3的格式规范迷你语言（PEP 3101）。

公共构造函数

behavior#: 滑块拖动行为。

continuous_update#: 在用户拖动滑块时更新控件的值。

disabled#: 启用或禁用用户更改

orientation#: 垂直或水平。

readout#: 在滑块旁边显示其当前值。

readout_format#: 读取格式

step#: 增加值的最小步长

class ipywidgets.widgets.widget_float.FloatText(**kwargs)[source]#

基类：_Float

在文本框内显示一个浮点数值。对于数值必须在特定范围内的文本框，请使用 BoundedFloatText。

参数#

valuefloat: 显示值
stepfloat: 增量的步长（如果为None，则允许任何步长）
descriptionstr: 描述将显示在文本框旁边

公共构造函数

continuous_update#: 在用户输入时更新值。如果为False，则在提交时更新，例如按下回车键或离开输入框。

disabled#: 启用或禁用用户更改

step#: 增加值的最小步长

Int 类。

表示使用小部件的无界整数。

class ipywidgets.widgets.widget_int.BoundedIntText(**kwargs)[source]#

基础类：_BoundedInt

文本框组件，表示一个上下有界的整数。

参数#

值: 整数: 初始值。
最小值: 整数: 该值的下限。
最大值: 整数: 值的上限。
步长: 整数: 允许值之间的步长。
behaviorstr: 滑块手柄和连接器的拖动行为。默认值是 'drag-tap'。

__init__(value=None, min=None, max=None, step=None, **kwargs)#

参数#

值: 整数: 初始值。
最小值: 整数: 该值的下限。
最大值: 整数: 值的上限。
步长: 整数: 允许值之间的步长。
behaviorstr: 滑块手柄和连接器的拖动行为。默认值是 'drag-tap'。

continuous_update#: 在用户输入时更新值。如果为False，则在提交时更新，例如按下回车键或离开输入框。

disabled#: 启用或禁用用户更改

step#: 增加值的最小步长

class ipywidgets.widgets.widget_int.IntProgress(**kwargs)[source]#

基础类：_BoundedInt

进度条，表示一个上下界定的整数。

参数#

值: 整数: 初始值。
最小值: 整数: 该值的下限。
最大值: 整数: 值的上限。
步长: 整数: 允许值之间的步长。
behaviorstr: 滑块手柄和连接器的拖动行为。默认值是 'drag-tap'。

__init__(value=None, min=None, max=None, step=None, **kwargs)#

参数#

值: 整数: 初始值。
最小值: 整数: 该值的下限。
最大值: 整数: 值的上限。
步长: 整数: 允许值之间的步长。
behaviorstr: 滑块手柄和连接器的拖动行为。默认值是 'drag-tap'。

bar_style#: 为进度条使用预定义的样式。

orientation#: 垂直或水平。

class ipywidgets.widgets.widget_int.IntRangeSlider(**kwargs)[source]#

基础类：_BoundedIntRange

表示一对由最小值和最大值限制的整数的滑块/轨迹条。

参数#

valueint tuple: 这对整数（lower，upper）
minint: lower允许的最小值
maxint: upper 允许的最大值
stepint: 滑动条步长
descriptionstr: 滑块名称
orientation{‘horizontal’, ‘vertical’}: 默认是‘horizontal’
readout{True, False}: 默认值为 True，在滑动条旁边显示其当前值
behaviorstr: 滑块手柄和连接器的拖动行为。默认值是 'drag-tap'。
readout_formatstr: 默认值为‘.2f’，是用于表示滑块值以供人工阅读的格式化函数的说明符，参考了Python 3的格式规范迷你语言（PEP 3101）。

公共构造函数

behavior#: 滑块拖动行为。

continuous_update#: 在用户滑动滑块时更新小部件的值。

disabled#: 启用或禁用用户更改

orientation#: 垂直或水平。

readout#: 在滑块旁边显示其当前值。

readout_format#: 读取格式

step#: 值可以采取的最小步长

style#: 滑块样式定制。

class ipywidgets.widgets.widget_int.IntSlider(**kwargs)[source]#

基础类：_BoundedInt

Slider 小部件，表示一个上下有界的整数。

参数#

值: 整数: 初始值。
最小值: 整数: 该值的下限。
最大值: 整数: 值的上限。
步长: 整数: 允许值之间的步长。
behaviorstr: 滑块手柄和连接器的拖动行为。默认值是 'drag-tap'。

__init__(value=None, min=None, max=None, step=None, **kwargs)#

参数#

值: 整数: 初始值。
最小值: 整数: 该值的下限。
最大值: 整数: 值的上限。
步长: 整数: 允许值之间的步长。
behaviorstr: 滑块手柄和连接器的拖动行为。默认值是 'drag-tap'。

behavior#: 滑块拖动行为。

continuous_update#: 在用户拖动滑块时更新控件的值。

disabled#: 启用或禁用用户更改

orientation#: 垂直或水平。

readout#: 在滑块旁边显示其当前值。

readout_format#: 读取格式

step#: 增加值的最小步长

class ipywidgets.widgets.widget_int.IntText(**kwargs)[source]#

基础类: _Int

表示整数的文本输入框部件。

参数#

值: 整数: 初始值。

__init__(value=None, **kwargs)#

参数#

值: 整数: 初始值。

continuous_update#: 在用户输入时更新值。如果为False，则在提交时更新，例如按下回车键或离开输入框。

disabled#: 启用或禁用用户更改

step#: 增加值的最小步长

class ipywidgets.widgets.widget_int.Play(**kwargs)[source]#

基础类：_BoundedInt

播放/重复按钮可自动逐步浏览数值，并可选择循环。

公共构造函数

disabled#: 启用或禁用用户更改

interval#: 两个动画步骤之间的时间（毫秒）。

playing#: 控件当前是否正在播放。

repeat#: 控件是否会在连续循环中重复。

show_repeat#: 在小部件中显示重复切换按钮。

step#: 递增步长

class ipywidgets.widgets.widget_int.ProgressStyle(**kwargs)[source]#

基类: DescriptionStyle, CoreWidget

按钮样式组件。

公共构造函数

bar_color#: 进度条的颜色。

class ipywidgets.widgets.widget_int.SliderStyle(**kwargs)[source]#

基类: DescriptionStyle, CoreWidget

按钮样式组件。

公共构造函数

handle_color#: 滑块手柄的颜色。

包含 Layout 类

class ipywidgets.widgets.widget_layout.Layout(**kwargs)[source]#

基础类: Widget

布局规范

定义一个可以使用CSS表达的布局。支持https://developer.mozilla.org/en-US/docs/Web/CSS/Reference的子集

当一个属性也可以通过简写属性访问时，我们只暴露简写形式。

例如： - flex-grow, flex-shrink 和 flex-basis 绑定于 flex。 - flex-wrap 和 flex-direction 绑定于 flex-flow。 - margin-[top/bottom/left/right] 值绑定于 margin，等等。

公共构造函数

__init__(**kwargs)[source]#: 公共构造函数

align_content#: align-content CSS属性。

align_items#: align-items CSS属性。

align_self#: align-self CSS 属性。

property border#: border 属性获取器。如果所有边框值相同，则返回公共值。否则返回 None。

border_bottom#: 边框底部 CSS 属性。

border_left#: 左侧边框CSS属性。

border_right#: 右边框CSS属性。

border_top#: CSS 的 border-top 属性。

bottom#: 底部的 CSS 属性。

display#: 显示 CSS 属性。

flex#: flex CSS属性。

flex_flow#: flex-flow CSS 属性。

grid_area#: grid-area CSS 属性。

grid_auto_columns#: grid-auto-columns CSS属性。

grid_auto_flow#: grid-auto-flow CSS 属性。

grid_auto_rows#: CSS 属性 grid-auto-rows。

grid_column#: grid-column CSS 属性。

grid_gap#: grid-gap CSS属性。

grid_row#: grid-row CSS 属性。

grid_template_areas#: grid-template-areas CSS 属性。

grid_template_columns#: grid-template-columns CSS属性。

grid_template_rows#: CSS属性grid-template-rows。

height#: 高度CSS属性。

justify_content#: justify-content CSS属性。

justify_items#: justify-items CSS属性。

left#: 左侧的 CSS 属性。

margin#: margin CSS属性。

max_height#: max-height CSS属性。

max_width#: max-width CSS属性。

min_height#: min-height CSS属性。

min_width#: min-width CSS 属性。

object_fit#: 对象适配 CSS 属性。

object_position#: object-position CSS属性。

order#: CSS 的 order 属性。

overflow#: CSS 的 overflow 属性。

padding#: CSS 属性 padding（内边距）。

right#: 正确的CSS属性。

top#: 顶部的CSS属性。

visibility#: visibility CSS属性。

width#: CSS宽度属性。

class ipywidgets.widgets.widget_layout.LayoutTraitType(klass=None, args=None, kw=None, allow_none=False, read_only=None, help=None, **kwargs)[source]#

基类：Instance

构造一个Instance trait。

参数#

klassclass, str: 构成该特性的基础类。类名也可以指定为字符串，比如 'foo.bar.Bar'。
argstuple: 用于生成默认值的位置参数。
kwdict: 用于生成默认值的关键字参数。
allow_nonebool [ default False ]: 指示是否允许 None 作为值。
**kwargs: 传递给 ClassBasedTraitType 的额外参数

备注#

klass#: Layout的别名

Link 和 DirectionalLink 类。

在小部件之间传播JavaScript端的变化。

class ipywidgets.widgets.widget_link.DirectionalLink(**kwargs)[source]#

基础类: Link

一个定向链接

source: 一个 (Widget, 'trait_name') 元组，表示源特征 target: 一个 (Widget, 'trait_name') 元组，当源特征变化时应当更新此目标特征。

公共构造函数

class ipywidgets.widgets.widget_link.Link(**kwargs)[source]#

基类: CoreWidget

链接小部件

来源: 一个 (Widget, 'trait_name') 元组，用于源特征目标: 一个 (Widget, 'trait_name') 元组，应当被更新

公共构造函数

__init__(source, target, **kwargs)[source]#: 公共构造函数

source#: 源（组件，'特性名称'）对

target#: 目标（widget, ‘trait_name’）对

class ipywidgets.widgets.widget_link.WidgetTraitTuple(**kwargs)[source]#

基类: Tuple

用于验证单个（Widget, 'trait_name'）对的Traitlet

从列表、集合或元组创建元组。

使用Traits创建一个固定类型的元组：

t = Tuple(Int(), Str(), CStr())

长度将为3，每个元素分别为Int、Str、CStr。

如果只给定一个参数且不是Trait类型，则将其视为default_value（默认值）：

t = Tuple((1, 2, 3))

否则，default_value 必须通过关键字指定。

参数#

*traitsTraitTypes [ optional ]: 限制元组内容的类型。如果未指定，则不检查类型。如果指定，则每个位置参数对应元组的一个元素。使用特质定义的元组具有固定长度。
default_valueSequenceType [ optional ]: 元组的默认值。必须是列表/元组/集合，并将转换为元组。如果指定了traits，default_value必须符合它们指定的形状和类型。
**kwargs: 其他传递给Container的kwargs

__init__(**kwargs)[source]#

从列表、集合或元组创建元组。

使用Traits创建一个固定类型的元组：

t = Tuple(Int(), Str(), CStr())

长度将为3，每个元素分别为Int、Str、CStr。

如果只给定一个参数且不是Trait类型，则将其视为default_value（默认值）：

t = Tuple((1, 2, 3))

否则，default_value 必须通过关键字指定。

参数#

*traitsTraitTypes [ optional ]: 限制元组内容的类型。如果未指定，则不检查类型。如果指定，则每个位置参数对应元组的一个元素。使用特质定义的元组具有固定长度。
default_valueSequenceType [ optional ]: 元组的默认值。必须是列表/元组/集合，并将转换为元组。如果指定了traits，default_value必须符合它们指定的形状和类型。
**kwargs: 其他传递给Container的kwargs

ipywidgets.widgets.widget_link.jsdlink(source, target)[source]#

将源组件属性与目标组件属性进行链接。

该链接在前端创建，不依赖与后端的往返通信。

参数#

source : 一个 (Widget, 'trait_name') 元组，用于源特征 target : 一个 (Widget, 'trait_name') 元组，用于目标特征

示例#

>>> c = dlink((src_widget, 'value'), (tgt_widget, 'value'))

ipywidgets.widgets.widget_link.jslink(attr1, attr2)[source]#

在前端连接两个部件属性，使它们保持同步。

该链接在前端创建，不依赖与后端的往返通信。

参数#

source : 一个(Widget, 'trait_name')元组，表示第一个特征 target : 一个(Widget, 'trait_name')元组，表示第二个特征

示例#

>>> c = link((widget1, 'value'), (widget2, 'value'))

class ipywidgets.widgets.widget_media.Audio(**kwargs)[source]#

基础类: _Media

将音频显示为小部件。

该小部件的 value 接受一个字节字符串。字节字符串是您希望浏览器显示的原始音频数据。您可以使用 format 特性（默认为“mp3”）显式定义字节字符串的格式。

如果将“url”传递给“format”特性，则value将被解释为以UTF-8编码的URL字节。

公共构造函数

__repr__()[source]#: 返回 repr(self)。

autoplay#: 当为 true 时，音频会在显示时开始播放

controls#: 指定应显示音频控件（如播放/暂停按钮等）

format#: 音频的格式。

loop#: 当为 true 时，音频将在结束后从头开始播放

class ipywidgets.widgets.widget_media.Image(**kwargs)[source]#

基础类: _Media

显示图像作为一个小部件。

此小部件的value接受字节字符串。该字节字符串是您希望浏览器显示的原始图像数据。您可以显式使用format特性（默认为“png”）定义字节字符串的格式。

如果将“url”传递给“format”特性，则value将被解释为以UTF-8编码的URL字节。

公共构造函数

__init__(*args, **kwargs)[source]#: 公共构造函数

__repr__()[source]#: 返回 repr(self)。

format#: 图像的格式。

height#: 图像的高度，单位为像素。使用layout.height来设置小部件的样式。

width#: 图像的宽度，单位为像素。使用 layout.width 来设置该小部件的样式。

class ipywidgets.widgets.widget_media.Video(**kwargs)[source]#

基础类: _Media

将视频显示为一个小部件。

此小部件的value值接受一个字节字符串。该字节字符串是您希望浏览器显示的原始视频数据。您可以使用format特性（默认为"mp4"）显式定义字节字符串的格式。

如果将“url”传递给“format”特性，则value将被解释为以UTF-8编码的URL字节。

公共构造函数

__repr__()[source]#: 返回 repr(self)。

autoplay#: 当为true时，视频将在显示时开始播放

controls#: 指定是否应显示视频控制（例如播放/暂停按钮等）

format#: 视频的格式。

height#: 视频的高度（以像素为单位）。

loop#: 当为 true 时，视频将在结束后从开头重新开始播放

width#: 视频的宽度（像素）。

输出类。

表示一个可用于在小部件区域内显示输出的部件。

class ipywidgets.widgets.widget_output.Output(**kwargs)[source]#

基础类: DOMWidget

作为上下文管理器使用的小部件，用于显示输出。

此小部件可以捕获并显示标准输出、标准错误和富文本输出。要使用它，请创建其实例并展示它。

随后，您可以将该部件用作上下文管理器：在上下文内生成的任何输出将被捕获并显示在该部件中，而不是标准输出区域。

你也可以使用.capture()方法来修饰一个函数或方法。该函数产生的任何输出随后将被发送到输出小部件。这在调试小部件回调等场景中非常有用。

示例::

import ipywidgets as widgets from IPython.display import display out = widgets.Output() display(out)

print('输出至输出区域')

无:: print(‘打印到输出小部件’)

@out.capture() def func():

print(‘打印到输出小部件’)

公共构造函数

__enter__()[source]#: 进入输出控件上下文管理器时调用。

__exit__(etype, evalue, tb)[source]#: 在退出输出小部件上下文管理器时被调用。

append_display_data(display_object)[source]#

附加一个显示对象作为输出。

参数#

display_objectIPython.core.display.DisplayObject: 要显示的对象（例如，IPython.display.Markdown 或 IPython.display.Image 的实例）。

append_stderr(text)[source]#: 将文本追加到标准错误流。

append_stdout(text)[source]#: 向标准输出流追加文本。

capture(clear_output=False, *clear_args, **clear_kwargs)[source]#

装饰器用于捕获函数的stdout和stderr。

参数#

clear_output: 布尔值: 如果为True，在每次新函数调用时清除输出小部件的内容。默认值：False
等待: 布尔值: 如果为 True，则等待直到有新的输出可用才清除输出。这仅在 clear_output 也为 True 时使用。默认值：False

clear_output(*pargs, **kwargs)[source]#

清空输出小部件的内容。

参数#

等待: 布尔值: 如果为 True，则等待直到有新输出可用以替换它时才清除输出。默认值：False

msg_id#: 要捕获的消息的父消息ID

outputs#: 从前端同步的输出消息。

选择类。

表示使用小部件的枚举。

class ipywidgets.widgets.widget_selection.Dropdown(**kwargs)[source]#

基类: _Selection

允许您从下拉菜单中选择单个项目。

参数#

选项：列表: 下拉菜单的选项。这可以是一个值列表，例如 ['Galileo', 'Brahe', 'Hubble'] 或 [0, 1, 2]，一个（标签，值）对的列表，例如 [('Galileo', 0), ('Brahe', 1), ('Hubble', 2)]，或者标签和值之间的映射，例如，{'Galileo': 0, 'Brahe': 1, 'Hubble': 2}。
索引: 整型: 当前选中的索引。
值: 任意类型: 当前选择的值。当以编程方式设置值时，会在选项中进行反向查找以验证值的有效性。默认情况下，反向查找使用相等运算符，但可以通过equals关键字参数提供另一个谓词。例如，在处理numpy数组时，可以设置equals=np.array_equal。
标签: str: 对应所选值的标签。
disabled: 布尔值: 是否禁用用户更改。
描述: str: 此输入组的标签。这应该是一个描述小部件的字符串。

公共构造函数

class ipywidgets.widgets.widget_selection.RadioButtons(**kwargs)[source]#

基类: _Selection

一组代表枚举的单选按钮。

在任何时间点只能切换一个单选按钮。

参数#

选项：列表: 下拉菜单的选项。这可以是一个值列表，例如 ['Galileo', 'Brahe', 'Hubble'] 或 [0, 1, 2]，一个（标签，值）对的列表，例如 [('Galileo', 0), ('Brahe', 1), ('Hubble', 2)]，或者标签和值之间的映射，例如，{'Galileo': 0, 'Brahe': 1, 'Hubble': 2}。
索引: 整型: 当前选中的索引。
值: 任意类型: 当前选择的值。当以编程方式设置值时，会在选项中进行反向查找以验证值的有效性。默认情况下，反向查找使用相等运算符，但可以通过equals关键字参数提供另一个谓词。例如，在处理numpy数组时，可以设置equals=np.array_equal。
标签: str: 对应所选值的标签。
disabled: 布尔值: 是否禁用用户更改。
描述: str: 此输入组的标签。这应该是一个描述小部件的字符串。

公共构造函数

orientation#: 垂直或水平。

class ipywidgets.widgets.widget_selection.Select(**kwargs)[source]#

基类: _Selection

列表框，仅允许在任何给定时间选择一个项目。

参数#

选项：列表: 下拉菜单的选项。这可以是一个值列表，例如 ['Galileo', 'Brahe', 'Hubble'] 或 [0, 1, 2]，一个（标签，值）对的列表，例如 [('Galileo', 0), ('Brahe', 1), ('Hubble', 2)]，或者标签和值之间的映射，例如，{'Galileo': 0, 'Brahe': 1, 'Hubble': 2}。
索引: 整型: 当前选中的索引。
值: 任意类型: 当前选择的值。当以编程方式设置值时，会在选项中进行反向查找以验证值的有效性。默认情况下，反向查找使用相等运算符，但可以通过equals关键字参数提供另一个谓词。例如，在处理numpy数组时，可以设置equals=np.array_equal。
标签: str: 对应所选值的标签。
disabled: 布尔值: 是否禁用用户更改。
描述: str: 此输入组的标签。这应该是一个描述小部件的字符串。
行数: 整数: 在小部件中显示的行数。

公共构造函数

rows#: 要显示的行数。

class ipywidgets.widgets.widget_selection.SelectMultiple(**kwargs)[source]#

基类: _MultipleSelection

允许在任何给定时间选择多个项目的列表框。

value, label 和 index 属性都是可迭代对象。

参数#

options: dict 或列表: 下拉菜单的选项。这可以是一个值的列表，例如 ['Galileo', 'Brahe', 'Hubble'] 或 [0, 1, 2]，或一个 (标签，值) 对的列表，例如 [('Galileo', 0), ('Brahe', 1), ('Hubble', 2)]，或一个标签和值之间的映射，例如，{'Galileo': 0, 'Brahe': 1, 'Hubble': 2}。标签是将在用户界面中显示的字符串，代表实际的Python选项，并且应该是唯一的。
索引：可迭代的整数: 被选中的选项的索引。
值: 可迭代对象: 所选的值。当以编程方式设置值时，会在选项中执行反向查找以验证值的有效性。默认情况下，反向查找使用相等运算符，但可通过 equals 关键字参数提供另一个谓词。例如，在处理 numpy 数组时，可以设置 equals=np.array_equal。
标签: 可迭代的字符串: 所选值对应的标签。
disabled: 布尔值: 是否禁用用户更改。
描述: str: 此输入组的标签。这应该是一个描述小部件的字符串。
行数: 整数: 在小部件中显示的行数。

公共构造函数

rows#: 要显示的行数。

class ipywidgets.widgets.widget_selection.SelectionRangeSlider(**kwargs)[source]#

基类：_MultipleSelectionNonempty

滑块，用于从列表中选择多个连续项。

索引、值和标签属性包含选择范围的起始和结束，而非该范围内的所有项目。

参数#

options: dict 或列表: 下拉菜单的选项。这可以是一个值的列表，例如 ['Galileo', 'Brahe', 'Hubble'] 或 [0, 1, 2]，或一个 (标签，值) 对的列表，例如 [('Galileo', 0), ('Brahe', 1), ('Hubble', 2)]，或一个标签和值之间的映射，例如，{'Galileo': 0, 'Brahe': 1, 'Hubble': 2}。标签是将在用户界面中显示的字符串，代表实际的Python选项，并且应该是唯一的。
索引：可迭代的整数: 被选中的选项的索引。
值: 可迭代对象: 所选的值。当以编程方式设置值时，会在选项中执行反向查找以验证值的有效性。默认情况下，反向查找使用相等运算符，但可通过 equals 关键字参数提供另一个谓词。例如，在处理 numpy 数组时，可以设置 equals=np.array_equal。
标签: 可迭代的字符串: 所选值对应的标签。
disabled: 布尔值: 是否禁用用户更改。
描述: str: 此输入组的标签。这应该是一个描述小部件的字符串。
方向：字符串: 既可以是'horizontal'也可以是'vertical'。默认为horizontal。
readout: 布尔值: 在滑块旁显示当前标签。默认为True。
continuous_update: 布尔值: 如果True，当用户持续按住滑块时，会连续更新小部件的值。否则，只有在用户释放滑块后才会更新模型。默认为True。

公共构造函数

behavior#: 滑块拖动行为。

continuous_update#: 在用户拖动滑块时更新控件的值。

index#: 选中的最小和最大索引

label#: 最小和最大选定标签

orientation#: 垂直或水平。

readout#: 在滑块旁显示当前选中的标签

value#: 最小和最大选定值

class ipywidgets.widgets.widget_selection.SelectionSlider(**kwargs)[source]#

基类：_SelectionNonempty

从列表或字典中选择单个项目的滑块。

参数#

选项：列表: 下拉菜单的选项。这可以是一个值列表，例如 ['Galileo', 'Brahe', 'Hubble'] 或 [0, 1, 2]，一个（标签，值）对的列表，例如 [('Galileo', 0), ('Brahe', 1), ('Hubble', 2)]，或者标签和值之间的映射，例如，{'Galileo': 0, 'Brahe': 1, 'Hubble': 2}。
索引: 整型: 当前选中的索引。
值: 任意类型: 当前选择的值。当以编程方式设置值时，会在选项中进行反向查找以验证值的有效性。默认情况下，反向查找使用相等运算符，但可以通过equals关键字参数提供另一个谓词。例如，在处理numpy数组时，可以设置equals=np.array_equal。
标签: str: 对应所选值的标签。
disabled: 布尔值: 是否禁用用户更改。
描述: str: 此输入组的标签。这应该是一个描述小部件的字符串。
方向：字符串: 既可以是'horizontal'也可以是'vertical'。默认为horizontal。
readout: 布尔值: 在滑块旁显示当前标签。默认为True。
continuous_update: 布尔值: 如果True，当用户持续按住滑块时，会连续更新小部件的值。否则，只有在用户释放滑块后才会更新模型。默认为True。

公共构造函数

behavior#: 滑块拖动行为。

continuous_update#: 在用户拖动滑块时更新控件的值。

orientation#: 垂直或水平。

readout#: 在滑块旁显示当前选中的标签

class ipywidgets.widgets.widget_selection.ToggleButtons(**kwargs)[source]#

基类: _Selection

代表枚举的一组切换按钮。

在同一时间只能切换一个切换按钮。

参数#

选项：列表: 下拉菜单的选项。这可以是一个值列表，例如 ['Galileo', 'Brahe', 'Hubble'] 或 [0, 1, 2]，一个（标签，值）对的列表，例如 [('Galileo', 0), ('Brahe', 1), ('Hubble', 2)]，或者标签和值之间的映射，例如，{'Galileo': 0, 'Brahe': 1, 'Hubble': 2}。
索引: 整型: 当前选中的索引。
值: 任意类型: 当前选择的值。当以编程方式设置值时，会在选项中进行反向查找以验证值的有效性。默认情况下，反向查找使用相等运算符，但可以通过equals关键字参数提供另一个谓词。例如，在处理numpy数组时，可以设置equals=np.array_equal。
标签: str: 对应所选值的标签。
disabled: 布尔值: 是否禁用用户更改。
描述: str: 此输入组的标签。这应该是一个描述小部件的字符串。
tooltips: 列表: 每个按钮的提示信息。如果指定，长度必须与 options 相同。
图标：列表: 按钮上显示的图标。这必须是字体图标库的图标名称。请参阅 http://fontawesome.io/icons/ 以获取图标列表。
button_style: str: 可选值为 'primary'、'success'、'info'、'warning' 或 'danger'。为每个按钮应用预定义样式。
样式: ToggleButtonsStyle: 按钮的样式参数。

公共构造函数

button_style#: 为按钮使用预定义的样式。

icons#: 每个按钮的图标名称（FontAwesome 名称，不含 fa- 前缀）。

tooltips#: 每个按钮的工具提示。

class ipywidgets.widgets.widget_selection.ToggleButtonsStyle(**kwargs)[source]#

基类: DescriptionStyle, CoreWidget

按钮样式组件。

参数#

按钮宽度: str: 每个按钮的宽度。这应当是一个有效的CSS宽度，例如‘10px’或‘5em’。
font_weight: str: 每个按钮的文本字体粗细，这应该是一个有效的CSS字体粗细单位，例如'bold'或'600'

公共构造函数

button_width#: 每个按钮的宽度。

font_weight#: 每个按钮的文本字体粗细。

ipywidgets.widgets.widget_selection.findvalue(array, value, compare=<function <lambda>>)[source]#: 一个使用比较函数从列表中返回值的函数。

选择容器类。

表示一个多页容器，可用于将其它小部件分组到页面中。

class ipywidgets.widgets.widget_selectioncontainer.Accordion(**kwargs)[source]#

基类: _SelectionContainer

在每个独立的折叠页面中显示子元素。

公共构造函数

class ipywidgets.widgets.widget_selectioncontainer.Stack(**kwargs)[source]#

基类: _SelectionContainer

仅显示选中的子项。

公共构造函数

class ipywidgets.widgets.widget_selectioncontainer.Tab(**kwargs)[source]#

基类: _SelectionContainer

在每个独立的折叠标签页中显示子元素。

公共构造函数

__init__(children=(), **kwargs)[source]#: 公共构造函数

ipywidgets.widgets.widget_selectioncontainer.pad(iterable, padding=None, length=None)[source]#: 返回序列元素，然后返回 None 直到达到给定大小（如果大小为 None 则无限返回）。

String 类。

使用一个小部件来表示一个Unicode字符串。

class ipywidgets.widgets.widget_string.Combobox(**kwargs)[source]#

基础类：Text

带下拉菜单和自动补全功能的单行文本框部件。

公共构造函数

ensure_option#: 如果设置，确保值在选项中。意味着continuous_update=False。

options#: 下拉菜单选项

class ipywidgets.widgets.widget_string.HTML(**kwargs)[source]#

基类：_String

将字符串 value 渲染为 HTML。

公共构造函数

class ipywidgets.widgets.widget_string.HTMLMath(**kwargs)[source]#

基类：_String

渲染字符串 value 为HTML，并渲染数学公式。

公共构造函数

class ipywidgets.widgets.widget_string.HTMLMathStyle(**kwargs)[source]#

基础类: _StringStyle

带有数学风格的HTML小部件。

公共构造函数

class ipywidgets.widgets.widget_string.HTMLStyle(**kwargs)[source]#

基础类: _StringStyle

HTML 样式控件。

公共构造函数

class ipywidgets.widgets.widget_string.Label(**kwargs)[source]#

基类：_String

标签部件。

它还会将字符串value中的数学公式渲染为Latex（需要$ $或$$ $$以及类似的latex标签）。

公共构造函数

class ipywidgets.widgets.widget_string.LabelStyle(**kwargs)[source]#

基础类: _StringStyle

标签样式小部件。

公共构造函数

font_family#: 标签文本字体家族。

font_style#: 标签文本字体样式。

font_variant#: 标签文本字体变体。

font_weight#: 标签文本字体粗细。

text_decoration#: 标签文本装饰。

class ipywidgets.widgets.widget_string.Password(**kwargs)[source]#

基础类：Text

单行文本框部件。

公共构造函数

disabled#: 启用或禁用用户更改

class ipywidgets.widgets.widget_string.Text(**kwargs)[source]#

基类：_String

单行文本框部件。

公共构造函数

__init__(*args, **kwargs)[source]#: 公共构造函数

continuous_update#: 在用户输入时更新值。如果为False，则在提交时更新，例如按下回车键或离开输入框。

disabled#: 启用或禁用用户更改

on_submit(callback, remove=False)[source]#

（取消）注册回调以处理文本提交。

当用户点击回车键时触发。

参数#

回调函数: 可调用对象: 将以一个参数调用：Widget实例
remove: bool (可选): 是否取消注册回调

class ipywidgets.widgets.widget_string.TextStyle(**kwargs)[source]#

基础类: _StringStyle

文本输入样式小部件。

公共构造函数

class ipywidgets.widgets.widget_string.Textarea(**kwargs)[source]#

基类：_String

多行文本区域小部件。

公共构造函数

continuous_update#: 在用户输入时更新值。如果为False，则在提交时更新，例如按下回车键或离开输入框。

disabled#: 启用或禁用用户更改

rows#: 要显示的行数。

包含样式类

class ipywidgets.widgets.widget_style.Style(**kwargs)[source]#

基础类: Widget

样式规范

公共构造函数

TagsInput类。

表示一个标签列表。

class ipywidgets.widgets.widget_tagsinput.ColorsInput(**kwargs)[source]#

基础类: TagsInputBase

颜色标签列表

公共构造函数

value#: 字符串标签列表

class ipywidgets.widgets.widget_tagsinput.FloatsInput(**kwargs)[source]#

基类: NumbersInputBase

浮点标签列表

公共构造函数

value#: 浮点标签列表

class ipywidgets.widgets.widget_tagsinput.IntsInput(**kwargs)[source]#

基类: NumbersInputBase

整数标签列表

公共构造函数

value#: 整数标签列表

class ipywidgets.widgets.widget_tagsinput.NumbersInputBase(**kwargs)[source]#

基类：TagsInput

公共构造函数

class ipywidgets.widgets.widget_tagsinput.TagsInput(**kwargs)[source]#

基础类: TagsInputBase

字符串标签列表

公共构造函数

tag_style#: 为标签使用预定义的样式。

value#: 字符串标签列表

class ipywidgets.widgets.widget_tagsinput.TagsInputBase(**kwargs)[source]#

基础类：DescriptionWidget, ValueWidget, CoreWidget

公共构造函数

将常见的小部件布局实现为可复用的组件

class ipywidgets.widgets.widget_templates.AppLayout(**kwargs)[source]#

基础类: GridBox, LayoutProperties

定义一个小部件类似应用程序的布局。

参数#

页眉: Widget实例左侧边栏: Widget实例中心: Widget实例右侧边栏: Widget实例页脚: Widget实例

用于填充布局中位置的小部件

合并: 布尔值

用于标记是否应自动合并空位的标志

pane_widths: 数字/字符串列表

中央窗格应占据的总布局宽度比例（左侧边栏、中央、右侧边栏）

pane_heights: 数字或字符串列表

面板应占据的垂直空间宽度比例: (左侧边栏, 中心, 右侧边栏)

grid_gapstr

用于设置网格单元格之间间距的CSS属性

justify_contentstr, in [‘flex-start’, ‘flex-end’, ‘center’, ‘space-between’, ‘space-around’]

用于垂直对齐小部件的CSS属性

align_itemsstr, in [‘top’, ‘bottom’, ‘center’, ‘flex-start’, ‘flex-end’, ‘baseline’, ‘stretch’]

用于水平对齐小部件的CSS属性

宽度 : 字符串高度 : 字符串

宽度和高度

示例#

公共构造函数

__init__(**kwargs)[source]#: 公共构造函数

class ipywidgets.widgets.widget_templates.GridspecLayout(**kwargs)[source]#

基础类: GridBox, LayoutProperties

定义一个 N 行 M 列的网格布局

参数#

n_rowsint: 网格中的行数
n_columnsint: 网格中的列数
grid_gapstr: 用于设置网格单元格之间间距的CSS属性
justify_contentstr, in [‘flex-start’, ‘flex-end’, ‘center’, ‘space-between’, ‘space-around’]: 用于垂直对齐小部件的CSS属性
align_itemsstr, in [‘top’, ‘bottom’, ‘center’, ‘flex-start’, ‘flex-end’, ‘baseline’, ‘stretch’]: 用于水平对齐小部件的CSS属性

宽度 : 字符串高度 : 字符串

宽度和高度

示例#

>>> from ipywidgets import GridspecLayout, Button, Layout
>>> layout = GridspecLayout(n_rows=4, n_columns=2, height='200px')
>>> layout[:3, 0] = Button(layout=Layout(height='auto', width='auto'))
>>> layout[1:, 1] = Button(layout=Layout(height='auto', width='auto'))
>>> layout[-1, 0] = Button(layout=Layout(height='auto', width='auto'))
>>> layout[0, 1] = Button(layout=Layout(height='auto', width='auto'))
>>> layout

公共构造函数

__init__(n_rows=None, n_columns=None, **kwargs)[source]#: 公共构造函数

class ipywidgets.widgets.widget_templates.LayoutProperties(**kwargs)[source]#

基础类: HasTraits

布局模板的Mixin类

该类主要处理样式属性（高度、网格间距等）

参数#

grid_gapstr: 用于设置网格单元格之间间距的CSS属性
justify_contentstr, in [‘flex-start’, ‘flex-end’, ‘center’, ‘space-between’, ‘space-around’]: 用于垂直对齐小部件的CSS属性
align_itemsstr, in [‘top’, ‘bottom’, ‘center’, ‘flex-start’, ‘flex-end’, ‘baseline’, ‘stretch’]: 用于水平对齐小部件的CSS属性

宽度 : 字符串高度 : 字符串

宽度和高度

备注#

该类仅意味着作为mixin与其他类一起继承使用。除非定义了self.layout属性，否则它将不起作用。

__init__(**kwargs)[source]#

align_items#: align-items CSS属性。

grid_gap#: grid-gap CSS属性。

height#: CSS宽度属性。

justify_content#: justify-content CSS属性。

width#: CSS宽度属性。

class ipywidgets.widgets.widget_templates.TwoByTwoLayout(**kwargs)[source]#

基础类: GridBox, LayoutProperties

定义一个具有2x2规则网格的布局。

参数#

top_left: Widget实例 top_right: Widget实例 bottom_left: Widget实例 bottom_right: Widget实例

用于填充布局中位置的小部件

合并: 布尔值: 用于标记是否应自动合并空位的标志
grid_gapstr: 用于设置网格单元格之间间距的CSS属性
justify_contentstr, in [‘flex-start’, ‘flex-end’, ‘center’, ‘space-between’, ‘space-around’]: 用于垂直对齐小部件的CSS属性
align_itemsstr, in [‘top’, ‘bottom’, ‘center’, ‘flex-start’, ‘flex-end’, ‘baseline’, ‘stretch’]: 用于水平对齐小部件的CSS属性

宽度 : 字符串高度 : 字符串

宽度和高度

示例#

>>> from ipywidgets import TwoByTwoLayout, Button
>>> TwoByTwoLayout(top_left=Button(description="Top left"),
...                top_right=Button(description="Top right"),
...                bottom_left=Button(description="Bottom left"),
...                bottom_right=Button(description="Bottom right"))

公共构造函数

__init__(**kwargs)[source]#: 公共构造函数

时间选择器小组件

class ipywidgets.widgets.widget_time.TimePicker(**kwargs)[source]#

基础类：DescriptionWidget, ValueWidget, CoreWidget

显示一个用于选择时间的控件。

参数#

value: datetime.time: 该小部件的当前值。
disabled: 布尔值: 是否禁用用户更改。
最小时间: datetime.time: 允许的时间下限
最大值: datetime.time: 允许的时间上限
步长: 浮点型 | '任意': 选择器使用的时间步长，单位为秒，或为“任意”

示例#

>>> import datetime
>>> import ipydatetime
>>> time_pick = ipydatetime.TimePicker()
>>> time_pick.value = datetime.time(12, 34, 3)

公共构造函数

disabled#: 启用或禁用用户更改。

step#: 时间步长，用于选择器，单位为秒，或“任意”。

FileUpload 类。

表示一个文件上传按钮。

class ipywidgets.widgets.widget_upload.FileUpload(**kwargs)[source]#

基础类：DescriptionWidget, ValueWidget, CoreWidget

文件上传小部件

创建一个文件上传输入，允许用户选择一个或多个文件进行上传。文件元数据和内容可以在内核中获取。

>>> import ipywidgets as widgets
>>> uploader = widgets.FileUpload()

# 在显示 uploader 并上传文件后：

>>> uploader.value
[
  {
    'name': 'example.txt',
    'type': 'text/plain',
    'size': 36,
    'last_modified': datetime.datetime(2020, 1, 9, 15, 58, 43, 321000, tzinfo=datetime.timezone.utc),
    'content': <memory at 0x10c1b37c8>
  }
]
>>> uploader.value[0].content.tobytes()
b'This is the content of example.txt.

‘

accept: str, 可选
接受哪些文件类型，例如‘.doc,.docx’。关于如何指定此内容的完整说明，请参阅 https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file#attr-accept 默认接受所有文件类型。

multiple: bool, 可选
是否同时接受多个文件。默认为 False。

disabled: 布尔值, 可选
用户交互是否已启用。

icon: str, 可选
按钮在屏幕上显示的图标。可以是任何Font-awesome图标，去掉fa-前缀。默认为'upload'。如果缺失，则不显示图标。

描述: str, 可选
标签上显示的文本。默认为‘Upload’。

button_style: str, 可选
其中之一为 'primary'、'success'、'info'、'warning'、'danger' 或 ''。

style: widgets.widget_button.ButtonStyle, 选填
按钮的样式配置。

value: Tuple[Dict], 可选
最后上传的文件或文件集的值。有关如何用它来检索文件内容和元数据的详细信息，请参阅文档： https://ipywidgets.readthedocs.io/en/stable/examples/Widget%20List.html#File-Upload

错误：字符串，可选
上次上传是否触发了错误。

公共构造函数

accept#: 接受的文件类型，空字符串表示接受所有

button_style#: 使用预定义的按钮样式。

disabled#: 启用或禁用按钮

error#: 错误信息

icon#: Font-awesome 图标名称，不包含 'fa-' 前缀。

multiple#: 如果为 True，则允许多文件上传

value#: 文件上传值

实用工具#

ipywidgets.widgets.docutils.doc_subst(snippets)[source]#: 在类或函数文档字符串中替换格式化字符串

ipywidgets.widgets.utils.deprecation(message, internal='ipywidgets/widgets/')[source]#

生成一个针对首个非“内部”框架的弃用警告

internal 是一个字符串或字符串列表，如果它们出现在帧中的文件名中，这些帧将被视为内部帧。举例来说，如果我们知道 ipywidgets 内部正在调用 traitlets，修改这个选项可能会很有用。

顶层导出#

这些很少被用户或小部件作者需要

针对Jupyter notebook的交互式部件。

在笔记本中提供简单的交互式控件。每个小部件对应于Python和Javascript中的一个对象，并在页面上提供控件。

要在页面上放置一个Widget，你可以使用Jupyter的展示机制来显示它：

from ipywidgets import IntSlider
slider = IntSlider(min=1, max=10)
display(slider)

移动滑块将改变值。大多数小部件都有一个当前值，可通过 value 属性访问。

ipywidgets.load_ipython_extension(ip)[source]#: 设置Jupyter以使用小部件

ipywidgets.register_comm_target(kernel=None)[source]#: 注册 jupyter.widget 通信目标