widget

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

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

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

基类：LayoutDOM

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

注意

这是一个抽象基类，用于帮助组织 Bokeh 模型类型的层次结构。**它本身没有用处。**

JSON 原型

{
  "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'

类型：:

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

父容器中的对齐点。

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

aspect_ratio = None

类型：:

Either(Null, Auto, Float)

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

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

context_menu = None

类型：:

Nullable(Instance(Menu))

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

注意

右键单击时使用 Shift 键显示本机上下文菜单。

css_classes = []

类型：:

列表

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

css_variables = {}

类型：:

Dict(String, Instance(Node))

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

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

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

注意

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

disabled = False

类型：:

布尔值

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

如果为 True，则小部件将变灰，并且对 UI 事件无响应。

elements = []

类型：:

列表

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

这可能包括工具提示等浮动元素，允许在此处与其他 UI 元素之间建立父子关系。

flow_mode = 'block'

类型：:

Enum(FlowMode)

定义布局将在 block 或 inline 尺寸中流动。

height = None

类型：:

Nullable(NonNegative)

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

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

height_policy = 'auto'

类型：:

Either(Auto, Enum(SizingPolicy))

描述组件应如何维护其高度。

"auto"

使用组件的首选调整大小策略。

"fixed"

使用正好 height 像素。如果组件不能容纳在可用垂直空间中，则组件将溢出。

"fit"

使用组件的首选高度（如果设置）并允许在最小和最大高度边界（如果设置）内适合可用垂直空间。组件的高度既不会被积极地最小化，也不会被最大化。

"min"

使用尽可能少的垂直空间，不小于最小高度（如果设置）。起点是首选高度（如果设置）。组件的高度可能会缩小或增大，具体取决于父布局、纵横比管理和其他因素。

"max"

使用尽可能多的垂直空间，不超过最大高度（如果设置）。起点是首选高度（如果设置）。组件的高度可能会缩小或增大，具体取决于父布局、纵横比管理和其他因素。

注意

这是一个实验性功能，可能会在未来更改。自行决定使用它。如果此级别的控制不是严格必要的，请优先使用 sizing_mode。

margin = 5

类型：:

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

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

max_height = None

类型：:

Nullable(NonNegative)

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

max_width = None

类型：:

Nullable(NonNegative)

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

min_height = None

类型：:

Nullable(NonNegative)

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

min_width = None

类型：:

Nullable(NonNegative)

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

name = None

类型：:

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

类型：:

Either(Bool, Enum(Dimensions))

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

sizing_mode = None

类型：:

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 = {}

类型：:

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

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

stylesheets = []

类型：:

列表

用于底层 DOM 元素的其他样式表。

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

syncable = True

类型：:

布尔值

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

注意

将此属性设置为 False 将阻止此对象上的任何 on_change() 回调触发。但是，任何 JS 侧回调仍然可以正常工作。

tags = []

类型：:

列表

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

当查询文档以检索特定 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

类型：:

布尔值

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

width = None

类型：:

Nullable(NonNegative)

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

这可以是固定宽度或首选宽度，具体取决于宽度大小策略。

width_policy = 'auto'

类型：:

Either(Auto, Enum(SizingPolicy))

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

"auto"

使用组件的首选调整大小策略。

"fixed"

使用完全 width 像素。如果组件无法容纳在可用的水平空间中，它将溢出。

"fit"

使用组件的首选宽度（如果设置）并允许它在最小和最大宽度边界（如果设置）内适应可用的水平空间。组件的宽度既不会被积极地最小化，也不会被积极地最大化。

"min"

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

"max"

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

注意

这是一个实验性功能，可能会在未来更改。自行决定使用它。如果此级别的控制不是严格必要的，请优先使用 sizing_mode。

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

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

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

参数:

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

返回:

None

classmethod clear_extensions() → None

清除任何当前定义的自定义扩展。

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

clone(**overrides: Any) → Self

复制 HasProps 对象。

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

classmethod dataspecs() → dict[str, DataSpec]

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

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

返回:

DataSpec 属性的名称

返回类型:

set[str]

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

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

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等性。

参数:

other (HasProps) – 要比较的另一个实例

返回:

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

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

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

这是一个方便的方法，它简化了添加 CustomJS 回调以在另一个 Bokeh 模型属性更改值时更新一个 Bokeh 模型属性。

参数:

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

• other (Model) – 要链接到 self.attr 的 Bokeh 模型

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

• attr_selector (int | str) – 链接可索引 attr 中项的索引

在版本 1.1 中添加

引发:

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，给定属性名称。

参数:

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

• raises (bool) – 如果缺少，是否引发或返回 None

返回:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

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

在对象上添加一个回调，以便在 attr 更改时触发。

参数:

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

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

返回:

None

示例

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

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

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

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

classmethod parameters() → list[Parameter]

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

返回:

list(Parameter)

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

收集此类上属性的名称。

警告

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

返回:

属性名称

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

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

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

返回:

具有引用的属性的名称

返回类型:

set[str]

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

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

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

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

参数:

include_defaults (bool, optional) – 是否包含自对象创建以来尚未显式设置的属性。 (默认值: True)

返回:

从属性名称到其值的映射

返回类型:

dict

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

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

参数:

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

• include_defaults (bool, optional) – 是否包含用户尚未显式设置的属性 (默认值: True)

返回:

匹配属性的属性名称和值的映射

返回类型:

dict

references() → set[Model]

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

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

从该对象中删除回调

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (JSON-like)

返回:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回:

Model

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

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

参数:

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

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

• setter (ClientSession or ServerSession or None, optional) –

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

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

返回:

None

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

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

参数:

• selector (JSON-like)

• updates (dict)

返回:

None

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

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

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

返回:

dict 或 None

to_serializable(serializer: Serializer) → ObjectRefRep

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

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

unapply_theme() → None

删除任何主题值并恢复默认值。

返回:

None

update(**kwargs: Any) → None

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

返回:

None

示例

以下是等效的

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）