按钮

各种类型的按钮小部件。

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

基类： Widget, ButtonLike

一个基类，定义所有按钮类型的通用属性。

注意

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

JSON 原型

{
  "align": "auto", 
  "aspect_ratio": null, 
  "button_type": "default", 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "disabled": false, 
  "elements": [], 
  "flow_mode": "block", 
  "height": null, 
  "height_policy": "auto", 
  "html_attributes": {
    "type": "map"
  }, 
  "html_id": null, 
  "icon": null, 
  "id": "p66485", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "label": "Button", 
  "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"，组件的首选宽度和高度将用于确定纵横比（如果未设置，则不会保留纵横比）。

button_type = 'default'

类型:

Enum(ButtonType)

按钮的样式，表示其角色。可能的值是以下之一

context_menu = None

类型:

Nullable(Either(Instance(Menu), Enum(Enumeration(auto))))

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

如果设置为 "auto"，组件可以提供动态生成的菜单。例如，Plot 和相关模型提供 ToolMenu 实例，以便轻松访问其工具。

注意

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

css_classes = []

类型:

列表

要添加到底层 DOM 元素的其他 CSS 类的列表。

css_variables = {}

类型:

Dict(String, Either(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。

html_attributes = {}

类型:

Dict(String, String)

允许在底层 HTML 元素上配置 HTML 属性。

html_id = None

类型:

Nullable(String)

设置底层 HTML 元素的 id 属性。

这是常用 HTML id 属性的简写。或者，可以在 html_attributes 字典中设置 id。html_id 优先。

icon = None

类型:

Nullable(Instance(Icon))

显示在按钮文本左侧的可选图像。 Icon 的实例（例如 BuiltinIcon、SVGIcon 或 TablerIcon）。`

label = 'Button'

类型:

Either(Instance(DOMNode), String)

要显示的按钮的 HTML 或纯文本标签。

margin = 5

类型:

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

允许在组件周围创建额外空间。元组中的值按以下顺序排列 - 上边距、右边距、下边距和左边距，类似于 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.scatter([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 的组件都使用 shadow DOM，因此任何包含的样式表都必须反映这一点，例如，使用 :host CSS 伪选择器来访问根 DOM 元素。

syncable = True

类型:

布尔值

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

注意

将此属性设置为 False 将阻止此对象上的任何 on_change() 回调触发。但是，任何 JS 端的回调仍然有效。

tags = []

类型:

列表

要附加到此模型的可选的任意、用户提供的值列表。

此数据在查询文档以检索特定的 Bokeh 模型时可能很有用

>>> r = plot.scatter([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 模型属性的值更改时更新另一个属性。

参数:

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

• other (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。

参数:

• 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

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

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

classmethod parameters() → list[Parameter]

生成适用于从字形派生的函数的 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

返回值:

模型

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

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

参数:

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

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

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

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

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

返回值:

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)

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

基类: AbstractButton

一个点击按钮。

JSON 原型

{
  "align": "auto", 
  "aspect_ratio": null, 
  "button_type": "default", 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "disabled": false, 
  "elements": [], 
  "flow_mode": "block", 
  "height": null, 
  "height_policy": "auto", 
  "html_attributes": {
    "type": "map"
  }, 
  "html_id": null, 
  "icon": null, 
  "id": "p66523", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "label": "Button", 
  "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"，组件的首选宽度和高度将用于确定纵横比（如果未设置，则不会保留纵横比）。

button_type = 'default'

类型:

Enum(ButtonType)

按钮的样式，表示其角色。可能的值是以下之一

context_menu = None

类型:

Nullable(Either(Instance(Menu), Enum(Enumeration(auto))))

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

如果设置为 "auto"，组件可以提供动态生成的菜单。例如，Plot 和相关模型提供 ToolMenu 实例，以便轻松访问其工具。

注意

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

css_classes = []

类型:

列表

要添加到底层 DOM 元素的其他 CSS 类的列表。

css_variables = {}

类型:

Dict(String, Either(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。

html_attributes = {}

类型:

Dict(String, String)

允许在底层 HTML 元素上配置 HTML 属性。

html_id = None

类型:

Nullable(String)

设置底层 HTML 元素的 id 属性。

这是常用 HTML id 属性的简写。或者，可以在 html_attributes 字典中设置 id。html_id 优先。

icon = None

类型:

Nullable(Instance(Icon))

显示在按钮文本左侧的可选图像。 Icon 的实例（例如 BuiltinIcon、SVGIcon 或 TablerIcon）。`

label = 'Button'

类型:

Either(Instance(DOMNode), String)

要显示的按钮的 HTML 或纯文本标签。

margin = 5

类型:

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

允许在组件周围创建额外空间。元组中的值按以下顺序排列 - 上边距、右边距、下边距和左边距，类似于 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.scatter([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 的组件都使用 shadow DOM，因此任何包含的样式表都必须反映这一点，例如，使用 :host CSS 伪选择器来访问根 DOM 元素。

syncable = True

类型:

布尔值

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

注意

将此属性设置为 False 将阻止此对象上的任何 on_change() 回调触发。但是，任何 JS 端的回调仍然有效。

tags = []

类型:

列表

要附加到此模型的可选的任意、用户提供的值列表。

此数据在查询文档以检索特定的 Bokeh 模型时可能很有用

>>> r = plot.scatter([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]

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

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 模型属性的值更改时更新另一个属性。

参数:

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

• other (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)

js_on_click(handler: Callback) → None

为按钮点击设置 JavaScript 处理程序。

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

给定属性名称，查找类上 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_click(handler: EventCallback) → None

为按钮点击设置处理程序。

参数:

handler (func) – 单击按钮时要调用的处理函数。

返回值:

None

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

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

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

classmethod parameters() → list[Parameter]

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

返回值:

list(Parameter)

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

收集此类上的属性名称。

警告

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

返回值:

属性名称

classmethod properties_with_refs() → dict[str, Property]

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

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

返回值:

具有引用的属性的名称

返回类型:

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

返回值:

模型

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

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

参数:

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

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

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

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

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

返回值:

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)

class ButtonLike(*args: Any, **kwargs: Any)

按钮类组件的共享属性。

注意

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

button_type = 'default'

类型:

Enum(ButtonType)

按钮的样式，表示其角色。可能的值是以下之一

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

基类: AbstractButton

下拉按钮。

JSON 原型

{
  "align": "auto", 
  "aspect_ratio": null, 
  "button_type": "default", 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "disabled": false, 
  "elements": [], 
  "flow_mode": "block", 
  "height": null, 
  "height_policy": "auto", 
  "html_attributes": {
    "type": "map"
  }, 
  "html_id": null, 
  "icon": null, 
  "id": "p66568", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "label": "Dropdown", 
  "margin": 5, 
  "max_height": null, 
  "max_width": null, 
  "menu": [], 
  "min_height": null, 
  "min_width": null, 
  "name": null, 
  "resizable": false, 
  "sizing_mode": null, 
  "split": false, 
  "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"，组件的首选宽度和高度将用于确定纵横比（如果未设置，则不会保留纵横比）。

button_type = 'default'

类型:

Enum(ButtonType)

按钮的样式，表示其角色。可能的值是以下之一

context_menu = None

类型:

Nullable(Either(Instance(Menu), Enum(Enumeration(auto))))

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

如果设置为 "auto"，组件可以提供动态生成的菜单。例如，Plot 和相关模型提供 ToolMenu 实例，以便轻松访问其工具。

注意

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

css_classes = []

类型:

列表

要添加到底层 DOM 元素的其他 CSS 类的列表。

css_variables = {}

类型:

Dict(String, Either(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。

html_attributes = {}

类型:

Dict(String, String)

允许在底层 HTML 元素上配置 HTML 属性。

html_id = None

类型:

Nullable(String)

设置底层 HTML 元素的 id 属性。

这是常用 HTML id 属性的简写。或者，可以在 html_attributes 字典中设置 id。html_id 优先。

icon = None

类型:

Nullable(Instance(Icon))

显示在按钮文本左侧的可选图像。 Icon 的实例（例如 BuiltinIcon、SVGIcon 或 TablerIcon）。`

label = 'Dropdown'

类型:

Either(Instance(DOMNode), String)

要显示的按钮的 HTML 或纯文本标签。

margin = 5

类型:

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

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

max_height = None

类型:

Nullable(NonNegative)

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

max_width = None

类型:

Nullable(NonNegative)

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

menu = []

类型:

列表

按钮的下拉菜单，包含条目的文本和值名称。使用 None 作为菜单分隔符。

min_height = None

类型:

Nullable(NonNegative)

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

min_width = None

类型:

Nullable(NonNegative)

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

name = None

类型:

Nullable(String)

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

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

>>> plot.scatter([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"

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

split = False

类型:

布尔值

styles = {}

类型:

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

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

stylesheets = []

类型:

列表

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

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

syncable = True

类型:

布尔值

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

注意

将此属性设置为 False 将阻止此对象上的任何 on_change() 回调触发。但是，任何 JS 端的回调仍然有效。

tags = []

类型:

列表

要附加到此模型的可选的任意、用户提供的值列表。

此数据在查询文档以检索特定的 Bokeh 模型时可能很有用

>>> r = plot.scatter([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 模型属性的值更改时更新另一个属性。

参数:

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

• other (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)

js_on_click(handler: Callback) → None

为按钮或菜单项点击设置 JavaScript 处理器。

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_click(handler: EventCallback) → None

为按钮或菜单项点击设置处理器。

参数:

handler (func) – 按钮激活时调用的处理函数。

返回值:

None

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

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

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

classmethod parameters() → list[Parameter]

生成适用于从字形派生的函数的 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

返回值:

模型

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

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

参数:

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

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

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

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

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

返回值:

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)

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

基类: AbstractButton

一个带有帮助符号的按钮，当鼠标悬停或点击时，会显示额外的文本。

JSON 原型

{
  "align": "auto", 
  "aspect_ratio": null, 
  "button_type": "default", 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "disabled": false, 
  "elements": [], 
  "flow_mode": "block", 
  "height": null, 
  "height_policy": "auto", 
  "html_attributes": {
    "type": "map"
  }, 
  "html_id": null, 
  "icon": {
    "attributes": {
      "icon_name": "help", 
      "size": 18
    }, 
    "id": "p66609", 
    "name": "BuiltinIcon", 
    "type": "object"
  }, 
  "id": "p66608", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "label": "", 
  "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": [], 
  "tooltip": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "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"，组件的首选宽度和高度将用于确定纵横比（如果未设置，则不会保留纵横比）。

button_type = 'default'

类型:

Enum(ButtonType)

按钮的样式，表示其角色。可能的值是以下之一

context_menu = None

类型:

Nullable(Either(Instance(Menu), Enum(Enumeration(auto))))

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

如果设置为 "auto"，组件可以提供动态生成的菜单。例如，Plot 和相关模型提供 ToolMenu 实例，以便轻松访问其工具。

注意

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

css_classes = []

类型:

列表

要添加到底层 DOM 元素的其他 CSS 类的列表。

css_variables = {}

类型:

Dict(String, Either(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。

html_attributes = {}

类型:

Dict(String, String)

允许在底层 HTML 元素上配置 HTML 属性。

html_id = None

类型:

Nullable(String)

设置底层 HTML 元素的 id 属性。

这是常用 HTML id 属性的简写。或者，可以在 html_attributes 字典中设置 id。html_id 优先。

icon = BuiltinIcon(id='p66645', ...)

类型:

Nullable(Instance(Icon))

显示在按钮文本左侧的可选图像。 Icon 的实例（例如 BuiltinIcon、SVGIcon 或 TablerIcon）。`

label = ''

类型:

Either(Instance(DOMNode), String)

要显示的按钮的 HTML 或纯文本标签。

margin = 5

类型:

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

允许在组件周围创建额外空间。元组中的值按以下顺序排列 - 上边距、右边距、下边距和左边距，类似于 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.scatter([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 的组件都使用 shadow DOM，因此任何包含的样式表都必须反映这一点，例如，使用 :host CSS 伪选择器来访问根 DOM 元素。

syncable = True

类型:

布尔值

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

注意

将此属性设置为 False 将阻止此对象上的任何 on_change() 回调触发。但是，任何 JS 端的回调仍然有效。

tags = []

类型:

列表

要附加到此模型的可选的任意、用户提供的值列表。

此数据在查询文档以检索特定的 Bokeh 模型时可能很有用

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

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

注意

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

tooltip = Undefined

类型:

Required(Instance(Tooltip))

一个带有纯文本或富HTML内容的工具提示，提供有关小部件或组件功能的通用帮助或描述。

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 模型属性的值更改时更新另一个属性。

参数:

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

• other (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。

参数:

• 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

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

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

classmethod parameters() → list[Parameter]

生成适用于从字形派生的函数的 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

返回值:

模型

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

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

参数:

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

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

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

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

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

返回值:

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)

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

基类: AbstractButton

一个双状态切换按钮。

JSON 原型

{
  "active": false, 
  "align": "auto", 
  "aspect_ratio": null, 
  "button_type": "default", 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "disabled": false, 
  "elements": [], 
  "flow_mode": "block", 
  "height": null, 
  "height_policy": "auto", 
  "html_attributes": {
    "type": "map"
  }, 
  "html_id": null, 
  "icon": null, 
  "id": "p66680", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "label": "Toggle", 
  "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"
}

active = False

类型:

布尔值

切换按钮的状态。

align = 'auto'

类型:

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

父容器内的对齐点。

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

aspect_ratio = None

类型:

Either(Null, Auto, Float)

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

如果组件的任何尺寸可灵活调整大小，则此功能有效。如果设置为数字，将保持 width / height = aspect_ratio 关系。否则，如果设置为 "auto"，组件的首选宽度和高度将用于确定纵横比（如果未设置，则不会保留纵横比）。

button_type = 'default'

类型:

Enum(ButtonType)

按钮的样式，表示其角色。可能的值是以下之一

context_menu = None

类型:

Nullable(Either(Instance(Menu), Enum(Enumeration(auto))))

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

如果设置为 "auto"，组件可以提供动态生成的菜单。例如，Plot 和相关模型提供 ToolMenu 实例，以便轻松访问其工具。

注意

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

css_classes = []

类型:

列表

要添加到底层 DOM 元素的其他 CSS 类的列表。

css_variables = {}

类型:

Dict(String, Either(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。

html_attributes = {}

类型:

Dict(String, String)

允许在底层 HTML 元素上配置 HTML 属性。

html_id = None

类型:

Nullable(String)

设置底层 HTML 元素的 id 属性。

这是常用 HTML id 属性的简写。或者，可以在 html_attributes 字典中设置 id。html_id 优先。

icon = None

类型:

Nullable(Instance(Icon))

显示在按钮文本左侧的可选图像。 Icon 的实例（例如 BuiltinIcon、SVGIcon 或 TablerIcon）。`

label = 'Toggle'

类型:

Either(Instance(DOMNode), String)

要显示的按钮的 HTML 或纯文本标签。

margin = 5

类型:

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

允许在组件周围创建额外空间。元组中的值按以下顺序排列 - 上边距、右边距、下边距和左边距，类似于 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.scatter([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 的组件都使用 shadow DOM，因此任何包含的样式表都必须反映这一点，例如，使用 :host CSS 伪选择器来访问根 DOM 元素。

syncable = True

类型:

布尔值

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

注意

将此属性设置为 False 将阻止此对象上的任何 on_change() 回调触发。但是，任何 JS 端的回调仍然有效。

tags = []

类型:

列表

要附加到此模型的可选的任意、用户提供的值列表。

此数据在查询文档以检索特定的 Bokeh 模型时可能很有用

>>> r = plot.scatter([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 模型属性的值更改时更新另一个属性。

参数:

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

• other (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)

js_on_click(handler: Callback) → None

为按钮状态更改（点击）设置一个 JavaScript 处理程序。

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_click(handler: Callable[[bool], None]) → None

为按钮状态更改（点击）设置一个处理程序。

参数:

handler (func) – 按钮切换时调用的处理函数。

返回值:

None

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

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

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

classmethod parameters() → list[Parameter]

生成适用于从字形派生的函数的 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

返回值:

模型

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

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

参数:

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

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

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

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

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

返回值:

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)