布局

各种布局组件。

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

基类: FlexBox

将子组件在单个垂直列中布局。

子组件可以作为位置参数指定，也可以作为单个序列参数指定，或者使用 children 关键字参数指定。

JSON 原型

{
  "align": "auto", 
  "aspect_ratio": null, 
  "children": [], 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "disabled": false, 
  "elements": [], 
  "flow_mode": "block", 
  "height": null, 
  "height_policy": "auto", 
  "id": "p59346", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "margin": null, 
  "max_height": null, 
  "max_width": null, 
  "min_height": null, 
  "min_width": null, 
  "name": null, 
  "resizable": false, 
  "sizing_mode": null, 
  "spacing": 0, 
  "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"，则将使用组件的首选宽度和高度来确定纵横比（如果未设置，则不会保留任何纵横比）。

children = []

类型:

列表

子组件列表，可以是其他组件，包括绘图、行、列和小部件。

context_menu = None

类型:

Nullable(Instance(‘.models.ui.Menu’))

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

注意

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

css_classes = []

类型:

列表

要添加到底层 DOM 元素的一系列附加 CSS 类。

css_variables = {}

类型:

Dict(String, Instance(Node))

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

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

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

注意

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

disabled = False

类型:

布尔值

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

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

elements = []

类型:

列表

附加到此窗格的一系列基于 DOM 的 UI 元素。

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

flow_mode = 'block'

类型:

Enum(FlowMode)

定义布局是否在 block 或 inline 维度上流动。

height = None

类型:

Nullable(NonNegative)

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

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

height_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

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

"auto"

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

"fixed"

使用正好 height 像素。如果组件无法适应可用垂直空间，则会溢出。

"fit"

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

"min"

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

"max"

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

注意

这是一个实验性功能，将来可能会更改。请自行谨慎使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

margin = None

类型:

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"

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

spacing = 0

类型:

Int

子元素之间的间隙（以像素为单位）。

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) – 用于代替默认值的主题值

返回值：

无

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) – 要注册的回调函数

返回值：

无

示例

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-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) : 要设置的属性的名称

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

• models (dict 或 None, 可选) –

  模型 ID 到模型的映射（默认值：None）

  当要更新的属性的值也包含引用时，需要此参数。

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

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

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

返回值：

无

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

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

参数：

• selector (JSON-like)

• updates (dict)

返回值：

无

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

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

返回值：

无

update(**kwargs: Any) → 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)

属性 document: Document | None

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

类 FlexBox(*args: Any, id: ID | None = None, **kwargs: Any)

基类：LayoutDOM

Row 和 Column 的抽象基类。不要直接使用。

注意

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

JSON 原型

{
  "align": "auto", 
  "aspect_ratio": null, 
  "children": [], 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "disabled": false, 
  "elements": [], 
  "flow_mode": "block", 
  "height": null, 
  "height_policy": "auto", 
  "id": "p59374", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "margin": null, 
  "max_height": null, 
  "max_width": null, 
  "min_height": null, 
  "min_width": null, 
  "name": null, 
  "resizable": false, 
  "sizing_mode": null, 
  "spacing": 0, 
  "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"，则将使用组件的首选宽度和高度来确定纵横比（如果未设置，则不会保留任何纵横比）。

children = []

类型:

列表

子组件列表，可以是其他组件，包括绘图、行、列和小部件。

context_menu = None

类型:

Nullable(Instance(‘.models.ui.Menu’))

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

注意

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

css_classes = []

类型:

列表

要添加到底层 DOM 元素的一系列附加 CSS 类。

css_variables = {}

类型:

Dict(String, Instance(Node))

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

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

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

注意

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

disabled = False

类型:

布尔值

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

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

elements = []

类型:

列表

附加到此窗格的一系列基于 DOM 的 UI 元素。

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

flow_mode = 'block'

类型:

Enum(FlowMode)

定义布局是否在 block 或 inline 维度上流动。

height = None

类型:

Nullable(NonNegative)

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

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

height_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

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

"auto"

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

"fixed"

使用正好 height 像素。如果组件无法适应可用垂直空间，则会溢出。

"fit"

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

"min"

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

"max"

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

注意

这是一个实验性功能，将来可能会更改。请自行谨慎使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

margin = None

类型:

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"

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

spacing = 0

类型:

Int

子元素之间的间隙（以像素为单位）。

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) – 用于代替默认值的主题值

返回值：

无

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) – 要注册的回调函数

返回值：

无

示例

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-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) : 要设置的属性的名称

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

• models (dict 或 None, 可选) –

  模型 ID 到模型的映射（默认值：None）

  当要更新的属性的值也包含引用时，需要此参数。

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

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

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

返回值：

无

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

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

参数：

• selector (JSON-like)

• updates (dict)

返回值：

无

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

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

返回值：

无

update(**kwargs: Any) → 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 GridBox(*args: Any, id: ID | None = None, **kwargs: Any)

基类: LayoutDOM, GridCommon

基于 CSS 网格的网格容器。

JSON 原型

{
  "align": "auto", 
  "aspect_ratio": null, 
  "children": [], 
  "cols": null, 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "disabled": false, 
  "elements": [], 
  "flow_mode": "block", 
  "height": null, 
  "height_policy": "auto", 
  "id": "p59402", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "margin": null, 
  "max_height": null, 
  "max_width": null, 
  "min_height": null, 
  "min_width": null, 
  "name": null, 
  "resizable": false, 
  "rows": null, 
  "sizing_mode": null, 
  "spacing": 0, 
  "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"，则将使用组件的首选宽度和高度来确定纵横比（如果未设置，则不会保留任何纵横比）。

children = []

类型:

列表

子元素列表及其在网格中的关联位置（行、列）。

cols = None

类型:

Nullable(Either(Either(String, Struct), List, Dict(Int, Either(String, Struct))))

描述网格如何维护其列的宽度。

这映射到 CSS 网格的轨道大小选项。特别是允许以下值

• 长度，例如 100px、5.5em

• 百分比，例如 33%

• 弹性，例如 1fr

• 枚举，例如 max-content、min-content、auto 等。

如果提供单个值，则它应用于所有列。可以提供值列表来调整所有列的大小，或者提供字典来为各个列设置大小。

有关详细信息，请参阅 https://mdn.org.cn/en-US/docs/Web/CSS/grid-template-columns 或 https://w3c.github.io/csswg-drafts/css-grid/#track-sizing。

context_menu = None

类型:

Nullable(Instance(‘.models.ui.Menu’))

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

注意

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

css_classes = []

类型:

列表

要添加到底层 DOM 元素的一系列附加 CSS 类。

css_variables = {}

类型:

Dict(String, Instance(Node))

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

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

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

注意

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

disabled = False

类型:

布尔值

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

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

elements = []

类型:

列表

附加到此窗格的一系列基于 DOM 的 UI 元素。

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

flow_mode = 'block'

类型:

Enum(FlowMode)

定义布局是否在 block 或 inline 维度上流动。

height = None

类型:

Nullable(NonNegative)

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

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

height_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

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

"auto"

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

"fixed"

使用正好 height 像素。如果组件无法适应可用垂直空间，则会溢出。

"fit"

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

"min"

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

"max"

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

注意

这是一个实验性功能，将来可能会更改。请自行谨慎使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

margin = None

类型:

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

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

rows = None

类型:

Nullable(Either(Either(String, Struct), List, Dict(Int, Either(String, Struct))))

描述网格如何维护其行的高度。

这映射到 CSS 网格的轨道大小选项。特别是允许以下值

• 长度，例如 100px、5.5em

• 百分比，例如 33%

• 弹性，例如 1fr

• 枚举，例如 max-content、min-content、auto 等。

如果提供单个值，则它应用于所有行。可以提供值列表来调整所有行的大小，或者提供字典来为各个行设置大小。

有关详细信息，请参阅 https://mdn.org.cn/en-US/docs/Web/CSS/grid-template-rows 或 https://w3c.github.io/csswg-drafts/css-grid/#track-sizing。

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"

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

spacing = 0

类型:

Either(NonNegative, Tuple(NonNegative, NonNegative))

子元素之间的间隙（以像素为单位）。

如果间距在两个维度上都相同，则为数字；否则为一对数字，分别表示垂直和水平方向上的间距。

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) – 用于代替默认值的主题值

返回值：

无

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) – 要注册的回调函数

返回值：

无

示例

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-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) : 要设置的属性的名称

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

• models (dict 或 None, 可选) –

  模型 ID 到模型的映射（默认值：None）

  当要更新的属性的值也包含引用时，需要此参数。

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

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

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

返回值：

无

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

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

参数：

• selector (JSON-like)

• updates (dict)

返回值：

无

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

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

返回值：

无

update(**kwargs: Any) → 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 GroupBox(*args: Any, id: ID | None = None, **kwargs: Any)

基类：LayoutDOM

一个用于分组 UI 元素的面板。

JSON 原型

{
  "align": "auto", 
  "aspect_ratio": null, 
  "checkable": false, 
  "child": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "disabled": false, 
  "elements": [], 
  "flow_mode": "block", 
  "height": null, 
  "height_policy": "auto", 
  "id": "p59432", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "margin": null, 
  "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": [], 
  "title": null, 
  "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"，则将使用组件的首选宽度和高度来确定纵横比（如果未设置，则不会保留任何纵横比）。

checkable = False

类型:

布尔值

是否允许通过 UI 中的复选框禁用此组（其所有子元素）。这允许在支持该状态的多个 UI 控件之间广播 disabled 状态。

child = Undefined

类型:

Instance(UIElement)

子 UI 元素。它可以是单个 UI 控件、小部件等，也可以是 Column 或 Row 等容器布局，或者布局的组合。

context_menu = None

类型:

Nullable(Instance(‘.models.ui.Menu’))

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

注意

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

css_classes = []

类型:

列表

要添加到底层 DOM 元素的一系列附加 CSS 类。

css_variables = {}

类型:

Dict(String, Instance(Node))

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

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

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

注意

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

disabled = False

类型:

布尔值

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

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

elements = []

类型:

列表

附加到此窗格的一系列基于 DOM 的 UI 元素。

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

flow_mode = 'block'

类型:

Enum(FlowMode)

定义布局是否在 block 或 inline 维度上流动。

height = None

类型:

Nullable(NonNegative)

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

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

height_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

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

"auto"

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

"fixed"

使用正好 height 像素。如果组件无法适应可用垂直空间，则会溢出。

"fit"

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

"min"

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

"max"

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

注意

这是一个实验性功能，将来可能会更改。请自行谨慎使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

margin = None

类型:

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 也不会出于任何原因直接使用这些标签。

title = None

类型:

Nullable(String)

组的标题文本。如果未提供，则仅显示框架。

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) – 用于代替默认值的主题值

返回值：

无

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) – 要注册的回调函数

返回值：

无

示例

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-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) : 要设置的属性的名称

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

• models (dict 或 None, 可选) –

  模型 ID 到模型的映射（默认值：None）

  当要更新的属性的值也包含引用时，需要此参数。

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

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

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

返回值：

无

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

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

参数：

• selector (JSON-like)

• updates (dict)

返回值：

无

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

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

返回值：

无

update(**kwargs: Any) → 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 HBox(*args: Any, id: ID | None = None, **kwargs: Any)

基类：LayoutDOM

基于 CSS 网格的水平盒子。

JSON 原型

{
  "align": "auto", 
  "aspect_ratio": null, 
  "children": [], 
  "cols": null, 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "disabled": false, 
  "elements": [], 
  "flow_mode": "block", 
  "height": null, 
  "height_policy": "auto", 
  "id": "p59461", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "margin": null, 
  "max_height": null, 
  "max_width": null, 
  "min_height": null, 
  "min_width": null, 
  "name": null, 
  "resizable": false, 
  "sizing_mode": null, 
  "spacing": 0, 
  "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"，则将使用组件的首选宽度和高度来确定纵横比（如果未设置，则不会保留任何纵横比）。

children = []

类型:

列表

子元素列表及其在水平盒子中的关联位置（可选；列号、跨度）。

cols = None

类型:

Nullable(Either(Either(String, Struct), List, Dict(Int, Either(String, Struct))))

描述网格如何维护其列的宽度。

context_menu = None

类型:

Nullable(Instance(‘.models.ui.Menu’))

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

注意

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

css_classes = []

类型:

列表

要添加到底层 DOM 元素的一系列附加 CSS 类。

css_variables = {}

类型:

Dict(String, Instance(Node))

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

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

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

注意

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

disabled = False

类型:

布尔值

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

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

elements = []

类型:

列表

附加到此窗格的一系列基于 DOM 的 UI 元素。

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

flow_mode = 'block'

类型:

Enum(FlowMode)

定义布局是否在 block 或 inline 维度上流动。

height = None

类型:

Nullable(NonNegative)

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

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

height_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

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

"auto"

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

"fixed"

使用正好 height 像素。如果组件无法适应可用垂直空间，则会溢出。

"fit"

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

"min"

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

"max"

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

注意

这是一个实验性功能，将来可能会更改。请自行谨慎使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

margin = None

类型:

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"

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

spacing = 0

类型:

非负数

子元素之间的间隙（以像素为单位）。

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) – 用于代替默认值的主题值

返回值：

无

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) – 要注册的回调函数

返回值：

无

示例

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-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) : 要设置的属性的名称

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

• models (dict 或 None, 可选) –

  模型 ID 到模型的映射（默认值：None）

  当要更新的属性的值也包含引用时，需要此参数。

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

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

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

返回值：

无

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

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

参数：

• selector (JSON-like)

• updates (dict)

返回值：

无

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

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

返回值：

无

update(**kwargs: Any) → 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 LayoutDOM(*args: Any, id: ID | None = None, **kwargs: Any)

基类：Pane

布局组件的基类。

注意

这是一个抽象基类，用于帮助组织 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": "p59490", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "margin": null, 
  "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(‘.models.ui.Menu’))

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

注意

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

css_classes = []

类型:

列表

要添加到底层 DOM 元素的一系列附加 CSS 类。

css_variables = {}

类型:

Dict(String, Instance(Node))

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

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

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

注意

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

disabled = False

类型:

布尔值

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

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

elements = []

类型:

列表

附加到此窗格的一系列基于 DOM 的 UI 元素。

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

flow_mode = 'block'

类型:

Enum(FlowMode)

定义布局是否在 block 或 inline 维度上流动。

height = None

类型:

Nullable(NonNegative)

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

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

height_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

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

"auto"

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

"fixed"

使用正好 height 像素。如果组件无法适应可用垂直空间，则会溢出。

"fit"

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

"min"

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

"max"

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

注意

这是一个实验性功能，将来可能会更改。请自行谨慎使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

margin = None

类型:

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) – 用于代替默认值的主题值

返回值：

无

clone(**overrides: Any) → Self

复制一个 HasProps 对象。

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

classmethod dataspecs() → dict[str, DataSpec]

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

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

返回值：

DataSpec 属性的名称

返回类型：

set[str]

类方法 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) – 要注册的回调函数

返回值：

无

示例

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-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) : 要设置的属性的名称

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

• models (dict 或 None, 可选) –

  模型 ID 到模型的映射（默认值：None）

  当要更新的属性的值也包含引用时，需要此参数。

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

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

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

返回值：

无

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

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

参数：

• selector (JSON-like)

• updates (dict)

返回值：

无

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

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

返回值：

无

update(**kwargs: Any) → 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 Row(*args: Any, id: ID | None = None, **kwargs: Any)

基类: FlexBox

将子组件水平排列在同一行。

子组件可以作为位置参数指定，也可以作为单个序列参数指定，或者使用 children 关键字参数指定。

JSON 原型

{
  "align": "auto", 
  "aspect_ratio": null, 
  "children": [], 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "disabled": false, 
  "elements": [], 
  "flow_mode": "block", 
  "height": null, 
  "height_policy": "auto", 
  "id": "p59516", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "margin": null, 
  "max_height": null, 
  "max_width": null, 
  "min_height": null, 
  "min_width": null, 
  "name": null, 
  "resizable": false, 
  "sizing_mode": null, 
  "spacing": 0, 
  "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"，则将使用组件的首选宽度和高度来确定纵横比（如果未设置，则不会保留任何纵横比）。

children = []

类型:

列表

子组件列表，可以是其他组件，包括绘图、行、列和小部件。

context_menu = None

类型:

Nullable(Instance(‘.models.ui.Menu’))

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

注意

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

css_classes = []

类型:

列表

要添加到底层 DOM 元素的一系列附加 CSS 类。

css_variables = {}

类型:

Dict(String, Instance(Node))

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

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

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

注意

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

disabled = False

类型:

布尔值

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

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

elements = []

类型:

列表

附加到此窗格的一系列基于 DOM 的 UI 元素。

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

flow_mode = 'block'

类型:

Enum(FlowMode)

定义布局是否在 block 或 inline 维度上流动。

height = None

类型:

Nullable(NonNegative)

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

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

height_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

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

"auto"

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

"fixed"

使用正好 height 像素。如果组件无法适应可用垂直空间，则会溢出。

"fit"

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

"min"

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

"max"

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

注意

这是一个实验性功能，将来可能会更改。请自行谨慎使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

margin = None

类型:

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"

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

spacing = 0

类型:

Int

子元素之间的间隙（以像素为单位）。

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) – 用于代替默认值的主题值

返回值：

无

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) – 要注册的回调函数

返回值：

无

示例

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-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) : 要设置的属性的名称

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

• models (dict 或 None, 可选) –

  模型 ID 到模型的映射（默认值：None）

  当要更新的属性的值也包含引用时，需要此参数。

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

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

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

返回值：

无

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

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

参数：

• selector (JSON-like)

• updates (dict)

返回值：

无

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

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

返回值：

无

update(**kwargs: Any) → 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 ScrollBox(*args: Any, id: ID | None = None, **kwargs: Any)

基类：LayoutDOM

允许滚动溢出UI元素的面板。

JSON 原型

{
  "align": "auto", 
  "aspect_ratio": null, 
  "child": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "disabled": false, 
  "elements": [], 
  "flow_mode": "block", 
  "height": null, 
  "height_policy": "auto", 
  "horizontal_scrollbar": "auto", 
  "id": "p59544", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "margin": null, 
  "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": [], 
  "vertical_scrollbar": "auto", 
  "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"，则将使用组件的首选宽度和高度来确定纵横比（如果未设置，则不会保留任何纵横比）。

child = Undefined

类型:

Instance(UIElement)

子 UI 元素。它可以是单个 UI 控件、小部件等，也可以是 Column 或 Row 等容器布局，或者布局的组合。

context_menu = None

类型:

Nullable(Instance(‘.models.ui.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。

horizontal_scrollbar = 'auto'

类型:

Enum(ScrollbarPolicy)

水平滚动条的可见性。

margin = None

类型:

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 也不会出于任何原因直接使用这些标签。

vertical_scrollbar = 'auto'

类型:

Enum(ScrollbarPolicy)

垂直滚动条的可见性。

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) – 用于代替默认值的主题值

返回值：

无

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) – 要注册的回调函数

返回值：

无

示例

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-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) : 要设置的属性的名称

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

• models (dict 或 None, 可选) –

  模型 ID 到模型的映射（默认值：None）

  当要更新的属性的值也包含引用时，需要此参数。

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

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

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

返回值：

无

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

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

参数：

• selector (JSON-like)

• updates (dict)

返回值：

无

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

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

返回值：

无

update(**kwargs: Any) → 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 Spacer(*args: Any, id: ID | None = None, **kwargs: Any)

基类：LayoutDOM

用于填充行或列中空位的空间容器。

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": "p59573", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "margin": null, 
  "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(‘.models.ui.Menu’))

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

注意

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

css_classes = []

类型:

列表

要添加到底层 DOM 元素的一系列附加 CSS 类。

css_variables = {}

类型:

Dict(String, Instance(Node))

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

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

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

注意

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

disabled = False

类型:

布尔值

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

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

elements = []

类型:

列表

附加到此窗格的一系列基于 DOM 的 UI 元素。

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

flow_mode = 'block'

类型:

Enum(FlowMode)

定义布局是否在 block 或 inline 维度上流动。

height = None

类型:

Nullable(NonNegative)

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

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

height_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

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

"auto"

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

"fixed"

使用正好 height 像素。如果组件无法适应可用垂直空间，则会溢出。

"fit"

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

"min"

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

"max"

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

注意

这是一个实验性功能，将来可能会更改。请自行谨慎使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

margin = None

类型:

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) – 用于代替默认值的主题值

返回值：

无

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) – 要注册的回调函数

返回值：

无

示例

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-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) : 要设置的属性的名称

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

• models (dict 或 None, 可选) –

  模型 ID 到模型的映射（默认值：None）

  当要更新的属性的值也包含引用时，需要此参数。

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

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

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

返回值：

无

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

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

参数：

• selector (JSON-like)

• updates (dict)

返回值：

无

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

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

返回值：

无

update(**kwargs: Any) → 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 TabPanel(*args: Any, id: ID | None = None, **kwargs: Any)

基类: Model

带标题栏和控件的单部件容器。

JSON 原型

{
  "child": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "closable": false, 
  "disabled": false, 
  "id": "p59599", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "title": "", 
  "tooltip": null
}

child = Undefined

类型:

Instance(UIElement)

子部件。如果您需要更多子部件，请使用布局部件，例如 Column。

closable = False

类型:

布尔值

是否可以关闭此面板。如果为 True，则会出现“x”按钮。

关闭面板等同于将其从父容器（例如选项卡）中删除。

disabled = False

类型:

布尔值

小部件是否对 UI 事件做出响应。

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 也不会出于任何原因直接使用该名称。

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 也不会出于任何原因直接使用这些标签。

title = ''

类型:

字符串

面板的文本标题。

tooltip = None

类型:

Nullable(Instance(Tooltip))

一个包含纯文本或富 HTML 内容的工具提示，提供小部件或组件功能的一般帮助或描述。

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

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

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

参数：

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

返回值：

无

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) – 要注册的回调函数

返回值：

无

示例

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-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) : 要设置的属性的名称

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

• models (dict 或 None, 可选) –

  模型 ID 到模型的映射（默认值：None）

  当要更新的属性的值也包含引用时，需要此参数。

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

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

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

返回值：

无

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

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

参数：

• selector (JSON-like)

• updates (dict)

返回值：

无

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

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

返回值：

无

update(**kwargs: Any) → 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 Tabs(*args: Any, id: ID | None = None, **kwargs: Any)

基类：LayoutDOM

带导航标签的面板小部件。

示例

from bokeh.models import TabPanel, Tabs, Tooltip
from bokeh.models.layouts import Row
from bokeh.plotting import figure, show

p1 = figure(width=300, height=300)
p1.scatter([1, 2, 3, 4, 5], [6, 7, 2, 4, 5], size=20, color="navy", alpha=0.5)

p2 = figure(width=300, height=300)
p2.line([1, 2, 3, 4, 5], [6, 7, 2, 4, 5], line_width=3, color="navy", alpha=0.5)

p3 = figure(width=300, height=300)
p3.scatter([1, 2, 3, 4, 5], [6, 7, 2, 4, 5], size=20, color="navy", alpha=0.5)

p4 = figure(width=300, height=300)
p4.line([1, 2, 3, 4, 5], [6, 7, 2, 4, 5], line_width=3, color="navy", alpha=0.5)

tabs0 = Tabs(tabs=[
    TabPanel(child=p1, title="circle"),
    TabPanel(child=p2, title="line"),
])

tabs1 = Tabs(tabs=[
    TabPanel(child=p1, title="circle", tooltip=Tooltip(content="This is the first tab.", position="bottom_center")),
    TabPanel(child=p2, title="line", tooltip=Tooltip(content="This is the second tab.", position="bottom_center")),
])

show(Row(tabs0, tabs1))

JSON 原型

{
  "active": 0, 
  "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": "p59608", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "margin": null, 
  "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, 
  "tabs": [], 
  "tabs_location": "above", 
  "tags": [], 
  "visible": true, 
  "width": null, 
  "width_policy": "auto"
}

active = 0

类型:

Int

活动标签的索引。

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(‘.models.ui.Menu’))

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

注意

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

css_classes = []

类型:

列表

要添加到底层 DOM 元素的一系列附加 CSS 类。

css_variables = {}

类型:

Dict(String, Instance(Node))

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

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

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

注意

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

disabled = False

类型:

布尔值

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

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

elements = []

类型:

列表

附加到此窗格的一系列基于 DOM 的 UI 元素。

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

flow_mode = 'block'

类型:

Enum(FlowMode)

定义布局是否在 block 或 inline 维度上流动。

height = None

类型:

Nullable(NonNegative)

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

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

height_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

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

"auto"

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

"fixed"

使用正好 height 像素。如果组件无法适应可用垂直空间，则会溢出。

"fit"

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

"min"

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

"max"

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

注意

这是一个实验性功能，将来可能会更改。请自行谨慎使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

margin = None

类型:

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 端回调仍然可以工作。

tabs = []

类型:

列表

子面板小部件的列表。

tabs_location = 'above'

类型:

Enum(Location)

激活选项卡的按钮位置。

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) – 用于代替默认值的主题值

返回值：

无

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) – 要注册的回调函数

返回值：

无

示例

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-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) : 要设置的属性的名称

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

• models (dict 或 None, 可选) –

  模型 ID 到模型的映射（默认值：None）

  当要更新的属性的值也包含引用时，需要此参数。

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

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

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

返回值：

无

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

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

参数：

• selector (JSON-like)

• updates (dict)

返回值：

无

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

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

返回值：

无

update(**kwargs: Any) → 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 VBox(*args: Any, id: ID | None = None, **kwargs: Any)

基类：LayoutDOM

基于 CSS 网格的垂直盒子。

JSON 原型

{
  "align": "auto", 
  "aspect_ratio": null, 
  "children": [], 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "disabled": false, 
  "elements": [], 
  "flow_mode": "block", 
  "height": null, 
  "height_policy": "auto", 
  "id": "p59818", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "margin": null, 
  "max_height": null, 
  "max_width": null, 
  "min_height": null, 
  "min_width": null, 
  "name": null, 
  "resizable": false, 
  "rows": null, 
  "sizing_mode": null, 
  "spacing": 0, 
  "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"，则将使用组件的首选宽度和高度来确定纵横比（如果未设置，则不会保留任何纵横比）。

children = []

类型:

列表

子元素列表及其在垂直盒子中的关联位置（可选；行号、跨度）。

context_menu = None

类型:

Nullable(Instance(‘.models.ui.Menu’))

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

注意

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

css_classes = []

类型:

列表

要添加到底层 DOM 元素的一系列附加 CSS 类。

css_variables = {}

类型:

Dict(String, Instance(Node))

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

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

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

注意

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

disabled = False

类型:

布尔值

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

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

elements = []

类型:

列表

附加到此窗格的一系列基于 DOM 的 UI 元素。

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

flow_mode = 'block'

类型:

Enum(FlowMode)

定义布局是否在 block 或 inline 维度上流动。

height = None

类型:

Nullable(NonNegative)

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

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

height_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

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

"auto"

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

"fixed"

使用正好 height 像素。如果组件无法适应可用垂直空间，则会溢出。

"fit"

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

"min"

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

"max"

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

注意

这是一个实验性功能，将来可能会更改。请自行谨慎使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

margin = None

类型:

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

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

rows = None

类型:

Nullable(Either(Either(String, Struct), List, Dict(Int, Either(String, Struct))))

描述网格如何维护其行的高度。

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"

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

spacing = 0

类型:

非负数

子元素之间的间隙（以像素为单位）。

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) – 用于代替默认值的主题值

返回值：

无

克隆(**overrides: Any) → Self

复制一个 HasProps 对象。

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

类方法 dataspecs() → dict[str, DataSpec]

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

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

返回值：

DataSpec 属性的名称

返回类型：

set[str]

类方法 descriptors() → list[PropertyDescriptor[Any]]

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

销毁() → None

清理对文档和属性的引用。

等于(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) – 要注册的回调函数

返回值：

无

示例

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-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) : 要设置的属性的名称

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

• models (dict 或 None, 可选) –

  模型 ID 到模型的映射（默认值：None）

  当要更新的属性的值也包含引用时，需要此参数。

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

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

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

返回值：

无

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

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

参数：

• selector (JSON-like)

• updates (dict)

返回值：

无

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

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

返回值：

无

update(**kwargs: Any) → 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）