小部件

为所有Bokeh小部件模型提供一个基类。

除了不同类型的图表外，Bokeh文档中还可以包含各种UI控件（例如滑块、按钮、输入框等）。这些控件可以与在浏览器中执行的CustomJS回调一起使用，或者与在Bokeh服务器上执行的Python回调一起使用。

class Widget(*args: Any, id: ID | None = None, **kwargs: Any)

基础类：LayoutDOM

所有交互式小部件类型的基类。

注意

这是一个抽象基类，用于帮助组织Bokeh模型类型的层次结构。单独实例化它没有用处。

JSON Prototype

{
  "align": "auto", 
  "aspect_ratio": null, 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "disabled": false, 
  "elements": [], 
  "flow_mode": "block", 
  "height": null, 
  "height_policy": "auto", 
  "id": "p66462", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "margin": 5, 
  "max_height": null, 
  "max_width": null, 
  "min_height": null, 
  "min_width": null, 
  "name": null, 
  "resizable": false, 
  "sizing_mode": null, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true, 
  "width": null, 
  "width_policy": "auto"
}

align = 'auto'

Type:

Either(Auto, Enum(Align), Tuple(Enum(Align), Enum(Align)))

父容器内的对齐点。

此属性仅在此组件是布局的子元素（例如网格）时有用。自对齐可以被父容器（例如网格轨道对齐）覆盖。

aspect_ratio = None

Type:

Either(Null, Auto, Float)

描述组件宽度和高度之间的比例关系。

如果组件的任何尺寸是灵活的，这将起作用。如果设置为一个数字，width / height = aspect_ratio 关系将保持不变。否则，如果设置为 "auto"，将使用组件的首选宽度和高度来确定宽高比（如果未设置，则不保留宽高比）。

context_menu = None

Type:

Nullable(Instance(Menu))

当用户右键点击组件时显示的菜单。

注意

右键点击时使用Shift键以显示原生上下文菜单。

css_classes = []

Type:

List

要添加到基础DOM元素的额外CSS类列表。

css_variables = {}

Type:

Dict(String, Instance(Node))

允许定义动态计算的CSS变量。

例如，这可以用于协调canvas渲染器和/或视觉效果与基于HTML的UI元素之间的定位和样式。

这里定义的变量等同于在CSS样式表中的:host { ... }下设置相同的变量。

注意

此属性是实验性的，可能会随时更改。

disabled = False

Type:

Bool

小部件在渲染时是否会被禁用。

如果 True，小部件将变为灰色且不响应UI事件。

elements = []

Type:

List

附加到此窗格的基于DOM的UI元素集合。

这可以包括像工具提示这样的浮动元素，允许在此和其他UI元素之间建立父子关系。

flow_mode = 'block'

Type:

Enum(FlowMode)

定义布局将在block或inline维度中流动。

height = None

Type:

Nullable(NonNegative)

组件的高度（以像素为单位）。

这可以是固定高度或首选高度，取决于高度调整策略。

height_policy = 'auto'

Type:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其高度。

"auto"

使用组件的首选尺寸策略。

"fixed"

使用精确的height像素。如果组件无法适应可用的垂直空间，将会溢出。

"fit"

使用组件的首选高度（如果已设置），并允许在最小和最大高度范围内适应可用的垂直空间（如果已设置）。组件的高度既不会被过度最小化，也不会被过度最大化。

"min"

尽可能使用最少的垂直空间，但不少于最小高度（如果已设置）。 起点是首选高度（如果已设置）。组件的高度可能会根据父布局、宽高比管理和其他因素缩小或增长。

"max"

尽可能使用垂直空间，但不超过最大高度（如果已设置）。 起点是首选高度（如果已设置）。组件的高度可能会根据父布局、宽高比管理和其他因素而缩小或增长。

注意

这是一个实验性功能，未来可能会发生变化。请自行决定是否使用。如果不需要这种级别的控制，建议使用sizing_mode。

margin = 5

Type:

Nullable(Either(Int, Tuple(Int, Int), Tuple(Int, Int, Int, Int)))

允许在组件周围创建额外的空间。 元组中的值按以下顺序排列 - 上边距、右边距、下边距和左边距， 类似于CSS标准。 可以使用负边距值来缩小任何方向的空间。

max_height = None

Type:

Nullable(NonNegative)

如果高度可调，组件的最大高度（以像素为单位）。

max_width = None

Type:

Nullable(NonNegative)

如果宽度可调，组件的最大宽度（以像素为单位）。

min_height = None

Type:

Nullable(NonNegative)

如果高度可调，组件的最小高度（以像素为单位）。

min_width = None

Type:

Nullable(NonNegative)

如果宽度可调，组件的最小宽度（以像素为单位）。

name = None

Type:

Nullable(String)

此模型的任意用户提供的名称。

在查询文档以检索特定Bokeh模型时，此名称可能很有用。

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注意

对于提供的任何名称，没有强制执行唯一性保证或其他条件，Bokeh也不会直接使用这些名称。

resizable = False

Type:

Either(Bool, Enum(Dimensions))

布局是否可交互调整大小，如果是，则在哪些维度上。

sizing_mode = None

Type:

Nullable(Enum(SizingMode))

组件应如何调整自身大小。

这是一个用于维护组件宽度和高度的全局设置。要获得更精细的尺寸控制，请使用 width_policy、height_policy 和 aspect_ratio（这些设置优先于 sizing_mode）。

可能的场景：

"inherit"

尺寸模式继承自父布局。如果没有父布局（或父布局不是布局），则此值被视为未提供sizing_mode的值。

"fixed"

组件不具备响应性。无论浏览器窗口如何调整大小，它都将保持其原始的宽度和高度。

"stretch_width"

组件将响应式地调整大小以拉伸到可用宽度，而不保持任何宽高比。组件的高度取决于组件的类型，可能是固定的或适应组件的内容。

"stretch_height"

组件将响应式地调整大小以拉伸到可用高度，而不保持任何宽高比。组件的宽度取决于组件的类型，可能是固定的或适应组件的内容。

"stretch_both"

组件完全响应，宽度和高度独立，并且将占据所有可用的水平和垂直空间，即使这会改变组件的宽高比。

"scale_width"

组件将响应式调整大小以拉伸到可用宽度，同时保持原始或提供的宽高比。

"scale_height"

组件将响应式地调整大小以拉伸到可用高度，同时保持原始或提供的宽高比。

"scale_both"

组件将根据可用的宽度和高度进行响应式调整大小，同时保持原始或提供的宽高比。

styles = {}

Type:

Either(Dict(String, Nullable(String)), Instance(Styles))

应用于底层DOM元素的内联CSS样式。

stylesheets = []

Type:

List

用于底层DOM元素的附加样式表。

请注意，所有Bokeh的组件都使用影子DOM，因此任何包含的样式表都必须反映这一点，例如使用:host CSS伪选择器来访问根DOM元素。

syncable = True

Type:

Bool

指示当在网页浏览器中更新时，此模型是否应同步回Bokeh服务器。设置为False可能有助于在处理频繁更新的对象时减少网络流量，这些对象的更新值我们不需要。

注意

将此属性设置为False将阻止此对象上的任何on_change()回调触发。然而，任何JS端的回调仍然会工作。

tags = []

Type:

List

一个可选的任意用户提供的值列表，用于附加到此模型。

在查询文档以检索特定Bokeh模型时，这些数据可能很有用：

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

或者只是将任何必要的元数据附加到模型的一种便捷方式，这些元数据可以通过CustomJS回调等方式访问。

注意

对于提供的任何标签，没有强制执行唯一性保证或其他条件，Bokeh也不会出于任何原因直接使用这些标签。

visible = True

Type:

Bool

组件是否应该在屏幕上显示。

width = None

Type:

Nullable(NonNegative)

组件的宽度（以像素为单位）。

这可以是固定宽度或首选宽度，取决于宽度调整策略。

width_policy = 'auto'

Type:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其宽度。

"auto"

使用组件的首选尺寸策略。

"fixed"

使用精确的width像素。如果组件无法适应可用的水平空间，将会溢出。

"fit"

使用组件的首选宽度（如果已设置），并允许其在最小和最大宽度范围内（如果已设置）适应可用的水平空间。组件的宽度既不会被过度最小化，也不会被过度最大化。

"min"

尽可能少地使用水平空间，但不少于最小宽度（如果已设置）。起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、宽高比管理和其他因素而缩小或增长。

"max"

尽可能使用水平空间，但不超过最大宽度（如果已设置）。 起点是首选宽度（如果已设置）。组件的宽度可能会根据父布局、宽高比管理和其他因素而缩小或增长。

注意

这是一个实验性功能，未来可能会发生变化。请自行决定是否使用。如果不需要这种级别的控制，建议使用sizing_mode。

apply_theme(property_values: dict[str, Any]) → None

应用一组主题值，这些值将用于替代默认值，但不会覆盖应用程序设置的值。

传入的字典可能会保持原样并与其他实例共享以节省内存（因此调用者和HasProps实例都不应修改它）。

Parameters:

property_values (dict) – 用于替换默认值的主题值

Returns:

无

classmethod clear_extensions() → None

清除当前定义的所有自定义扩展。

序列化调用将导致任何当前定义的自定义扩展被包含在生成的文档中，无论是否被使用。此方法可用于清除所有现有的自定义扩展定义。

clone(**overrides: Any) → Self

复制一个HasProps对象。

这将创建原始模型的浅克隆，即任何可变的容器或子模型将不会被复制。允许在克隆时覆盖特定属性。

classmethod dataspecs() → dict[str, DataSpec]

收集此类上所有DataSpec属性的名称。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

Returns:

DataSpec 属性的名称

Return type:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

属性描述符的列表，按定义的顺序排列。

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

Parameters:

其他 (HasProps) – 要比较的其他实例

Returns:

如果属性在结构上相等，则为True，否则为False

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

使用JavaScript链接两个Bokeh模型属性。

这是一个便捷的方法，简化了添加一个 CustomJS 回调的过程，以便在另一个属性值发生变化时更新一个 Bokeh 模型属性。

Parameters:

• attr (str) – 此模型上的Bokeh属性的名称

• 其他 (Model) – 一个要链接到 self.attr 的 Bokeh 模型

• other_attr (str) – 要链接在一起的other上的属性

• attr_selector (int | str) – 用于链接可下标对象 attr 中项目的索引

在版本1.1中添加

Raises:

ValueError –

示例

这段代码使用了 js_link:

select.js_link('value', plot, 'sizing_mode')

等同于以下内容：

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

此外，使用attr_selector将范围滑块的左侧附加到绘图的x_range：

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

这相当于：

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

将一个CustomJS回调附加到任意的BokehJS模型事件。

在BokehJS方面，模型属性的更改事件具有"change:property_name"的形式。为了方便起见，如果传递给此方法的事件名称也是模型上属性的名称，那么它将自动加上"change:"前缀：

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

然而，除了属性更改事件之外，还有其他类型的事件可能对响应有用。例如，每当数据流式传输到ColumnDataSource时运行回调，可以在源上使用"stream"事件：

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

在类上找到Bokeh属性的PropertyDescriptor，给定属性名称。

Parameters:

• name (str) – 要搜索的属性的名称

• raises (bool) – 如果缺失，是抛出异常还是返回None

Returns:

名为name的属性的描述符

Return type:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

在此对象上添加一个回调，当attr发生变化时触发。

Parameters:

• attr (str) – 此对象上的一个属性名称

• *callbacks (callable) – 要注册的回调函数

Returns:

无

示例

widget.on_change('value', callback1, callback2, ..., callback_n)

on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) → None

当此模型上发生指定事件时运行回调

并非所有模型都支持所有事件。 有关哪些模型能够触发它们的更多信息，请参阅bokeh.events中的特定事件。

classmethod parameters() → list[Parameter]

生成适用于从字形派生的函数的Python Parameter值。

Returns:

列表(参数)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

收集此类的属性名称。

警告

在Bokeh的未来版本中，此方法将返回一个将属性名称映射到属性对象的字典。为了使当前使用此方法的方式具有未来兼容性，请将返回值包装在list中。

Returns:

属性名称

classmethod properties_with_refs() → dict[str, Property[Any]]

收集此类上所有具有引用的属性的名称。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

Returns:

具有引用的属性名称

Return type:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

收集一个将属性名称映射到其值的字典。

此方法始终遍历类层次结构，并包括在任何父类上定义的属性。

不可序列化的属性将被跳过，属性值以“序列化”格式呈现，这可能与您通常从属性中读取的值略有不同；此方法的目的是返回无损重构对象实例所需的信息。

Parameters:

include_defaults (bool, optional) – 是否包含自对象创建以来未明确设置的属性。（默认值：True）

Returns:

从属性名称到其值的映射

Return type:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

使用谓词查询HasProps实例的属性值。

Parameters:

• query (callable) – 一个可调用对象，接受属性描述符并返回 True 或 False

• include_defaults (bool, optional) – 是否包含用户未明确设置的属性（默认值：True）

Returns:

属性名称和值的映射，用于匹配属性

Return type:

dict

references() → set[Model]

返回此对象引用的所有Models。

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

从此对象中移除一个回调函数

select(selector: SelectorType) → Iterable[Model]

查询此对象及其所有引用，以查找与给定选择器匹配的对象。

Parameters:

selector (类似JSON的)

Returns:

序列[模型]

select_one(selector: SelectorType) → Model | None

查询此对象及其所有引用，以查找与给定选择器匹配的对象。如果找到多个对象，则引发错误。返回单个匹配对象，如果未找到任何内容，则返回None :param selector: :type selector: JSON-like

Returns:

模型

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

从JSON设置此对象的属性值。

Parameters:

• name (str) – 要设置的属性名称

• value (JSON-value) – 要设置给属性的值

• setter (ClientSession 或 ServerSession 或 None, 可选) –

  这用于防止对Bokeh应用程序的“回旋镖”更新。

  在Bokeh服务器应用程序的上下文中，对属性的传入更新将使用正在执行更新的会话进行注释。此值通过更新触发的任何后续更改通知传播。会话可以将事件设置器与自身进行比较，并抑制源自自身的任何更新。

Returns:

无

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

使用指定的属性/值更新来更新与给定选择器匹配的对象。

Parameters:

• selector (类似JSON的)

• 更新 (dict)

Returns:

无

themed_values() → dict[str, Any] | None

获取任何主题提供的覆盖。

结果以属性名称到值的字典形式返回，如果此实例没有主题覆盖任何值，则返回None。

Returns:

字典或无

to_serializable(serializer: Serializer) → ObjectRefRep

将此对象转换为可序列化的表示形式。

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

移除任何主题值并恢复默认设置。

Returns:

无

update(**kwargs: Any) → None

从给定的关键字参数更新对象的属性。

Returns:

无

示例

以下是等价的：

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

此模型附加到的Document（可以为None）