组

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

基类：Widget

所有类型组的抽象基类。

注意

这是一个抽象基类，用于帮助组织 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": "p64480", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "labels": [], 
  "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。

labels = []

类型:

列表

此组中包含的文本标签列表。

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.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 组件都使用 Shadow 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 模型属性。

参数：

• 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

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

并非所有模型都支持所有事件。有关哪些模型能够触发它们的更多信息，请参阅 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）

返回值：

属性名称与其值的映射

返回类型：

字典

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）

返回值：

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

返回类型：

字典

references() → set[Model]

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

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

从此对象中删除回调

select(selector: SelectorType) → Iterable[Model]

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

参数：

selector (类 JSON)

返回值：

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-value) – 要设置为属性的值

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

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

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

返回值：

None

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

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

参数：

• selector (类 JSON)

• updates (dict)

返回值：

None

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

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

结果作为从属性名称到值的字典返回，如果主题未覆盖此实例的任何值，则返回 None。

返回值：

字典或 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 CheckboxButtonGroup(*args: Any, id: ID | None = None, **kwargs: Any)

基类: ToggleButtonGroup

作为切换按钮呈现的一组复选框。

JSON 原型

{
  "active": [], 
  "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", 
  "id": "p64507", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "labels": [], 
  "margin": 5, 
  "max_height": null, 
  "max_width": null, 
  "min_height": null, 
  "min_width": null, 
  "name": null, 
  "orientation": "horizontal", 
  "resizable": false, 
  "sizing_mode": null, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true, 
  "width": null, 
  "width_policy": "auto"
}

active = []

类型:

列表

选定复选框的索引列表。

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

labels = []

类型:

列表

此组中包含的文本标签列表。

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

注意

不保证任何提供的名称的唯一性或其他条件，Bokeh 也不会出于任何原因直接使用该名称。

orientation = 'horizontal'

类型:

Enum(Enumeration(horizontal, vertical))

水平（默认）或垂直方向排列按钮组。

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.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 模型属性。

参数：

• 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

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

并非所有模型都支持所有事件。有关哪些模型能够触发它们的更多信息，请参阅 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）

返回值：

属性名称与其值的映射

返回类型：

字典

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）

返回值：

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

返回类型：

字典

references() → set[Model]

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

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

从此对象中删除回调

select(selector: SelectorType) → Iterable[Model]

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

参数：

selector (类 JSON)

返回值：

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-value) – 要设置为属性的值

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

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

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

返回值：

None

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

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

参数：

• selector (类 JSON)

• updates (dict)

返回值：

None

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

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

结果作为从属性名称到值的字典返回，如果主题未覆盖此实例的任何值，则返回 None。

返回值：

字典或 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 复选框组(*args: Any, id: ID | None = None, **kwargs: Any)

基类: 切换输入组

一组复选框。

JSON 原型

{
  "active": [], 
  "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": "p64544", 
  "inline": false, 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "labels": [], 
  "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 = []

类型:

列表

选定复选框的索引列表。

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。

inline = False

类型:

布尔值

项目是否应垂直排列（False）或水平内联排列（True）。

labels = []

类型:

列表

此组中包含的文本标签列表。

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.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 组件都使用 Shadow 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 模型属性。

参数：

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

类方法 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 中的特定事件。

类方法 parameters() → list[Parameter]

生成适合从 Glyph 派生的函数的 Python Parameter 值。

返回值：

list(Parameter)

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

收集此类上的属性名称。

警告

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

返回值：

属性名称

类方法 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）

返回值：

属性名称与其值的映射

返回类型：

字典

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）

返回值：

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

返回类型：

字典

references() → set[Model]

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

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

从此对象中删除回调

select(selector: SelectorType) → Iterable[Model]

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

参数：

selector (类 JSON)

返回值：

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-value) – 要设置为属性的值

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

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

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

返回值：

None

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

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

参数：

• selector (类 JSON)

• updates (dict)

返回值：

None

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

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

结果作为从属性名称到值的字典返回，如果主题未覆盖此实例的任何值，则返回 None。

返回值：

字典或 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 RadioButtonGroup(*args: Any, id: ID | None = None, **kwargs: Any)

基类: ToggleButtonGroup

一组作为切换按钮呈现的单选框。

JSON 原型

{
  "active": null, 
  "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", 
  "id": "p64573", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "labels": [], 
  "margin": 5, 
  "max_height": null, 
  "max_width": null, 
  "min_height": null, 
  "min_width": null, 
  "name": null, 
  "orientation": "horizontal", 
  "resizable": false, 
  "sizing_mode": null, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "visible": true, 
  "width": null, 
  "width_policy": "auto"
}

active = None

类型:

Nullable(Int)

所选单选框的索引，如果未选择任何内容，则为None。

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

labels = []

类型:

列表

此组中包含的文本标签列表。

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

注意

不保证任何提供的名称的唯一性或其他条件，Bokeh 也不会出于任何原因直接使用该名称。

orientation = 'horizontal'

类型:

Enum(Enumeration(horizontal, vertical))

水平（默认）或垂直方向排列按钮组。

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.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 模型属性。

参数：

• 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

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

并非所有模型都支持所有事件。有关哪些模型能够触发它们的更多信息，请参阅 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）

返回值：

属性名称与其值的映射

返回类型：

字典

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）

返回值：

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

返回类型：

字典

references() → set[Model]

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

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

从此对象中删除回调

select(selector: SelectorType) → Iterable[Model]

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

参数：

selector (类 JSON)

返回值：

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-value) – 要设置为属性的值

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

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

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

返回值：

None

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

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

参数：

• selector (类 JSON)

• updates (dict)

返回值：

None

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

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

结果作为从属性名称到值的字典返回，如果主题未覆盖此实例的任何值，则返回 None。

返回值：

字典或 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 RadioGroup(*args: Any, id: ID | None = None, **kwargs: Any)

基类: 切换输入组

一组单选框。

JSON 原型

{
  "active": null, 
  "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": "p64610", 
  "inline": false, 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "labels": [], 
  "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 = None

类型:

Nullable(Int)

所选单选框的索引，如果未选择任何内容，则为None。

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。

inline = False

类型:

布尔值

项目是否应垂直排列（False）或水平内联排列（True）。

labels = []

类型:

列表

此组中包含的文本标签列表。

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.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 组件都使用 Shadow 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 模型属性。

参数：

• 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

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

并非所有模型都支持所有事件。有关哪些模型能够触发它们的更多信息，请参阅 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）

返回值：

属性名称与其值的映射

返回类型：

字典

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）

返回值：

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

返回类型：

字典

references() → set[Model]

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

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

从此对象中删除回调

select(selector: SelectorType) → Iterable[Model]

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

参数：

selector (类 JSON)

返回值：

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-value) – 要设置为属性的值

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

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

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

返回值：

None

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

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

参数：

• selector (类 JSON)

• updates (dict)

返回值：

None

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

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

结果作为从属性名称到值的字典返回，如果主题未覆盖此实例的任何值，则返回 None。

返回值：

字典或 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 ToggleButtonGroup(*args: Any, id: ID | None = None, **kwargs: Any)

基类：AbstractGroup，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", 
  "id": "p64639", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "labels": [], 
  "margin": 5, 
  "max_height": null, 
  "max_width": null, 
  "min_height": null, 
  "min_width": null, 
  "name": null, 
  "orientation": "horizontal", 
  "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(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。

labels = []

类型:

列表

此组中包含的文本标签列表。

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

注意

不保证任何提供的名称的唯一性或其他条件，Bokeh 也不会出于任何原因直接使用该名称。

orientation = 'horizontal'

类型:

Enum(Enumeration(horizontal, vertical))

水平（默认）或垂直方向排列按钮组。

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.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 模型属性。

参数：

• 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

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

并非所有模型都支持所有事件。有关哪些模型能够触发它们的更多信息，请参阅 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）

返回值：

属性名称与其值的映射

返回类型：

字典

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）

返回值：

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

返回类型：

字典

references() → set[Model]

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

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

从此对象中删除回调

select(selector: SelectorType) → Iterable[Model]

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

参数：

selector (类 JSON)

返回值：

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-value) – 要设置为属性的值

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

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

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

返回值：

None

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

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

参数：

• selector (类 JSON)

• updates (dict)

返回值：

None

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

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

结果作为从属性名称到值的字典返回，如果主题未覆盖此实例的任何值，则返回 None。

返回值：

字典或 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 ToggleInputGroup(*args: Any, id: ID | None = None, **kwargs: Any)

基类: AbstractGroup

以复选框/单选框渲染项目的组的抽象基类。

注意

这是一个抽象基类，用于帮助组织 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": "p64675", 
  "inline": false, 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "labels": [], 
  "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。

inline = False

类型:

布尔值

项目是否应垂直排列（False）或水平内联排列（True）。

labels = []

类型:

列表

此组中包含的文本标签列表。

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.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 组件都使用 Shadow 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 模型属性。

参数：

• 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

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

并非所有模型都支持所有事件。有关哪些模型能够触发它们的更多信息，请参阅 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）

返回值：

属性名称与其值的映射

返回类型：

字典

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）

返回值：

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

返回类型：

字典

references() → set[Model]

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

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

从此对象中删除回调

select(selector: SelectorType) → Iterable[Model]

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

参数：

selector (类 JSON)

返回值：

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-value) – 要设置为属性的值

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

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

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

返回值：

None

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

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

参数：

• selector (类 JSON)

• updates (dict)

返回值：

None

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

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

结果作为从属性名称到值的字典返回，如果主题未覆盖此实例的任何值，则返回 None。

返回值：

字典或 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）