表格

各种数据表格（数据网格）部件。

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

基类：RowAggregator

跨多行的简单平均值。

JSON 原型

{
  "field_": "", 
  "id": "p65566", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}

field_ = ''

类型:

字符串

引用正在聚合的表格列

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

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

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

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

参数:

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

返回值:

无

classmethod clear_extensions() → None

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

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

clone(**overrides: Any) → Self

复制 HasProps 对象。

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

classmethod dataspecs() → dict[str, DataSpec]

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

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

返回值:

DataSpec属性的名称

返回类型:

set[str]

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

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

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等。

参数:

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

返回值:

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

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

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

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

参数:

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

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

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

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

在版本 1.1 中添加

引发:

ValueError –

示例

使用 js_link 的此代码

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

等效于以下内容

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

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

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

等效于

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

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

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

在 BokehJS 端，模型属性的更改事件采用 "change:property_name" 的形式。为方便起见，如果传递给此方法的事件名称也是模型上某个属性的名称，则会自动在其前面加上 "change:"

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

但是，除了属性更改事件之外，还有其他一些事件可能对响应有用。例如，要在一个 ColumnDataSource 中流式传输数据时运行回调，请使用源上的 "stream" 事件

source.js_on_change('streaming', callback)

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

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

参数:

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

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

返回值:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

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

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

参数:

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

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

返回值:

无

示例

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）

返回值:

从属性名称到其值的映射

返回类型:

dict

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

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

参数:

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

• include_defaults (bool, 可选) – 是否包含尚未由用户显式设置的属性（默认值：True）

返回值:

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

返回类型:

dict

references() → set[Model]

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

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

从该对象中移除回调函数

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (类似 JSON 的数据)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回值:

Model

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

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

参数:

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

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

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

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

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

返回值:

无

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

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

参数:

• selector (类似 JSON 的数据)

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

基类: CellFormatter

布尔（复选标记）单元格格式化程序。

JSON 原型

{
  "icon": "check", 
  "id": "p65571", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}

icon = 'check'

类型:

Enum(Enumeration(check, check-circle, check-circle-o, check-square, check-square-o))

可视化复选标记的图标。

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

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

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

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

参数:

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

返回值:

无

classmethod clear_extensions() → None

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

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

clone(**overrides: Any) → Self

复制 HasProps 对象。

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

classmethod dataspecs() → dict[str, DataSpec]

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

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

返回值:

DataSpec属性的名称

返回类型:

set[str]

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

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

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等。

参数:

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

返回值:

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

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

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

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

参数:

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

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

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

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

在版本 1.1 中添加

引发:

ValueError –

示例

使用 js_link 的此代码

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

等效于以下内容

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

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

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

等效于

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

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

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

在 BokehJS 端，模型属性的更改事件采用 "change:property_name" 的形式。为方便起见，如果传递给此方法的事件名称也是模型上某个属性的名称，则会自动在其前面加上 "change:"

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

但是，除了属性更改事件之外，还有其他一些事件可能对响应有用。例如，要在一个 ColumnDataSource 中流式传输数据时运行回调，请使用源上的 "stream" 事件

source.js_on_change('streaming', callback)

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

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

参数:

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

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

返回值:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

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

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

参数:

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

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

返回值:

无

示例

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）

返回值:

从属性名称到其值的映射

返回类型:

dict

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

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

参数:

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

• include_defaults (bool, 可选) – 是否包含尚未由用户显式设置的属性（默认值：True）

返回值:

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

返回类型:

dict

references() → set[Model]

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

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

从该对象中移除回调函数

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (类似 JSON 的数据)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回值:

Model

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

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

参数:

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

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

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

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

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

返回值:

无

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

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

参数:

• selector (类似 JSON 的数据)

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

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

基类: Model

数据表格单元格编辑器的抽象基类。

注意

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

JSON 原型

{
  "id": "p65576", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}

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

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

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

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

参数:

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

返回值:

无

类方法 clear_extensions() → None

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

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

clone(**overrides: Any) → Self

复制 HasProps 对象。

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

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

classmethod parameters() → list[Parameter]

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

返回值:

list(Parameter)

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

收集此类上属性的名称。

警告

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

返回值:

属性名称

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

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

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

返回值:

具有引用的属性的名称

返回类型:

set[str]

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

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

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

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

参数:

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

返回值:

从属性名称到其值的映射

返回类型:

dict

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

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

参数:

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

• include_defaults (bool, 可选) – 是否包含尚未由用户显式设置的属性（默认值：True）

返回值:

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

返回类型:

dict

references() → set[Model]

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

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

从该对象中移除回调函数

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (类似 JSON 的数据)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回值:

Model

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

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

参数:

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

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

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

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

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

返回值:

无

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

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

参数:

• selector (类似 JSON 的数据)

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

基类: Model

数据表格单元格格式化程序的抽象基类。

注意

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

JSON 原型

{
  "id": "p65580", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}

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

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

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

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

参数:

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

返回值:

无

classmethod clear_extensions() → None

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

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

clone(**overrides: Any) → Self

复制 HasProps 对象。

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

classmethod dataspecs() → dict[str, DataSpec]

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

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

返回值:

DataSpec属性的名称

返回类型:

set[str]

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

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

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等。

参数:

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

返回值:

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

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

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

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

参数:

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

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

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

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

在版本 1.1 中添加

引发:

ValueError –

示例

使用 js_link 的此代码

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

等效于以下内容

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

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

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

等效于

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

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

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

在 BokehJS 端，模型属性的更改事件采用 "change:property_name" 的形式。为方便起见，如果传递给此方法的事件名称也是模型上某个属性的名称，则会自动在其前面加上 "change:"

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

但是，除了属性更改事件之外，还有其他一些事件可能对响应有用。例如，要在一个 ColumnDataSource 中流式传输数据时运行回调，请使用源上的 "stream" 事件

source.js_on_change('streaming', callback)

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

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

参数:

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

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

返回值:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

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

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

参数:

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

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

返回值:

无

示例

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）

返回值:

从属性名称到其值的映射

返回类型:

dict

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

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

参数:

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

• include_defaults (bool, 可选) – 是否包含尚未由用户显式设置的属性（默认值：True）

返回值:

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

返回类型:

dict

references() → set[Model]

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

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

从该对象中移除回调函数

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (类似 JSON 的数据)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回值:

Model

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

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

参数:

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

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

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

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

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

返回值:

无

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

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

参数:

• selector (类似 JSON 的数据)

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

基类: CellEditor

布尔值单元格编辑器。

JSON 原型

{
  "id": "p65584", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}

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

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

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

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

参数:

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

返回值:

无

classmethod clear_extensions() → None

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

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

clone(**overrides: Any) → Self

复制 HasProps 对象。

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

classmethod dataspecs() → dict[str, DataSpec]

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

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

返回值:

DataSpec属性的名称

返回类型:

set[str]

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

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

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等。

参数:

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

返回值:

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

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

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

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

参数:

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

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

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

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

在版本 1.1 中添加

引发:

ValueError –

示例

使用 js_link 的此代码

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

等效于以下内容

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

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

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

等效于

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

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

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

在 BokehJS 端，模型属性的更改事件采用 "change:property_name" 的形式。为方便起见，如果传递给此方法的事件名称也是模型上某个属性的名称，则会自动在其前面加上 "change:"

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

但是，除了属性更改事件之外，还有其他一些事件可能对响应有用。例如，要在一个 ColumnDataSource 中流式传输数据时运行回调，请使用源上的 "stream" 事件

source.js_on_change('streaming', callback)

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

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

参数:

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

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

返回值:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

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

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

参数:

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

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

返回值:

无

示例

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）

返回值:

从属性名称到其值的映射

返回类型:

dict

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

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

参数:

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

• include_defaults (bool, 可选) – 是否包含尚未由用户显式设置的属性（默认值：True）

返回值:

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

返回类型:

dict

references() → set[Model]

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

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

从该对象中移除回调函数

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (类似 JSON 的数据)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回值:

Model

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

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

参数:

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

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

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

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

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

返回值:

无

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

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

参数:

• selector (类似 JSON 的数据)

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

基类: DataTable

具有折叠分组、合计和子合计的专业化数据表。

JSON 原型

{
  "align": "auto", 
  "aspect_ratio": null, 
  "auto_edit": false, 
  "autosize_mode": "force_fit", 
  "columns": [], 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "disabled": false, 
  "editable": false, 
  "elements": [], 
  "fit_columns": null, 
  "flow_mode": "block", 
  "frozen_columns": null, 
  "frozen_rows": null, 
  "grouping": [], 
  "header_row": true, 
  "height": 400, 
  "height_policy": "auto", 
  "id": "p65588", 
  "index_header": "#", 
  "index_position": 0, 
  "index_width": 40, 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "margin": 5, 
  "max_height": null, 
  "max_width": null, 
  "min_height": null, 
  "min_width": null, 
  "name": null, 
  "reorderable": true, 
  "resizable": false, 
  "row_height": 25, 
  "scroll_to_selection": true, 
  "selectable": true, 
  "sizing_mode": null, 
  "sortable": true, 
  "source": {
    "attributes": {
      "data": {
        "type": "map"
      }, 
      "selected": {
        "attributes": {
          "indices": [], 
          "line_indices": []
        }, 
        "id": "p65590", 
        "name": "Selection", 
        "type": "object"
      }, 
      "selection_policy": {
        "id": "p65591", 
        "name": "UnionRenderers", 
        "type": "object"
      }
    }, 
    "id": "p65589", 
    "name": "ColumnDataSource", 
    "type": "object"
  }, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "target": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "view": {
    "attributes": {
      "filter": {
        "id": "p65593", 
        "name": "AllIndices", 
        "type": "object"
      }
    }, 
    "id": "p65592", 
    "name": "CDSView", 
    "type": "object"
  }, 
  "visible": true, 
  "width": 600, 
  "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"，则将使用组件的首选宽度和高度来确定纵横比（如果未设置，则不会保留任何纵横比）。

auto_edit = False

类型:

布尔值

启用后，在表格单元格上单击一次后将启用编辑模式。

autosize_mode = 'force_fit'

类型:

Enum(AutosizeMode)

使用以下选项之一描述列自动调整大小模式

"fit_columns"

根据单元格内容计算列宽，但确保表格适合可用的视口。这将导致不显示水平滚动条，但如果可用空间不足，数据可能变得难以阅读。

"fit_viewport"

根据单元格内容计算列宽后调整视口大小。

"force_fit"

将列适合可用空间，在列之间平均分配表格宽度（等效于fit_columns=True）。这将导致不显示水平滚动条，但如果可用空间不足，数据可能变得难以阅读。

"none"

不要自动计算列宽。

columns = []

类型:

列表

子列小部件的列表。

context_menu = None

类型:

Nullable(Instance(Menu))

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

注意

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

css_classes = []

类型:

列表

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

css_variables = {}

类型:

Dict(String, Instance(Node))

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

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

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

注意

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

disabled = False

类型:

布尔值

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

如果True，则小部件将呈灰色显示，并且对 UI 事件没有响应。

editable = False

类型:

布尔值

允许编辑表格内容。需要在需要编辑的列上配置单元格编辑器。

elements = []

类型:

列表

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

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

fit_columns = None

类型:

Nullable(Bool)

**这是一个旧参数。**对于新开发，请使用autosize_mode参数。

列是否应适合可用宽度。这将导致不显示水平滚动条，但如果可用空间不足，数据可能变得难以阅读。如果设置为 True，则每列的宽度都被理解为最大宽度。

flow_mode = 'block'

类型:

Enum(FlowMode)

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

frozen_columns = None

类型:

Nullable(Int)

指示要冻结的列数的整数。如果设置，则前 N 列将被冻结，这将阻止它们从框架中滚动出去。

frozen_rows = None

类型:

Nullable(Int)

指示要冻结的行数的整数。如果设置，则前 N 行将被冻结，这将阻止它们从框架中滚动出去，如果设置为负值，则最后 N 行将被冻结。

grouping = []

类型:

列表

描述用于定义小计和总计的聚合操作。

header_row = True

类型:

布尔值

是否在表格顶部显示包含列名的标题行。

height = 400

类型:

Nullable(NonNegative)

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

根据高度大小策略，这可以是固定高度或首选高度。

height_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

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

"auto"

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

"fixed"

使用正好 height 像素。如果组件无法容纳在可用的垂直空间中，则会溢出。

"fit"

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

"min"

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

"max"

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

注意

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

index_header = '#'

类型:

字符串

如果存在索引列，则显示的列标题。

index_position = 0

类型:

Nullable(Int)

在列列表中插入显示行索引的列的位置。支持负索引，并指定从列列表末尾开始的索引位置（即标准 Python 行为）。

要防止添加索引列，请设置为 None。

如果 index_position 的绝对值大于列的长度，则索引将出现在开头或结尾，具体取决于符号。

index_width = 40

类型:

Int

如果存在，索引列的宽度。

margin = 5

类型:

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

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

max_height = None

类型:

Nullable(NonNegative)

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

max_width = None

类型:

Nullable(NonNegative)

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

min_height = None

类型:

Nullable(NonNegative)

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

min_width = None

类型:

Nullable(NonNegative)

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

name = None

类型:

Nullable(String)

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

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

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

注意

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

reorderable = True

类型:

布尔值

允许重新排序表格的列。要重新排序列，请单击并拖动表格的标题到表格中的所需位置。两侧的列将保持其先前的顺序。

resizable = False

类型:

Either(Bool, Enum(Dimensions))

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

row_height = 25

类型:

Int

每行的高度（以像素为单位）。

scroll_to_selection = True

类型:

布尔值

每当在数据源上进行选择时，如果视口中不存在任何选定的行，则将选定的行滚动到表格的视口中。

selectable = True

类型:

Either(Bool, Enum(Enumeration(checkbox)))

表格的行是否可以选择。使用 checkbox 等效于 True，但使选择通过每行的复选框可见，而不是突出显示行。允许多选，可以通过单击多个复选框（如果启用）或使用 Shift + 单击行来实现。

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"

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

sortable = True

类型:

布尔值

允许对表格内容进行排序。默认情况下保留自然顺序。要对某列进行排序，请单击其标题。再次单击会更改排序方向。使用 Ctrl + 单击返回自然顺序。使用 Shift + 单击可同时对多列进行排序。

source = ColumnDataSource(id='p65810', ...)

类型:

Instance(DataSource)

小部件的数据源。

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

target = Undefined

类型:

Instance(DataSource)

描述数据立方体哪些行被展开或折叠的两列数据源（row_indices & labels）

view = CDSView(id='p65849', ...)

类型:

Instance(CDSView)

渲染表格行时要使用的 DataSource 的视图。如果没有在初始化期间传递视图，则会创建整个 DataSource 的默认视图。

visible = True

类型:

布尔值

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

width = 600

类型:

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

返回值:

无

classmethod clear_extensions() → None

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

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

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

静态方法 from_data(data, columns=None, formatters={}, **kwargs) → DataTable

从 pandas 数据框、字典或 ColumnDataSource 创建一个简单的表格。

参数:

• data (DataFrame 或 dict 或 ColumnDataSource) – 用于创建表格的数据。如果数据是数据框或字典，则会从中创建一个 ColumnDataSource。

• columns (list, 可选) – 要从输入数据中使用的列名称列表。如果为 None，则使用所有列。（默认值：None）

• formatters (dict, 可选) – 列名称和相应 Formatters 的映射，应用于每一列。（默认值：None）

关键字参数：

DataTable. (将把任何其他关键字参数传递给)

返回值:

DataTable

引发:

ValueError – 如果提供的数据不是 ColumnDataSource 或 ColumnDataSource 可以从中创建的数据源。

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

返回值:

属性名称

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

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

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

返回值:

具有引用的属性的名称

返回类型:

set[str]

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

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

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

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

参数:

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

返回值:

从属性名称到其值的映射

返回类型:

dict

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

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

参数:

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

• include_defaults (bool, 可选) – 是否包含尚未由用户显式设置的属性（默认值：True）

返回值:

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

返回类型:

dict

references() → set[Model]

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

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

从该对象中移除回调函数

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (类似 JSON 的数据)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回值:

Model

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

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

参数:

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

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

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

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

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

返回值:

无

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

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

参数:

• selector (类似 JSON 的数据)

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

基类: TableWidget

用于可视化和编辑大量数据的二维网格。

JSON 原型

{
  "align": "auto", 
  "aspect_ratio": null, 
  "auto_edit": false, 
  "autosize_mode": "force_fit", 
  "columns": [], 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "disabled": false, 
  "editable": false, 
  "elements": [], 
  "fit_columns": null, 
  "flow_mode": "block", 
  "frozen_columns": null, 
  "frozen_rows": null, 
  "header_row": true, 
  "height": 400, 
  "height_policy": "auto", 
  "id": "p65869", 
  "index_header": "#", 
  "index_position": 0, 
  "index_width": 40, 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "margin": 5, 
  "max_height": null, 
  "max_width": null, 
  "min_height": null, 
  "min_width": null, 
  "name": null, 
  "reorderable": true, 
  "resizable": false, 
  "row_height": 25, 
  "scroll_to_selection": true, 
  "selectable": true, 
  "sizing_mode": null, 
  "sortable": true, 
  "source": {
    "attributes": {
      "data": {
        "type": "map"
      }, 
      "selected": {
        "attributes": {
          "indices": [], 
          "line_indices": []
        }, 
        "id": "p65871", 
        "name": "Selection", 
        "type": "object"
      }, 
      "selection_policy": {
        "id": "p65872", 
        "name": "UnionRenderers", 
        "type": "object"
      }
    }, 
    "id": "p65870", 
    "name": "ColumnDataSource", 
    "type": "object"
  }, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "view": {
    "attributes": {
      "filter": {
        "id": "p65874", 
        "name": "AllIndices", 
        "type": "object"
      }
    }, 
    "id": "p65873", 
    "name": "CDSView", 
    "type": "object"
  }, 
  "visible": true, 
  "width": 600, 
  "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"，则将使用组件的首选宽度和高度来确定纵横比（如果未设置，则不会保留任何纵横比）。

auto_edit = False

类型:

布尔值

启用后，在表格单元格上单击一次后将启用编辑模式。

autosize_mode = 'force_fit'

类型:

Enum(AutosizeMode)

使用以下选项之一描述列自动调整大小模式

"fit_columns"

根据单元格内容计算列宽，但确保表格适合可用的视口。这将导致不显示水平滚动条，但如果可用空间不足，数据可能变得难以阅读。

"fit_viewport"

根据单元格内容计算列宽后调整视口大小。

"force_fit"

将列适合可用空间，在列之间平均分配表格宽度（等效于fit_columns=True）。这将导致不显示水平滚动条，但如果可用空间不足，数据可能变得难以阅读。

"none"

不要自动计算列宽。

columns = []

类型:

列表

子列小部件的列表。

context_menu = None

类型:

Nullable(Instance(Menu))

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

注意

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

css_classes = []

类型:

列表

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

css_variables = {}

类型:

Dict(String, Instance(Node))

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

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

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

注意

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

disabled = False

类型:

布尔值

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

如果True，则小部件将呈灰色显示，并且对 UI 事件没有响应。

editable = False

类型:

布尔值

允许编辑表格内容。需要在需要编辑的列上配置单元格编辑器。

elements = []

类型:

列表

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

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

fit_columns = None

类型:

Nullable(Bool)

**这是一个旧参数。**对于新开发，请使用autosize_mode参数。

列是否应适合可用宽度。这将导致不显示水平滚动条，但如果可用空间不足，数据可能变得难以阅读。如果设置为 True，则每列的宽度都被理解为最大宽度。

flow_mode = 'block'

类型:

Enum(FlowMode)

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

frozen_columns = None

类型:

Nullable(Int)

指示要冻结的列数的整数。如果设置，则前 N 列将被冻结，这将阻止它们从框架中滚动出去。

frozen_rows = None

类型:

Nullable(Int)

指示要冻结的行数的整数。如果设置，则前 N 行将被冻结，这将阻止它们从框架中滚动出去，如果设置为负值，则最后 N 行将被冻结。

header_row = True

类型:

布尔值

是否在表格顶部显示包含列名的标题行。

height = 400

类型:

Nullable(NonNegative)

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

根据高度大小策略，这可以是固定高度或首选高度。

height_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

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

"auto"

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

"fixed"

使用正好 height 像素。如果组件无法容纳在可用的垂直空间中，则会溢出。

"fit"

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

"min"

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

"max"

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

注意

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

index_header = '#'

类型:

字符串

如果存在索引列，则显示的列标题。

index_position = 0

类型:

Nullable(Int)

在列列表中插入显示行索引的列的位置。支持负索引，并指定从列列表末尾开始的索引位置（即标准 Python 行为）。

要防止添加索引列，请设置为 None。

如果 index_position 的绝对值大于列的长度，则索引将出现在开头或结尾，具体取决于符号。

index_width = 40

类型:

Int

如果存在，索引列的宽度。

margin = 5

类型:

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

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

max_height = None

类型:

Nullable(NonNegative)

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

max_width = None

类型:

Nullable(NonNegative)

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

min_height = None

类型:

Nullable(NonNegative)

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

min_width = None

类型:

Nullable(NonNegative)

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

name = None

类型:

Nullable(String)

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

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

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

注意

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

reorderable = True

类型:

布尔值

允许重新排序表格的列。要重新排序列，请单击并拖动表格的标题到表格中的所需位置。两侧的列将保持其先前的顺序。

resizable = False

类型:

Either(Bool, Enum(Dimensions))

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

row_height = 25

类型:

Int

每行的高度（以像素为单位）。

scroll_to_selection = True

类型:

布尔值

每当在数据源上进行选择时，如果视口中不存在任何选定的行，则将选定的行滚动到表格的视口中。

selectable = True

类型:

Either(Bool, Enum(Enumeration(checkbox)))

表格的行是否可以选择。使用 checkbox 等效于 True，但使选择通过每行的复选框可见，而不是突出显示行。允许多选，可以通过单击多个复选框（如果启用）或使用 Shift + 单击行来实现。

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"

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

sortable = True

类型:

布尔值

允许对表格内容进行排序。默认情况下保留自然顺序。要对某列进行排序，请单击其标题。再次单击会更改排序方向。使用 Ctrl + 单击返回自然顺序。使用 Shift + 单击可同时对多列进行排序。

source = ColumnDataSource(id='p66085', ...)

类型:

Instance(DataSource)

小部件的数据源。

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

view = CDSView(id='p66118', ...)

类型:

Instance(CDSView)

渲染表格行时要使用的 DataSource 的视图。如果没有在初始化期间传递视图，则会创建整个 DataSource 的默认视图。

visible = True

类型:

布尔值

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

width = 600

类型:

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

返回值:

无

classmethod clear_extensions() → None

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

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

clone(**overrides: Any) → Self

复制 HasProps 对象。

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

classmethod dataspecs() → dict[str, DataSpec]

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

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

返回值:

DataSpec属性的名称

返回类型:

set[str]

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

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

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等。

参数:

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

返回值:

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

static from_data(data, columns=None, formatters={}, **kwargs) → DataTable

从 pandas 数据框、字典或 ColumnDataSource 创建一个简单的表格。

参数:

• data (DataFrame 或 dict 或 ColumnDataSource) – 用于创建表格的数据。如果数据是数据框或字典，则会从中创建一个 ColumnDataSource。

• columns (list, 可选) – 要从输入数据中使用的列名称列表。如果为 None，则使用所有列。（默认值：None）

• formatters (dict, 可选) – 列名称和相应 Formatters 的映射，应用于每一列。（默认值：None）

关键字参数：

DataTable. (将把任何其他关键字参数传递给)

返回值:

DataTable

引发:

ValueError – 如果提供的数据不是 ColumnDataSource 或 ColumnDataSource 可以从中创建的数据源。

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）

返回值:

从属性名称到其值的映射

返回类型:

dict

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

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

参数:

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

• include_defaults (bool, 可选) – 是否包含尚未由用户显式设置的属性（默认值：True）

返回值:

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

返回类型:

dict

references() → set[Model]

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

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

从该对象中移除回调函数

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (类似 JSON 的数据)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回值:

Model

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

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

参数:

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

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

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

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

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

返回值:

无

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

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

参数:

• selector (类似 JSON 的数据)

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

基类: CellEditor

基于日历的日期单元格编辑器。

JSON 原型

{
  "id": "p66138", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}

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

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

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

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

参数:

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

返回值:

无

classmethod clear_extensions() → None

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

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

clone(**overrides: Any) → Self

复制 HasProps 对象。

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

classmethod dataspecs() → dict[str, DataSpec]

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

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

返回值:

DataSpec属性的名称

返回类型:

set[str]

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

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

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等。

参数:

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

返回值:

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

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

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

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

参数:

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

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

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

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

在版本 1.1 中添加

引发:

ValueError –

示例

使用 js_link 的此代码

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

等效于以下内容

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

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

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

等效于

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

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

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

在 BokehJS 端，模型属性的更改事件采用 "change:property_name" 的形式。为方便起见，如果传递给此方法的事件名称也是模型上某个属性的名称，则会自动在其前面加上 "change:"

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

但是，除了属性更改事件之外，还有其他一些事件可能对响应有用。例如，要在一个 ColumnDataSource 中流式传输数据时运行回调，请使用源上的 "stream" 事件

source.js_on_change('streaming', callback)

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

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

参数:

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

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

返回值:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

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

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

参数:

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

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

返回值:

无

示例

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）

返回值:

从属性名称到其值的映射

返回类型:

dict

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

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

参数:

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

• include_defaults (bool, 可选) – 是否包含尚未由用户显式设置的属性（默认值：True）

返回值:

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

返回类型:

dict

references() → set[Model]

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

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

从该对象中移除回调函数

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (类似 JSON 的数据)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回值:

Model

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

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

参数:

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

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

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

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

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

返回值:

无

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

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

参数:

• selector (类似 JSON 的数据)

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

基类: StringFormatter

日期单元格格式化器。

JSON 原型

{
  "background_color": {
    "type": "value", 
    "value": null
  }, 
  "font_style": {
    "type": "value", 
    "value": "normal"
  }, 
  "format": "ISO-8601", 
  "id": "p66142", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "nan_format": "-", 
  "null_format": "-", 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "text_align": {
    "type": "value", 
    "value": "left"
  }, 
  "text_color": {
    "type": "value", 
    "value": null
  }
}

background_color = None

类型:

ColorSpec

可选的背景颜色。

可接受的值为

• 任何命名的 CSS 颜色，例如 'green', 'indigo'

• RGB(A) 十六进制字符串，例如 '#FF0000', '#44444444'

• CSS4 颜色字符串，例如 'rgba(255, 0, 127, 0.6)', 'rgb(0 127 0 / 1.0)' 或 'hsl(60deg 100% 50% / 1.0)'

• 一个 0 到 255 之间的整数 3 元组 (r, g, b)

• 一个 4 元组 (r, g, b, a)，其中 r、g、b 是 0 到 255 之间的整数，a 是 0 到 1 之间的数

• 一个使用 0xRRGGBBAA 字节顺序模式的 32 位无符号整数

font_style = 'normal'

类型:

FontStyleSpec

可选的文本字体样式，例如粗体、斜体。

format = 'ISO-8601'

类型:

Either(Enum(DateFormat), String)

日期格式可以是任何标准的 strftime 格式字符串，以及以下任何预定义的格式名称

格式名称	格式字符串	示例输出
ATOM / W3C / RFC-3339 / ISO-8601	"%Y-%m-%d"	2014-03-01
COOKIE	"%a, %d %b %Y"	Sat, 01 Mar 2014
RFC-850	"%A, %d-%b-%y"	Saturday, 01-Mar-14
RFC-1123 / RFC-2822	"%a, %e %b %Y"	Sat, 1 Mar 2014
RSS / RFC-822 / RFC-1036	"%a, %e %b %y"	Sat, 1 Mar 14
TIMESTAMP	(自纪元以来的毫秒数)	1393632000000

请注意，在表中，一些格式名称是同义词，相同的格式名称由斜杠分隔。

下面复制了支持的 strftime 格式代码列表。

%a

根据当前区域设置，一周中某一天的缩写名称。

%A

根据当前区域设置，一周中某一天的全称。

%b

根据当前区域设置，月份的缩写名称。

%B

根据当前区域设置，月份的全称。

%c

当前区域设置的首选日期和时间表示形式。

%C

世纪数（年/100），作为 2 位整数。

%d

月份中的某一天，以十进制数字表示（范围 01 到 31）。

%D

等效于 %m/%d/%y。（美国人应该注意，在许多其他国家/地区，%d/%m/%y 非常常见。这意味着在国际环境中，此格式不明确，不应使用。）

%e

类似于 %d，月份中的某一天，以十进制数字表示，但前导零替换为空格。

%f

微秒，以十进制数字表示，左侧填充零（范围 000000-999999）。这是对 timezone 可用指令集的扩展。

%F

等效于 %Y-%m-%d（ISO 8601 日期格式）。

%G

带世纪的 ISO 8601 基于周的年份，以十进制数字表示。与 ISO 周数对应的 4 位年份（请参阅 %V）。其格式和值与 %Y 相同，不同之处在于，如果 ISO 周数属于前一年或后一年，则使用该年份。

%g

类似于 %G，但不带世纪，即使用 2 位年份（00-99）。

%h

等效于 %b。

%H

小时，以十进制数字表示，使用 24 小时制时钟（范围 00 到 23）。

%I

小时，以十进制数字表示，使用 12 小时制时钟（范围 01 到 12）。

%j

一年中的某一天，以十进制数字表示（范围 001 到 366）。

%k

小时（24 小时制时钟），以十进制数字表示（范围 0 到 23）。一位数字前面有空格。（另请参阅 %H。）

%l

小时（12 小时制时钟），以十进制数字表示（范围 1 到 12）。一位数字前面有空格。（另请参阅 %I。）（TZ）

%m

月份，以十进制数字表示（范围 01 到 12）。

%M

分钟，以十进制数字表示（范围 00 到 59）。

%n

换行符。Bokeh 文本目前不支持换行符。

%N

纳秒，以十进制数字表示，左侧填充零（范围 000000000-999999999）。支持填充宽度说明符，即 %3N 显示 3 个最左边的数字。但是，由于 timezone 的限制，这仅精确到毫秒级的精度。

%p

根据给定的时间值，为“AM”或“PM”，或当前区域设置的相应字符串。中午被视为“PM”，午夜被视为“AM”。

%P

类似于 %p，但小写：“am”或“pm”，或当前区域设置的相应字符串。

%r

上午或下午表示法的时间。在 POSIX 区域设置中，这等效于 %I:%M:%S %p。

%R

24 小时制表示法的时间 (%H:%M)。有关包含秒数的版本，请参阅下面的 %T。

%s

自纪元（1970-01-01 00:00:00 +0000 (UTC)）以来的秒数。

%S

秒，以十进制数字表示（范围 00 到 60）。（范围最多为 60，以允许偶尔的闰秒。）

%t

制表符。Bokeh 文本目前不支持制表符。

%T

24 小时制表示法的时间 (%H:%M:%S)。

%u

一周中的某一天，以十进制数字表示，范围 1 到 7，星期一为 1。另请参阅 %w。

%U

当前年份的周数，以十进制数字表示，范围 00 到 53，从第一个星期日作为第 01 周的第一天开始。另请参阅 %V 和 %W。

%V

当前年份的 ISO 8601 周数（请参阅注释），以十进制数字表示，范围 01 到 53，其中第 1 周是新的一年中至少有 4 天的第一周。另请参阅 %U 和 %W。

%w

一周中的某一天，以十进制数字表示，范围 0 到 6，星期日为 0。另请参阅 %u。

%W

当前年份的周数，以十进制数字表示，范围 00 到 53，从第一个星期一作为第 01 周的第一天开始。

%x

当前区域设置的首选日期表示形式，不带时间。

%X

当前区域设置的首选时间表示形式，不带日期。

%y

年份，以十进制数字表示，不带世纪（范围 00 到 99）。

%Y

年份，以十进制数字表示，包括世纪。

%z

+hhmm 或 -hhmm 数字时区（即相对于 UTC 的小时和分钟偏移量）。

%Z

时区名称或缩写。

%%

文字“%”字符。

警告

BokehJS 客户端库使用 timezone 库来格式化日期时间。以下列表的包含基于 timezone 声称支持“GNU 日期格式说明符的完整补充”。但是，此声明尚未针对此列表进行详尽测试。如果您发现格式的功能与预期不符，请提交 github 问题，以便相应地更新文档。

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

nan_format = '-'

类型:

字符串

应用于 NaN 和 NaT 值的格式。

null_format = '-'

类型:

字符串

应用于 None/null 值的格式。

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

text_align = 'left'

类型:

TextAlignSpec

可选的文本对齐方式，即左、中或右。

text_color = None

类型:

ColorSpec

可选的文本颜色。

可接受的值为

• 任何命名的 CSS 颜色，例如 'green', 'indigo'

• RGB(A) 十六进制字符串，例如 '#FF0000', '#44444444'

• CSS4 颜色字符串，例如 'rgba(255, 0, 127, 0.6)', 'rgb(0 127 0 / 1.0)' 或 'hsl(60deg 100% 50% / 1.0)'

• 一个 0 到 255 之间的整数 3 元组 (r, g, b)

• 一个 4 元组 (r, g, b, a)，其中 r、g、b 是 0 到 255 之间的整数，a 是 0 到 1 之间的数

• 一个使用 0xRRGGBBAA 字节顺序模式的 32 位无符号整数

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

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

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

参数:

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

返回值:

无

classmethod clear_extensions() → None

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

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

clone(**overrides: Any) → Self

复制 HasProps 对象。

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

类方法 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 中。

返回值:

属性名称

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

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

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

返回值:

具有引用的属性的名称

返回类型:

set[str]

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

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

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

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

参数:

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

返回值:

从属性名称到其值的映射

返回类型:

dict

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

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

参数:

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

• include_defaults (bool, 可选) – 是否包含尚未由用户显式设置的属性（默认值：True）

返回值:

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

返回类型:

dict

references() → set[Model]

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

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

从该对象中移除回调函数

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (类似 JSON 的数据)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回值:

Model

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

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

参数:

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

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

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

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

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

返回值:

无

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

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

参数:

• selector (类似 JSON 的数据)

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

基类: Model

描述如何计算总计和子总计

JSON 原型

{
  "aggregators": [], 
  "collapsed": false, 
  "getter": "", 
  "id": "p66153", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}

aggregators = []

类型:

列表

描述如何聚合将填充此子总计的列。

collapsed = False

类型:

布尔值

默认情况下，相应的子总计是展开还是折叠。

getter = ''

类型:

字符串

引用生成此子总计唯一键（groupby）的列。

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

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

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

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

参数:

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

返回值:

无

classmethod clear_extensions() → None

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

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

clone(**overrides: Any) → Self

复制 HasProps 对象。

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

classmethod dataspecs() → dict[str, DataSpec]

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

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

返回值:

DataSpec属性的名称

返回类型:

set[str]

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

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

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等。

参数:

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

返回值:

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

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

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

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

参数:

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

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

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

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

在版本 1.1 中添加

引发:

ValueError –

示例

使用 js_link 的此代码

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

等效于以下内容

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

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

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

等效于

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

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

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

在 BokehJS 端，模型属性的更改事件采用 "change:property_name" 的形式。为方便起见，如果传递给此方法的事件名称也是模型上某个属性的名称，则会自动在其前面加上 "change:"

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

但是，除了属性更改事件之外，还有其他一些事件可能对响应有用。例如，要在一个 ColumnDataSource 中流式传输数据时运行回调，请使用源上的 "stream" 事件

source.js_on_change('streaming', callback)

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

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

参数:

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

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

返回值:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

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

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

参数:

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

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

返回值:

无

示例

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）

返回值:

从属性名称到其值的映射

返回类型:

dict

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

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

参数:

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

• include_defaults (bool, 可选) – 是否包含尚未由用户显式设置的属性（默认值：True）

返回值:

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

返回类型:

dict

references() → set[Model]

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

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

从该对象中移除回调函数

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (类似 JSON 的数据)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回值:

Model

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

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

参数:

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

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

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

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

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

返回值:

无

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

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

参数:

• selector (类似 JSON 的数据)

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

基类: CellFormatter

使用模板的HTML格式化程序。这使用了Underscore的template方法和语法。https://underscorejs.node.org.cn/#template 格式化程序可以通过传递给格式化程序的dataContext对象访问行中的其他项目。例如，如果数据源中的另一列名为url，则模板可以将其访问为

<a href="<%= url %>"><%= value %></a>

要使用不同的模板分隔符集，请为evaluate、interpolate或escape传递相应的值。有关更多信息，请参阅Underscore template文档。https://underscorejs.node.org.cn/#template

示例：将列值格式化为代码的简单HTML模板。

HTMLTemplateFormatter(template='<code><%= value %></code>')

示例：使用来自其他列（manufacturer和model）的值来构建超链接。

HTMLTemplateFormatter(template=
    '<a href="https:/www.google.com/search?q=<%= manufacturer %>+<%= model %>" target="_blank"><%= value %></a>'
)

JSON 原型

{
  "id": "p66160", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "template": "<%= value %>"
}

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

template = '<%= value %>'

类型:

字符串

要由Underscore的模板方法使用的模板字符串。

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

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

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

参数:

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

返回值:

无

classmethod clear_extensions() → None

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

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

clone(**overrides: Any) → Self

复制 HasProps 对象。

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

classmethod dataspecs() → dict[str, DataSpec]

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

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

返回值:

DataSpec属性的名称

返回类型:

set[str]

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

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

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等。

参数:

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

返回值:

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

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

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

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

参数:

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

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

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

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

在版本 1.1 中添加

引发:

ValueError –

示例

使用 js_link 的此代码

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

等效于以下内容

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

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

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

等效于

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

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

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

在 BokehJS 端，模型属性的更改事件采用 "change:property_name" 的形式。为方便起见，如果传递给此方法的事件名称也是模型上某个属性的名称，则会自动在其前面加上 "change:"

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

但是，除了属性更改事件之外，还有其他一些事件可能对响应有用。例如，要在一个 ColumnDataSource 中流式传输数据时运行回调，请使用源上的 "stream" 事件

source.js_on_change('streaming', callback)

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

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

参数:

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

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

返回值:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

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

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

参数:

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

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

返回值:

无

示例

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）

返回值:

从属性名称到其值的映射

返回类型:

dict

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

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

参数:

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

• include_defaults (bool, 可选) – 是否包含尚未由用户显式设置的属性（默认值：True）

返回值:

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

返回类型:

dict

references() → set[Model]

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

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

从该对象中移除回调函数

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (类似 JSON 的数据)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回值:

Model

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

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

参数:

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

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

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

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

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

返回值:

无

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

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

参数:

• selector (类似 JSON 的数据)

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

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

基类: CellEditor

基于微调器的整数单元格编辑器。

JSON 原型

{
  "id": "p66165", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "step": 1, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}

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

step = 1

类型:

Int

主要步长值。

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

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

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

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

参数:

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

返回值:

无

类方法 clear_extensions() → None

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

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

clone(**overrides: Any) → Self

复制 HasProps 对象。

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

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

返回值:

从属性名称到其值的映射

返回类型:

dict

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

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

参数:

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

• include_defaults (bool, 可选) – 是否包含尚未由用户显式设置的属性（默认值：True）

返回值:

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

返回类型:

dict

references() → set[Model]

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

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

从该对象中移除回调函数

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (类似 JSON 的数据)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回值:

Model

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

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

参数:

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

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

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

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

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

返回值:

无

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

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

参数:

• selector (类似 JSON 的数据)

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

基类：RowAggregator

跨多行的最大值。

JSON 原型

{
  "field_": "", 
  "id": "p66170", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}

field_ = ''

类型:

字符串

引用正在聚合的表格列

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

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

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

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

参数:

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

返回值:

无

classmethod clear_extensions() → None

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

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

clone(**overrides: Any) → Self

复制 HasProps 对象。

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

classmethod dataspecs() → dict[str, DataSpec]

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

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

返回值:

DataSpec属性的名称

返回类型:

set[str]

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

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

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等。

参数:

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

返回值:

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

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

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

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

参数:

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

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

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

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

在版本 1.1 中添加

引发:

ValueError –

示例

使用 js_link 的此代码

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

等效于以下内容

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

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

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

等效于

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

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

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

在 BokehJS 端，模型属性的更改事件采用 "change:property_name" 的形式。为方便起见，如果传递给此方法的事件名称也是模型上某个属性的名称，则会自动在其前面加上 "change:"

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

但是，除了属性更改事件之外，还有其他一些事件可能对响应有用。例如，要在一个 ColumnDataSource 中流式传输数据时运行回调，请使用源上的 "stream" 事件

source.js_on_change('streaming', callback)

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

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

参数:

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

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

返回值:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

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

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

参数:

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

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

返回值:

无

示例

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）

返回值:

从属性名称到其值的映射

返回类型:

dict

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

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

参数:

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

• include_defaults (bool, 可选) – 是否包含尚未由用户显式设置的属性（默认值：True）

返回值:

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

返回类型:

dict

references() → set[Model]

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

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

从该对象中移除回调函数

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (类似 JSON 的数据)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回值:

Model

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

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

参数:

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

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

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

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

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

返回值:

无

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

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

参数:

• selector (类似 JSON 的数据)

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

基类：RowAggregator

跨多行的最小值。

JSON 原型

{
  "field_": "", 
  "id": "p66175", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}

field_ = ''

类型:

字符串

引用正在聚合的表格列

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

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

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

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

参数:

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

返回值:

无

classmethod clear_extensions() → None

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

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

clone(**overrides: Any) → Self

复制 HasProps 对象。

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

classmethod dataspecs() → dict[str, DataSpec]

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

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

返回值:

DataSpec属性的名称

返回类型:

set[str]

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

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

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等。

参数:

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

返回值:

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

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

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

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

参数:

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

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

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

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

在版本 1.1 中添加

引发:

ValueError –

示例

使用 js_link 的此代码

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

等效于以下内容

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

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

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

等效于

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

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

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

在 BokehJS 端，模型属性的更改事件采用 "change:property_name" 的形式。为方便起见，如果传递给此方法的事件名称也是模型上某个属性的名称，则会自动在其前面加上 "change:"

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

但是，除了属性更改事件之外，还有其他一些事件可能对响应有用。例如，要在一个 ColumnDataSource 中流式传输数据时运行回调，请使用源上的 "stream" 事件

source.js_on_change('streaming', callback)

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

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

参数:

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

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

返回值:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

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

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

参数:

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

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

返回值:

无

示例

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）

返回值:

从属性名称到其值的映射

返回类型:

dict

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

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

参数:

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

• include_defaults (bool, 可选) – 是否包含尚未由用户显式设置的属性（默认值：True）

返回值:

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

返回类型:

dict

references() → set[Model]

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

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

从该对象中移除回调函数

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (类似 JSON 的数据)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回值:

Model

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

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

参数:

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

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

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

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

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

返回值:

无

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

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

参数:

• selector (类似 JSON 的数据)

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

基类: CellEditor

基于微调器的数字单元格编辑器。

JSON 原型

{
  "id": "p66180", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "step": 0.01, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}

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

step = 0.01

类型:

浮点数

主要步长值。

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

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

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

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

参数:

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

返回值:

无

classmethod clear_extensions() → None

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

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

clone(**overrides: Any) → Self

复制 HasProps 对象。

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

classmethod dataspecs() → dict[str, DataSpec]

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

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

返回值:

DataSpec属性的名称

返回类型:

set[str]

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

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

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等。

参数:

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

返回值:

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

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

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

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

参数:

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

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

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

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

在版本 1.1 中添加

引发:

ValueError –

示例

使用 js_link 的此代码

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

等效于以下内容

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

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

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

等效于

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

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

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

在 BokehJS 端，模型属性的更改事件采用 "change:property_name" 的形式。为方便起见，如果传递给此方法的事件名称也是模型上某个属性的名称，则会自动在其前面加上 "change:"

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

但是，除了属性更改事件之外，还有其他一些事件可能对响应有用。例如，要在一个 ColumnDataSource 中流式传输数据时运行回调，请使用源上的 "stream" 事件

source.js_on_change('streaming', callback)

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

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

参数:

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

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

返回值:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

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

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

参数:

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

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

返回值:

无

示例

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）

返回值:

从属性名称到其值的映射

返回类型:

dict

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

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

参数:

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

• include_defaults (bool, 可选) – 是否包含尚未由用户显式设置的属性（默认值：True）

返回值:

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

返回类型:

dict

references() → set[Model]

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

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

从该对象中移除回调函数

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (类似 JSON 的数据)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

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

返回值:

Model

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

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

参数:

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

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

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

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

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

返回值:

无

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

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

参数:

• selector (类似 JSON 的数据)

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

基类: StringFormatter

数字单元格格式化器。

JSON 原型

{
  "background_color": {
    "type": "value", 
    "value": null
  }, 
  "font_style": {
    "type": "value", 
    "value": "normal"
  }, 
  "format": "0,0", 
  "id": "p66185", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "language": "en", 
  "name": null, 
  "nan_format": "-", 
  "null_format": "-", 
  "rounding": "round", 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "text_align": {
    "type": "value", 
    "value": "left"
  }, 
  "text_color": {
    "type": "value", 
    "value": null
  }
}

background_color = None

类型:

ColorSpec

可选的背景颜色。

可接受的值为

• 任何命名的 CSS 颜色，例如 'green', 'indigo'

• RGB(A) 十六进制字符串，例如 '#FF0000', '#44444444'

• CSS4 颜色字符串，例如 'rgba(255, 0, 127, 0.6)', 'rgb(0 127 0 / 1.0)' 或 'hsl(60deg 100% 50% / 1.0)'

• 一个 0 到 255 之间的整数 3 元组 (r, g, b)

• 一个 4 元组 (r, g, b, a)，其中 r、g、b 是 0 到 255 之间的整数，a 是 0 到 1 之间的数

• 一个使用 0xRRGGBBAA 字节顺序模式的 32 位无符号整数

font_style = 'normal'

类型:

FontStyleSpec

可选的文本字体样式，例如粗体、斜体。

format = '0,0'

类型:

字符串

数字格式，如下表所示

数字:

数字	格式	字符串
10000	‘0,0.0000’	10,000.0000
10000.23	‘0,0’	10,000
10000.23	‘+0,0’	+10,000
-10000	‘0,0.0’	-10,000.0
10000.1234	‘0.000’	10000.123
10000.1234	‘0[.]00000’	10000.12340
-10000	‘(0,0.0000)’	(10,000.0000)
-0.23	‘.00’	-.23
-0.23	‘(.00)’	(.23)
0.23	‘0.00000’	0.23000
0.23	‘0.0[0000]’	0.23
1230974	‘0.0a’	1.2m
1460	‘0 a’	1 k
-104000	‘0a’	-104k
1	‘0o’	1st
52	‘0o’	52nd
23	‘0o’	23rd
100	‘0o’	100th

货币:

数字	格式	字符串
1000.234	‘$0,0.00’	$1,000.23
1000.2	‘0,0[.]00 $’	1,000.20 $
1001	‘$ 0,0[.]00’	$ 1,001
-1000.234	‘($0,0)’	($1,000)
-1000.234	‘$0.00’	-$1000.23
1230974	‘($ 0.00 a)’	$ 1.23 m

字节:

数字	格式	字符串
100	‘0b’	100B
2048	‘0 b’	2 KB
7884486213	‘0.0b’	7.3GB
3467479682787	‘0.000 b’	3.154 TB

百分比:

数字	格式	字符串
1	‘0%’	100%
0.974878234	‘0.000%’	97.488%
-0.43	‘0 %’	-43 %
0.43	‘(0.000 %)’	43.000 %

时间:

数字	格式	字符串
25	‘00:00:00’	0:00:25
238	‘00:00:00’	0:03:58
63846	‘00:00:00’	17:44:06

有关完整规范，请参阅 http://numbrojs.com/format.html

language = 'en'

类型:

Enum(NumeralLanguage)

用于格式化特定于语言的功能（例如，千位分隔符）的语言。

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

nan_format = '-'

类型:

字符串

应用于 NaN 和 NaT 值的格式。

null_format = '-'

类型:

字符串

应用于 None/null 值的格式。

rounding = 'round'

类型:

Enum(RoundingFunction)

舍入函数（round、floor、ceil）及其同义词（nearest、rounddown、roundup）。

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

text_align = 'left'

类型:

TextAlignSpec

可选的文本对齐方式，即左、中或右。

text_color = None

类型:

ColorSpec

可选的文本颜色。

可接受的值为

• 任何命名的 CSS 颜色，例如 'green', 'indigo'

• RGB(A) 十六进制字符串，例如 '#FF0000', '#44444444'

• CSS4 颜色字符串，例如 'rgba(255, 0, 127, 0.6)', 'rgb(0 127 0 / 1.0)' 或 'hsl(60deg 100% 50% / 1.0)'

• 一个 0 到 255 之间的整数 3 元组 (r, g, b)

• 一个 4 元组 (r, g, b, a)，其中 r、g、b 是 0 到 255 之间的整数，a 是 0 到 1 之间的数

• 一个使用 0xRRGGBBAA 字节顺序模式的 32 位无符号整数

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

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

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

参数:

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

返回值:

无

classmethod clear_extensions() → None

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

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

clone(**overrides: Any) → Self

复制 HasProps 对象。

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

classmethod dataspecs() → dict[str, DataSpec]

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

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

返回值:

DataSpec属性的名称

返回类型:

set[str]

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

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

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等。

参数:

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

返回值:

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

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

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

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

参数:

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

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

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

• attr_selector (int | str) – 链接可订阅 attr 中项目的索引

在版本 1.1 中添加

引发:

ValueError –

示例

使用 js_link 的此代码

select.js_link('value', plot, 'sizing_mode')

等效于以下内容

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

此外，要使用 attr_selector 将范围滑块的左侧附加到绘图的 x_range

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

等效于

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

将 CustomJS 回调附加到任意 BokehJS 模型事件。

在 BokehJS 端，模型属性的更改事件采用 "change:property_name" 的形式。为方便起见，如果传递给此方法的事件名称也是模型上某个属性的名称，则会自动在其前面加上 "change:"

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

但是，除了属性更改事件之外，还有其他一些事件可能对响应有用。例如，要在一个 ColumnDataSource 中流式传输数据时运行回调，请使用源上的 "stream" 事件

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

在类上查找给定属性名称的 Bokeh 属性的 PropertyDescriptor。

参数:

• name (str) – 要搜索的属性的名称

• raises (bool) – 如果缺少属性，是否引发异常或返回 None

返回值:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

在此对象上添加一个回调，以便在 attr 发生更改时触发。

参数:

• attr (str) – 此对象上的属性名称

• *callbacks (callable) – 要注册的回调函数

返回值:

无

示例

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）

返回值:

从属性名称到其值的映射

返回类型:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

使用谓词查询 HasProps 实例的属性值。

参数:

• query (可调用对象) – 一个可调用对象，它接收属性描述符并返回 True 或 False

• include_defaults (bool, 可选) – 是否包含尚未由用户显式设置的属性（默认值：True）

返回值:

属性名称和值的映射，用于匹配属性

返回类型:

dict

references() → set[Model]

返回此对象引用的所有Models。

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

从该对象中移除回调函数

select(selector: SelectorType) → Iterable[Model]

查询此对象及其所有引用，以查找与给定选择器匹配的对象。

参数:

selector (类似 JSON 的数据)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

查询此对象及其所有引用，以查找与给定选择器匹配的对象。如果找到多个对象，则引发错误。返回单个匹配对象，如果未找到任何对象，则返回 None :param selector: :type selector: 类似 JSON 的数据

返回值:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

从 JSON 中设置此对象上的属性值。

参数:

• name (str) – 要设置的属性的名称

• value (JSON 值) – 要设置为属性的值

• setter (ClientSession 或 ServerSession 或 None, 可选) –

  这用于防止 Bokeh 应用程序的“回旋镖”更新。

  在 Bokeh 服务器应用程序的上下文中，传入的属性更新将使用正在执行更新的会话进行注释。此值将通过更新触发的任何后续更改通知进行传播。会话可以将其自身与事件设置器进行比较，并抑制任何源自其自身的更新。

返回值:

无

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

使用指定的属性/值更新来更新与给定选择器匹配的对象。

参数:

• selector (类似 JSON 的数据)

• 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 PercentEditor(*args: Any, id: ID | None = None, **kwargs: Any)

基类: CellEditor

IntEditor 优化的百分比编辑器。

JSON 原型

{
  "id": "p66198", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}

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 也不会出于任何原因直接使用这些标签。

apply_theme(property_values: dict[str, Any]) → None

应用一组主题值，这些值将用于代替默认值，但不会覆盖应用程序设置的值。

传递的字典可以按原样保留并与其他实例共享以节省内存（因此调用方和 HasProps 实例都不应修改它）。

参数:

property_values (dict) – 用于代替默认值的主题值

返回值:

无

classmethod clear_extensions() → None

清除任何当前定义的自定义扩展。

序列化调用将导致任何当前定义的自定义扩展包含在生成的文档中，无论它们是否被利用。此方法可用于清除所有现有的自定义扩展定义。

克隆(**overrides: 任意) → 自身

复制 HasProps 对象。

这会创建原始模型的浅克隆，即任何可变容器或子模型都不会被复制。允许在克隆时覆盖特定的属性。

类方法 dataspecs() → 字典[字符串, 数据规范]

收集此类上所有DataSpec属性的名称。

此方法**始终**遍历类层次结构，并包含在任何父类上定义的属性。

返回值:

DataSpec属性的名称

返回类型:

set[str]

类方法 descriptors() → 列表[属性描述符[任意]]

属性描述符列表，按定义顺序排列。

销毁() → 无

清理对文档和属性的引用

等于(其他: 具有属性的对象) → 布尔值

模型的结构相等。

参数:

other (HasProps) – 要比较的另一个实例

返回值:

如果属性在结构上相等，则为 True，否则为 False

js链接(属性: 字符串, 其他: 模型, 其他属性: 字符串, 属性选择器: 整数 | 字符串 | 无 = 无) → 无

使用 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更改事件(事件: 字符串, *回调函数: JS更改回调) → 无

将 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)

类方法 查找(名称: 字符串, *, 引发异常: 布尔值 = 真) → 属性描述符[任意] | 无

在类上查找给定属性名称的 Bokeh 属性的 PropertyDescriptor。

参数:

• name (str) – 要搜索的属性的名称

• raises (bool) – 如果缺少属性，是否引发异常或返回 None

返回值:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

更改事件(属性: 字符串, *回调函数: 属性回调) → 无

在此对象上添加一个回调，以便在 attr 发生更改时触发。

参数:

• attr (str) – 此对象上的属性名称

• *callbacks (callable) – 要注册的回调函数

返回值:

无

示例

widget.on_change('value', callback1, callback2, ..., callback_n)

事件处理(事件: 字符串 | 类型[事件], *回调函数: 可调用对象[[事件], 无] | 可调用对象[[], 无]) → 无

当此模型上发生指定事件时运行回调函数。

并非所有模型都支持所有事件。有关哪些模型能够触发事件的更多信息，请参阅 bokeh.events 中的特定事件。

类方法 参数() → 列表[参数]

生成适用于从 Glyph 派生的函数的 Python Parameter 值。

返回值:

list(Parameter)

类方法 属性(*, 带属性: 布尔值 = 假) → 集合[字符串] | 字典[字符串, 属性[任意]]

收集此类上属性的名称。

警告

在 Bokeh 的未来版本中，此方法将返回一个字典，该字典将属性名称映射到属性对象。为了使此方法的当前用法面向未来，请将返回值包装在 list 中。

返回值:

属性名称

classmethod properties_with_refs() → dict[str, Property[Any]]

收集此类上所有也具有引用的属性的名称。

此方法**始终**遍历类层次结构，并包含在任何父类上定义的属性。

返回值:

具有引用的属性的名称

返回类型:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

收集一个字典，将属性名称映射到其值。

此方法**始终**遍历类层次结构，并包含在任何父类上定义的属性。

不可序列化的属性将被跳过，并且属性值将采用“序列化”格式，这可能与您通常从属性中读取的值略有不同；此方法的目的是返回无损重构对象实例所需的信息。

参数:

include_defaults (bool, optional) – 是否包含自对象创建以来尚未显式设置的属性。（默认值：True）

返回值:

从属性名称到其值的映射

返回类型:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

使用谓词查询 HasProps 实例的属性值。

参数:

• query (可调用对象) – 一个可调用对象，它接收属性描述符并返回 True 或 False

• include_defaults (bool, 可选) – 是否包含尚未由用户显式设置的属性（默认值：True）

返回值:

属性名称和值的映射，用于匹配属性

返回类型:

dict

references() → set[Model]

返回此对象引用的所有Models。

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

从该对象中移除回调函数

select(selector: SelectorType) → Iterable[Model]

查询此对象及其所有引用，以查找与给定选择器匹配的对象。

参数:

selector (类似 JSON 的数据)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

查询此对象及其所有引用，以查找与给定选择器匹配的对象。如果找到多个对象，则引发错误。返回单个匹配对象，如果未找到任何对象，则返回 None :param selector: :type selector: 类似 JSON 的数据

返回值:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

从 JSON 中设置此对象上的属性值。

参数:

• name (str) – 要设置的属性的名称

• value (JSON 值) – 要设置为属性的值

• setter (ClientSession 或 ServerSession 或 None, 可选) –

  这用于防止 Bokeh 应用程序的“回旋镖”更新。

  在 Bokeh 服务器应用程序的上下文中，传入的属性更新将使用正在执行更新的会话进行注释。此值将通过更新触发的任何后续更改通知进行传播。会话可以将其自身与事件设置器进行比较，并抑制任何源自其自身的更新。

返回值:

无

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

使用指定的属性/值更新来更新与给定选择器匹配的对象。

参数:

• selector (类似 JSON 的数据)

• 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 ScientificFormatter(*args: Any, id: ID | None = None, **kwargs: Any)

基类: StringFormatter

显示来自连续范围的数值作为“基本数字”，默认情况下在适当的时候使用科学计数法。

JSON 原型

{
  "background_color": {
    "type": "value", 
    "value": null
  }, 
  "font_style": {
    "type": "value", 
    "value": "normal"
  }, 
  "id": "p66202", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "nan_format": "-", 
  "null_format": "-", 
  "power_limit_high": 5, 
  "power_limit_low": -3, 
  "precision": 10, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "text_align": {
    "type": "value", 
    "value": "left"
  }, 
  "text_color": {
    "type": "value", 
    "value": null
  }
}

background_color = None

类型:

ColorSpec

可选的背景颜色。

可接受的值为

• 任何命名的 CSS 颜色，例如 'green', 'indigo'

• RGB(A) 十六进制字符串，例如 '#FF0000', '#44444444'

• CSS4 颜色字符串，例如 'rgba(255, 0, 127, 0.6)', 'rgb(0 127 0 / 1.0)' 或 'hsl(60deg 100% 50% / 1.0)'

• 一个 0 到 255 之间的整数 3 元组 (r, g, b)

• 一个 4 元组 (r, g, b, a)，其中 r、g、b 是 0 到 255 之间的整数，a 是 0 到 1 之间的数

• 一个使用 0xRRGGBBAA 字节顺序模式的 32 位无符号整数

font_style = 'normal'

类型:

FontStyleSpec

可选的文本字体样式，例如粗体、斜体。

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 也不会出于任何原因直接使用该名称。

nan_format = '-'

类型:

字符串

应用于 NaN 和 NaT 值的格式。

null_format = '-'

类型:

字符串

应用于 None/null 值的格式。

power_limit_high = 5

类型:

Int

限制使用科学计数法的条件为：

log(x) >= power_limit_high

power_limit_low = -3

类型:

Int

限制使用科学计数法的条件为：

log(x) <= power_limit_low

precision = 10

类型:

Int

显示的精度位数。

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 也不会出于任何原因直接使用这些标签。

text_align = 'left'

类型:

TextAlignSpec

可选的文本对齐方式，即左、中或右。

text_color = None

类型:

ColorSpec

可选的文本颜色。

可接受的值为

• 任何命名的 CSS 颜色，例如 'green', 'indigo'

• RGB(A) 十六进制字符串，例如 '#FF0000', '#44444444'

• CSS4 颜色字符串，例如 'rgba(255, 0, 127, 0.6)', 'rgb(0 127 0 / 1.0)' 或 'hsl(60deg 100% 50% / 1.0)'

• 一个 0 到 255 之间的整数 3 元组 (r, g, b)

• 一个 4 元组 (r, g, b, a)，其中 r、g、b 是 0 到 255 之间的整数，a 是 0 到 1 之间的数

• 一个使用 0xRRGGBBAA 字节顺序模式的 32 位无符号整数

apply_theme(property_values: dict[str, Any]) → None

应用一组主题值，这些值将用于代替默认值，但不会覆盖应用程序设置的值。

传递的字典可以按原样保留并与其他实例共享以节省内存（因此调用方和 HasProps 实例都不应修改它）。

参数:

property_values (dict) – 用于代替默认值的主题值

返回值:

无

classmethod clear_extensions() → None

清除任何当前定义的自定义扩展。

序列化调用将导致任何当前定义的自定义扩展包含在生成的文档中，无论它们是否被利用。此方法可用于清除所有现有的自定义扩展定义。

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）

返回值:

从属性名称到其值的映射

返回类型:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

使用谓词查询 HasProps 实例的属性值。

参数:

• query (可调用对象) – 一个可调用对象，它接收属性描述符并返回 True 或 False

• include_defaults (bool, 可选) – 是否包含尚未由用户显式设置的属性（默认值：True）

返回值:

属性名称和值的映射，用于匹配属性

返回类型:

dict

references() → set[Model]

返回此对象引用的所有Models。

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

从该对象中移除回调函数

select(selector: SelectorType) → Iterable[Model]

查询此对象及其所有引用，以查找与给定选择器匹配的对象。

参数:

selector (类似 JSON 的数据)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

查询此对象及其所有引用，以查找与给定选择器匹配的对象。如果找到多个对象，则引发错误。返回单个匹配对象，如果未找到任何对象，则返回 None :param selector: :type selector: 类似 JSON 的数据

返回值:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

从 JSON 中设置此对象上的属性值。

参数:

• name (str) – 要设置的属性的名称

• value (JSON 值) – 要设置为属性的值

• setter (ClientSession 或 ServerSession 或 None, 可选) –

  这用于防止 Bokeh 应用程序的“回旋镖”更新。

  在 Bokeh 服务器应用程序的上下文中，传入的属性更新将使用正在执行更新的会话进行注释。此值将通过更新触发的任何后续更改通知进行传播。会话可以将其自身与事件设置器进行比较，并抑制任何源自其自身的更新。

返回值:

无

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

使用指定的属性/值更新来更新与给定选择器匹配的对象。

参数:

• selector (类似 JSON 的数据)

• 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 SelectEditor(*args: Any, id: ID | None = None, **kwargs: Any)

基类: CellEditor

选择单元格编辑器。

JSON 原型

{
  "id": "p66215", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "options": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}

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 也不会出于任何原因直接使用该名称。

options = []

类型:

列表

要从中选择的选项列表。

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 也不会出于任何原因直接使用这些标签。

apply_theme(property_values: dict[str, Any]) → None

应用一组主题值，这些值将用于代替默认值，但不会覆盖应用程序设置的值。

传递的字典可以按原样保留并与其他实例共享以节省内存（因此调用方和 HasProps 实例都不应修改它）。

参数:

property_values (dict) – 用于代替默认值的主题值

返回值:

无

classmethod clear_extensions() → None

清除任何当前定义的自定义扩展。

序列化调用将导致任何当前定义的自定义扩展包含在生成的文档中，无论它们是否被利用。此方法可用于清除所有现有的自定义扩展定义。

clone(**overrides: Any) → Self

复制 HasProps 对象。

这会创建原始模型的浅克隆，即任何可变容器或子模型都不会被复制。允许在克隆时覆盖特定的属性。

classmethod dataspecs() → dict[str, DataSpec]

收集此类上所有DataSpec属性的名称。

此方法**始终**遍历类层次结构，并包含在任何父类上定义的属性。

返回值:

DataSpec属性的名称

返回类型:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

属性描述符列表，按定义顺序排列。

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等。

参数:

other (HasProps) – 要比较的另一个实例

返回值:

如果属性在结构上相等，则为 True，否则为 False

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

使用 JavaScript 链接两个 Bokeh 模型属性。

这是一种便捷方法，简化了添加 CustomJS 回调以更新一个 Bokeh 模型属性，无论何时另一个属性的值发生变化。

参数:

• attr (str) – 此模型上 Bokeh 属性的名称

• other (Model) – 要链接到 self.attr 的 Bokeh 模型

• other_attr (str) – other 上要链接在一起的属性

• attr_selector (int | str) – 链接可订阅 attr 中项目的索引

在版本 1.1 中添加

引发:

ValueError –

示例

使用 js_link 的此代码

select.js_link('value', plot, 'sizing_mode')

等效于以下内容

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

此外，要使用 attr_selector 将范围滑块的左侧附加到绘图的 x_range

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

等效于

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

将 CustomJS 回调附加到任意 BokehJS 模型事件。

在 BokehJS 端，模型属性的更改事件采用 "change:property_name" 的形式。为方便起见，如果传递给此方法的事件名称也是模型上某个属性的名称，则会自动在其前面加上 "change:"

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

但是，除了属性更改事件之外，还有其他一些事件可能对响应有用。例如，要在一个 ColumnDataSource 中流式传输数据时运行回调，请使用源上的 "stream" 事件

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

在类上查找给定属性名称的 Bokeh 属性的 PropertyDescriptor。

参数:

• name (str) – 要搜索的属性的名称

• raises (bool) – 如果缺少属性，是否引发异常或返回 None

返回值:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

在此对象上添加一个回调，以便在 attr 发生更改时触发。

参数:

• attr (str) – 此对象上的属性名称

• *callbacks (callable) – 要注册的回调函数

返回值:

无

示例

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）

返回值:

从属性名称到其值的映射

返回类型:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

使用谓词查询 HasProps 实例的属性值。

参数:

• query (可调用对象) – 一个可调用对象，它接收属性描述符并返回 True 或 False

• include_defaults (bool, 可选) – 是否包含尚未由用户显式设置的属性（默认值：True）

返回值:

属性名称和值的映射，用于匹配属性

返回类型:

dict

references() → set[Model]

返回此对象引用的所有Models。

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

从该对象中移除回调函数

select(selector: SelectorType) → Iterable[Model]

查询此对象及其所有引用，以查找与给定选择器匹配的对象。

参数:

selector (类似 JSON 的数据)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

查询此对象及其所有引用，以查找与给定选择器匹配的对象。如果找到多个对象，则引发错误。返回单个匹配对象，如果未找到任何对象，则返回 None :param selector: :type selector: 类似 JSON 的数据

返回值:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

从 JSON 中设置此对象上的属性值。

参数:

• name (str) – 要设置的属性的名称

• value (JSON 值) – 要设置为属性的值

• setter (ClientSession 或 ServerSession 或 None, 可选) –

  这用于防止 Bokeh 应用程序的“回旋镖”更新。

  在 Bokeh 服务器应用程序的上下文中，传入的属性更新将使用正在执行更新的会话进行注释。此值将通过更新触发的任何后续更改通知进行传播。会话可以将其自身与事件设置器进行比较，并抑制任何源自其自身的更新。

返回值:

无

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

使用指定的属性/值更新来更新与给定选择器匹配的对象。

参数:

• selector (类似 JSON 的数据)

• 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 StringEditor(*args: Any, id: ID | None = None, **kwargs: Any)

基类: CellEditor

具有自动完成功能的基本字符串单元格编辑器。

JSON 原型

{
  "completions": [], 
  "id": "p66220", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}

completions = []

类型:

列表

一个可选的完成字符串列表。

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 也不会出于任何原因直接使用这些标签。

apply_theme(property_values: dict[str, Any]) → None

应用一组主题值，这些值将用于代替默认值，但不会覆盖应用程序设置的值。

传递的字典可以按原样保留并与其他实例共享以节省内存（因此调用方和 HasProps 实例都不应修改它）。

参数:

property_values (dict) – 用于代替默认值的主题值

返回值:

无

classmethod clear_extensions() → None

清除任何当前定义的自定义扩展。

序列化调用将导致任何当前定义的自定义扩展包含在生成的文档中，无论它们是否被利用。此方法可用于清除所有现有的自定义扩展定义。

clone(**overrides: Any) → Self

复制 HasProps 对象。

这会创建原始模型的浅克隆，即任何可变容器或子模型都不会被复制。允许在克隆时覆盖特定的属性。

classmethod dataspecs() → dict[str, DataSpec]

收集此类上所有DataSpec属性的名称。

此方法**始终**遍历类层次结构，并包含在任何父类上定义的属性。

返回值:

DataSpec属性的名称

返回类型:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

属性描述符列表，按定义顺序排列。

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等。

参数:

other (HasProps) – 要比较的另一个实例

返回值:

如果属性在结构上相等，则为 True，否则为 False

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

使用 JavaScript 链接两个 Bokeh 模型属性。

这是一种便捷方法，简化了添加 CustomJS 回调以更新一个 Bokeh 模型属性，无论何时另一个属性的值发生变化。

参数:

• attr (str) – 此模型上 Bokeh 属性的名称

• other (Model) – 要链接到 self.attr 的 Bokeh 模型

• other_attr (str) – other 上要链接在一起的属性

• attr_selector (int | str) – 链接可订阅 attr 中项目的索引

在版本 1.1 中添加

引发:

ValueError –

示例

使用 js_link 的此代码

select.js_link('value', plot, 'sizing_mode')

等效于以下内容

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

此外，要使用 attr_selector 将范围滑块的左侧附加到绘图的 x_range

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

等效于

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

将 CustomJS 回调附加到任意 BokehJS 模型事件。

在 BokehJS 端，模型属性的更改事件采用 "change:property_name" 的形式。为方便起见，如果传递给此方法的事件名称也是模型上某个属性的名称，则会自动在其前面加上 "change:"

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

但是，除了属性更改事件之外，还有其他一些事件可能对响应有用。例如，要在一个 ColumnDataSource 中流式传输数据时运行回调，请使用源上的 "stream" 事件

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

在类上查找给定属性名称的 Bokeh 属性的 PropertyDescriptor。

参数:

• name (str) – 要搜索的属性的名称

• raises (bool) – 如果缺少属性，是否引发异常或返回 None

返回值:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

在此对象上添加一个回调，以便在 attr 发生更改时触发。

参数:

• attr (str) – 此对象上的属性名称

• *callbacks (callable) – 要注册的回调函数

返回值:

无

示例

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）

返回值:

从属性名称到其值的映射

返回类型:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

使用谓词查询 HasProps 实例的属性值。

参数:

• query (可调用对象) – 一个可调用对象，它接收属性描述符并返回 True 或 False

• include_defaults (bool, 可选) – 是否包含尚未由用户显式设置的属性（默认值：True）

返回值:

属性名称和值的映射，用于匹配属性

返回类型:

dict

references() → set[Model]

返回此对象引用的所有Models。

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

从该对象中移除回调函数

select(selector: SelectorType) → Iterable[Model]

查询此对象及其所有引用，以查找与给定选择器匹配的对象。

参数:

selector (类似 JSON 的数据)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

查询此对象及其所有引用，以查找与给定选择器匹配的对象。如果找到多个对象，则引发错误。返回单个匹配对象，如果未找到任何对象，则返回 None :param selector: :type selector: 类似 JSON 的数据

返回值:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

从 JSON 中设置此对象上的属性值。

参数:

• name (str) – 要设置的属性的名称

• value (JSON 值) – 要设置为属性的值

• setter (ClientSession 或 ServerSession 或 None, 可选) –

  这用于防止 Bokeh 应用程序的“回旋镖”更新。

  在 Bokeh 服务器应用程序的上下文中，传入的属性更新将使用正在执行更新的会话进行注释。此值将通过更新触发的任何后续更改通知进行传播。会话可以将其自身与事件设置器进行比较，并抑制任何源自其自身的更新。

返回值:

无

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

使用指定的属性/值更新来更新与给定选择器匹配的对象。

参数:

• selector (类似 JSON 的数据)

• 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 StringFormatter(*args: Any, id: ID | None = None, **kwargs: Any)

基类: CellFormatter

基本的字符串单元格格式化程序。

JSON 原型

{
  "background_color": {
    "type": "value", 
    "value": null
  }, 
  "font_style": {
    "type": "value", 
    "value": "normal"
  }, 
  "id": "p66225", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "nan_format": "NaN", 
  "null_format": "(null)", 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "text_align": {
    "type": "value", 
    "value": "left"
  }, 
  "text_color": {
    "type": "value", 
    "value": null
  }
}

background_color = None

类型:

ColorSpec

可选的背景颜色。

可接受的值为

• 任何命名的 CSS 颜色，例如 'green', 'indigo'

• RGB(A) 十六进制字符串，例如 '#FF0000', '#44444444'

• CSS4 颜色字符串，例如 'rgba(255, 0, 127, 0.6)', 'rgb(0 127 0 / 1.0)' 或 'hsl(60deg 100% 50% / 1.0)'

• 一个 0 到 255 之间的整数 3 元组 (r, g, b)

• 一个 4 元组 (r, g, b, a)，其中 r、g、b 是 0 到 255 之间的整数，a 是 0 到 1 之间的数

• 一个使用 0xRRGGBBAA 字节顺序模式的 32 位无符号整数

font_style = 'normal'

类型:

FontStyleSpec

可选的文本字体样式，例如粗体、斜体。

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 也不会出于任何原因直接使用该名称。

nan_format = 'NaN'

类型:

字符串

应用于 NaN 和 NaT 值的格式。

null_format = '(null)'

类型:

字符串

应用于 None/null 值的格式。

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 也不会出于任何原因直接使用这些标签。

text_align = 'left'

类型:

TextAlignSpec

可选的文本对齐方式，即左、中或右。

text_color = None

类型:

ColorSpec

可选的文本颜色。

可接受的值为

• 任何命名的 CSS 颜色，例如 'green', 'indigo'

• RGB(A) 十六进制字符串，例如 '#FF0000', '#44444444'

• CSS4 颜色字符串，例如 'rgba(255, 0, 127, 0.6)', 'rgb(0 127 0 / 1.0)' 或 'hsl(60deg 100% 50% / 1.0)'

• 一个 0 到 255 之间的整数 3 元组 (r, g, b)

• 一个 4 元组 (r, g, b, a)，其中 r、g、b 是 0 到 255 之间的整数，a 是 0 到 1 之间的数

• 一个使用 0xRRGGBBAA 字节顺序模式的 32 位无符号整数

apply_theme(property_values: dict[str, Any]) → None

应用一组主题值，这些值将用于代替默认值，但不会覆盖应用程序设置的值。

传递的字典可以按原样保留并与其他实例共享以节省内存（因此调用方和 HasProps 实例都不应修改它）。

参数:

property_values (dict) – 用于代替默认值的主题值

返回值:

无

classmethod clear_extensions() → None

清除任何当前定义的自定义扩展。

序列化调用将导致任何当前定义的自定义扩展包含在生成的文档中，无论它们是否被利用。此方法可用于清除所有现有的自定义扩展定义。

clone(**overrides: Any) → Self

复制 HasProps 对象。

这会创建原始模型的浅克隆，即任何可变容器或子模型都不会被复制。允许在克隆时覆盖特定的属性。

classmethod dataspecs() → dict[str, DataSpec]

收集此类上所有DataSpec属性的名称。

此方法**始终**遍历类层次结构，并包含在任何父类上定义的属性。

返回值:

DataSpec属性的名称

返回类型:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

属性描述符列表，按定义顺序排列。

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等。

参数:

other (HasProps) – 要比较的另一个实例

返回值:

如果属性在结构上相等，则为 True，否则为 False

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

使用 JavaScript 链接两个 Bokeh 模型属性。

这是一种便捷方法，简化了添加 CustomJS 回调以更新一个 Bokeh 模型属性，无论何时另一个属性的值发生变化。

参数:

• attr (str) – 此模型上 Bokeh 属性的名称

• other (Model) – 要链接到 self.attr 的 Bokeh 模型

• other_attr (str) – other 上要链接在一起的属性

• attr_selector (int | str) – 链接可订阅 attr 中项目的索引

在版本 1.1 中添加

引发:

ValueError –

示例

使用 js_link 的此代码

select.js_link('value', plot, 'sizing_mode')

等效于以下内容

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

此外，要使用 attr_selector 将范围滑块的左侧附加到绘图的 x_range

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

等效于

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

将 CustomJS 回调附加到任意 BokehJS 模型事件。

在 BokehJS 端，模型属性的更改事件采用 "change:property_name" 的形式。为方便起见，如果传递给此方法的事件名称也是模型上某个属性的名称，则会自动在其前面加上 "change:"

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

但是，除了属性更改事件之外，还有其他一些事件可能对响应有用。例如，要在一个 ColumnDataSource 中流式传输数据时运行回调，请使用源上的 "stream" 事件

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

在类上查找给定属性名称的 Bokeh 属性的 PropertyDescriptor。

参数:

• name (str) – 要搜索的属性的名称

• raises (bool) – 如果缺少属性，是否引发异常或返回 None

返回值:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

在此对象上添加一个回调，以便在 attr 发生更改时触发。

参数:

• attr (str) – 此对象上的属性名称

• *callbacks (callable) – 要注册的回调函数

返回值:

无

示例

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）

返回值:

从属性名称到其值的映射

返回类型:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

使用谓词查询 HasProps 实例的属性值。

参数:

• query (可调用对象) – 一个可调用对象，它接收属性描述符并返回 True 或 False

• include_defaults (bool, 可选) – 是否包含尚未由用户显式设置的属性（默认值：True）

返回值:

属性名称和值的映射，用于匹配属性

返回类型:

dict

references() → set[Model]

返回此对象引用的所有Models。

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

从该对象中移除回调函数

select(selector: SelectorType) → Iterable[Model]

查询此对象及其所有引用，以查找与给定选择器匹配的对象。

参数:

selector (类似 JSON 的数据)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

查询此对象及其所有引用，以查找与给定选择器匹配的对象。如果找到多个对象，则引发错误。返回单个匹配对象，如果未找到任何对象，则返回 None :param selector: :type selector: 类似 JSON 的数据

返回值:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

从 JSON 中设置此对象上的属性值。

参数:

• name (str) – 要设置的属性的名称

• value (JSON 值) – 要设置为属性的值

• setter (ClientSession 或 ServerSession 或 None, 可选) –

  这用于防止 Bokeh 应用程序的“回旋镖”更新。

  在 Bokeh 服务器应用程序的上下文中，传入的属性更新将使用正在执行更新的会话进行注释。此值将通过更新触发的任何后续更改通知进行传播。会话可以将其自身与事件设置器进行比较，并抑制任何源自其自身的更新。

返回值:

无

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

使用指定的属性/值更新来更新与给定选择器匹配的对象。

参数:

• selector (类似 JSON 的数据)

• 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 SumAggregator(*args: Any, id: ID | None = None, **kwargs: Any)

基类：RowAggregator

跨多行的简单求和。

JSON 原型

{
  "field_": "", 
  "id": "p66235", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}

field_ = ''

类型:

字符串

引用正在聚合的表格列

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 也不会出于任何原因直接使用这些标签。

apply_theme(property_values: dict[str, Any]) → None

应用一组主题值，这些值将用于代替默认值，但不会覆盖应用程序设置的值。

传递的字典可以按原样保留并与其他实例共享以节省内存（因此调用方和 HasProps 实例都不应修改它）。

参数:

property_values (dict) – 用于代替默认值的主题值

返回值:

无

classmethod clear_extensions() → None

清除任何当前定义的自定义扩展。

序列化调用将导致任何当前定义的自定义扩展包含在生成的文档中，无论它们是否被利用。此方法可用于清除所有现有的自定义扩展定义。

clone(**overrides: Any) → Self

复制 HasProps 对象。

这会创建原始模型的浅克隆，即任何可变容器或子模型都不会被复制。允许在克隆时覆盖特定的属性。

classmethod dataspecs() → dict[str, DataSpec]

收集此类上所有DataSpec属性的名称。

此方法**始终**遍历类层次结构，并包含在任何父类上定义的属性。

返回值:

DataSpec属性的名称

返回类型:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

属性描述符列表，按定义顺序排列。

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等。

参数:

other (HasProps) – 要比较的另一个实例

返回值:

如果属性在结构上相等，则为 True，否则为 False

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

使用 JavaScript 链接两个 Bokeh 模型属性。

这是一种便捷方法，简化了添加 CustomJS 回调以更新一个 Bokeh 模型属性，无论何时另一个属性的值发生变化。

参数:

• attr (str) – 此模型上 Bokeh 属性的名称

• other (Model) – 要链接到 self.attr 的 Bokeh 模型

• other_attr (str) – other 上要链接在一起的属性

• attr_selector (int | str) – 链接可订阅 attr 中项目的索引

在版本 1.1 中添加

引发:

ValueError –

示例

使用 js_link 的此代码

select.js_link('value', plot, 'sizing_mode')

等效于以下内容

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

此外，要使用 attr_selector 将范围滑块的左侧附加到绘图的 x_range

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

等效于

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

将 CustomJS 回调附加到任意 BokehJS 模型事件。

在 BokehJS 端，模型属性的更改事件采用 "change:property_name" 的形式。为方便起见，如果传递给此方法的事件名称也是模型上某个属性的名称，则会自动在其前面加上 "change:"

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

但是，除了属性更改事件之外，还有其他一些事件可能对响应有用。例如，要在一个 ColumnDataSource 中流式传输数据时运行回调，请使用源上的 "stream" 事件

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

在类上查找给定属性名称的 Bokeh 属性的 PropertyDescriptor。

参数:

• name (str) – 要搜索的属性的名称

• raises (bool) – 如果缺少属性，是否引发异常或返回 None

返回值:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

在此对象上添加一个回调，以便在 attr 发生更改时触发。

参数:

• attr (str) – 此对象上的属性名称

• *callbacks (callable) – 要注册的回调函数

返回值:

无

示例

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）

返回值:

从属性名称到其值的映射

返回类型:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

使用谓词查询 HasProps 实例的属性值。

参数:

• query (可调用对象) – 一个可调用对象，它接收属性描述符并返回 True 或 False

• include_defaults (bool, 可选) – 是否包含尚未由用户显式设置的属性（默认值：True）

返回值:

属性名称和值的映射，用于匹配属性

返回类型:

dict

references() → set[Model]

返回此对象引用的所有Models。

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

从该对象中移除回调函数

select(selector: SelectorType) → Iterable[Model]

查询此对象及其所有引用，以查找与给定选择器匹配的对象。

参数:

selector (类似 JSON 的数据)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

查询此对象及其所有引用，以查找与给定选择器匹配的对象。如果找到多个对象，则引发错误。返回单个匹配对象，如果未找到任何对象，则返回 None :param selector: :type selector: 类似 JSON 的数据

返回值:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

从 JSON 中设置此对象上的属性值。

参数:

• name (str) – 要设置的属性的名称

• value (JSON 值) – 要设置为属性的值

• setter (ClientSession 或 ServerSession 或 None, 可选) –

  这用于防止 Bokeh 应用程序的“回旋镖”更新。

  在 Bokeh 服务器应用程序的上下文中，传入的属性更新将使用正在执行更新的会话进行注释。此值将通过更新触发的任何后续更改通知进行传播。会话可以将其自身与事件设置器进行比较，并抑制任何源自其自身的更新。

返回值:

无

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

使用指定的属性/值更新来更新与给定选择器匹配的对象。

参数:

• selector (类似 JSON 的数据)

• 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 TableColumn(*args: Any, id: ID | None = None, **kwargs: Any)

基类: Model

表格列部件。

JSON 原型

{
  "default_sort": "ascending", 
  "editor": {
    "id": "p66242", 
    "name": "StringEditor", 
    "type": "object"
  }, 
  "field": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "formatter": {
    "id": "p66241", 
    "name": "StringFormatter", 
    "type": "object"
  }, 
  "id": "p66240", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "sortable": true, 
  "sorter": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "title": null, 
  "visible": true, 
  "width": 300
}

default_sort = 'ascending'

类型:

Enum(Enumeration(ascending, descending))

默认排序顺序。默认情况下使用ascending顺序。

editor = StringEditor(id='p66249', ...)

类型:

Instance(CellEditor)

此列的单元格编辑器。默认情况下，使用简单的字符串编辑器。

field = Undefined

类型:

Required(String)

映射到数据源中列的字段名称。

formatter = StringFormatter(id='p66256', ...)

类型:

Instance(CellFormatter)

此列的单元格格式化器。默认情况下，使用简单的字符串格式化器。

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 也不会出于任何原因直接使用该名称。

sortable = True

类型:

布尔值

此列是否可排序。请注意，数据表必须启用排序才能整体允许排序。

sorter = None

类型:

Nullable(Instance(Comparison))

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 = 300

类型:

Int

此列的宽度或最大宽度（取决于数据表的配置），以像素为单位。

apply_theme(property_values: dict[str, Any]) → None

应用一组主题值，这些值将用于代替默认值，但不会覆盖应用程序设置的值。

传递的字典可以按原样保留并与其他实例共享以节省内存（因此调用方和 HasProps 实例都不应修改它）。

参数:

property_values (dict) – 用于代替默认值的主题值

返回值:

无

classmethod clear_extensions() → None

清除任何当前定义的自定义扩展。

序列化调用将导致任何当前定义的自定义扩展包含在生成的文档中，无论它们是否被利用。此方法可用于清除所有现有的自定义扩展定义。

clone(**overrides: Any) → Self

复制 HasProps 对象。

这会创建原始模型的浅克隆，即任何可变容器或子模型都不会被复制。允许在克隆时覆盖特定的属性。

classmethod dataspecs() → dict[str, DataSpec]

收集此类上所有DataSpec属性的名称。

此方法**始终**遍历类层次结构，并包含在任何父类上定义的属性。

返回值:

DataSpec属性的名称

返回类型:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

属性描述符列表，按定义顺序排列。

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等。

参数:

other (HasProps) – 要比较的另一个实例

返回值:

如果属性在结构上相等，则为 True，否则为 False

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

使用 JavaScript 链接两个 Bokeh 模型属性。

这是一种便捷方法，简化了添加 CustomJS 回调以更新一个 Bokeh 模型属性，无论何时另一个属性的值发生变化。

参数:

• attr (str) – 此模型上 Bokeh 属性的名称

• other (Model) – 要链接到 self.attr 的 Bokeh 模型

• other_attr (str) – other 上要链接在一起的属性

• attr_selector (int | str) – 链接可订阅 attr 中项目的索引

在版本 1.1 中添加

引发:

ValueError –

示例

使用 js_link 的此代码

select.js_link('value', plot, 'sizing_mode')

等效于以下内容

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

此外，要使用 attr_selector 将范围滑块的左侧附加到绘图的 x_range

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

等效于

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

将 CustomJS 回调附加到任意 BokehJS 模型事件。

在 BokehJS 端，模型属性的更改事件采用 "change:property_name" 的形式。为方便起见，如果传递给此方法的事件名称也是模型上某个属性的名称，则会自动在其前面加上 "change:"

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

但是，除了属性更改事件之外，还有其他一些事件可能对响应有用。例如，要在一个 ColumnDataSource 中流式传输数据时运行回调，请使用源上的 "stream" 事件

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

在类上查找给定属性名称的 Bokeh 属性的 PropertyDescriptor。

参数:

• name (str) – 要搜索的属性的名称

• raises (bool) – 如果缺少属性，是否引发异常或返回 None

返回值:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

在此对象上添加一个回调，以便在 attr 发生更改时触发。

参数:

• attr (str) – 此对象上的属性名称

• *callbacks (callable) – 要注册的回调函数

返回值:

无

示例

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）

返回值:

从属性名称到其值的映射

返回类型:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

使用谓词查询 HasProps 实例的属性值。

参数:

• query (可调用对象) – 一个可调用对象，它接收属性描述符并返回 True 或 False

• include_defaults (bool, 可选) – 是否包含尚未由用户显式设置的属性（默认值：True）

返回值:

属性名称和值的映射，用于匹配属性

返回类型:

dict

references() → set[Model]

返回此对象引用的所有Models。

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

从该对象中移除回调函数

select(selector: SelectorType) → Iterable[Model]

查询此对象及其所有引用，以查找与给定选择器匹配的对象。

参数:

selector (类似 JSON 的数据)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

查询此对象及其所有引用，以查找与给定选择器匹配的对象。如果找到多个对象，则引发错误。返回单个匹配对象，如果未找到任何对象，则返回 None :param selector: :type selector: 类似 JSON 的数据

返回值:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

从 JSON 中设置此对象上的属性值。

参数:

• name (str) – 要设置的属性的名称

• value (JSON 值) – 要设置为属性的值

• setter (ClientSession 或 ServerSession 或 None, 可选) –

  这用于防止 Bokeh 应用程序的“回旋镖”更新。

  在 Bokeh 服务器应用程序的上下文中，传入的属性更新将使用正在执行更新的会话进行注释。此值将通过更新触发的任何后续更改通知进行传播。会话可以将其自身与事件设置器进行比较，并抑制任何源自其自身的更新。

返回值:

无

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

使用指定的属性/值更新来更新与给定选择器匹配的对象。

参数:

• selector (类似 JSON 的数据)

• 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 TableWidget(*args: Any, id: ID | None = None, **kwargs: Any)

基类: Widget

数据表格（数据网格）小部件的抽象基类。

注意

这是一个抽象基类，用于帮助组织 Bokeh 模型类型的层次结构。**它本身没有用，不能直接实例化。**

JSON 原型

{
  "align": "auto", 
  "aspect_ratio": null, 
  "context_menu": null, 
  "css_classes": [], 
  "css_variables": {
    "type": "map"
  }, 
  "disabled": false, 
  "elements": [], 
  "flow_mode": "block", 
  "height": null, 
  "height_policy": "auto", 
  "id": "p66281", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "margin": 5, 
  "max_height": null, 
  "max_width": null, 
  "min_height": null, 
  "min_width": null, 
  "name": null, 
  "resizable": false, 
  "sizing_mode": null, 
  "source": {
    "attributes": {
      "data": {
        "type": "map"
      }, 
      "selected": {
        "attributes": {
          "indices": [], 
          "line_indices": []
        }, 
        "id": "p66283", 
        "name": "Selection", 
        "type": "object"
      }, 
      "selection_policy": {
        "id": "p66284", 
        "name": "UnionRenderers", 
        "type": "object"
      }
    }, 
    "id": "p66282", 
    "name": "ColumnDataSource", 
    "type": "object"
  }, 
  "styles": {
    "type": "map"
  }, 
  "stylesheets": [], 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "view": {
    "attributes": {
      "filter": {
        "id": "p66286", 
        "name": "AllIndices", 
        "type": "object"
      }
    }, 
    "id": "p66285", 
    "name": "CDSView", 
    "type": "object"
  }, 
  "visible": true, 
  "width": null, 
  "width_policy": "auto"
}

align = 'auto'

类型:

Either(Auto, Enum(Align), Tuple(Enum(Align), Enum(Align)))

在父容器中的对齐点。

此属性仅在该组件是布局的子元素（例如网格）时才有用。自对齐可以被父容器（例如网格轨道对齐）覆盖。

aspect_ratio = None

类型:

Either(Null, Auto, Float)

描述组件宽度和高度之间的比例关系。

如果组件的任何维度大小灵活，则此功能有效。如果设置为数字，则将保持width / height = aspect_ratio关系。否则，如果设置为"auto"，则将使用组件的首选宽度和高度来确定纵横比（如果未设置，则不会保留任何纵横比）。

context_menu = None

类型:

Nullable(Instance(Menu))

用户右键单击组件时显示的菜单。

注意

右键单击时使用 Shift 键显示本机上下文菜单。

css_classes = []

类型:

列表

要添加到基础 DOM 元素的其他 CSS 类列表。

css_variables = {}

类型:

Dict(String, Instance(Node))

允许定义动态计算的 CSS 变量。

例如，这可用于在画布的渲染器和/或视觉效果以及基于 HTML 的 UI 元素之间协调定位和样式。

此处定义的变量等效于在 CSS 样式表中:host { ... }下设置相同的变量。

注意

此属性为实验性属性，可能会随时更改。

disabled = False

类型:

布尔值

渲染时小部件是否将被禁用。

如果True，则小部件将呈灰色显示，并且对 UI 事件没有响应。

elements = []

类型:

列表

附加到此窗格的基于 DOM 的 UI 元素的集合。

这可能包括工具提示等浮动元素，允许在该元素和其他 UI 元素之间建立父子关系。

flow_mode = 'block'

类型:

Enum(FlowMode)

定义布局将在block或inline维度中流动。

height = None

类型:

Nullable(NonNegative)

组件的高度（以像素为单位）。

根据高度大小策略，这可以是固定高度或首选高度。

height_policy = 'auto'

类型:

Either(Auto, Enum(SizingPolicy))

描述组件应如何保持其高度。

"auto"

使用组件的首选大小策略。

"fixed"

使用正好 height 像素。如果组件无法容纳在可用的垂直空间中，则会溢出。

"fit"

使用组件的首选高度（如果设置）并允许其适应可用的垂直空间，在最小和最大高度边界内（如果设置）。组件的高度既不会被强制最小化也不会被强制最大化。

"min"

使用尽可能少的垂直空间，不少于最小高度（如果设置）。起点是首选高度（如果设置）。组件的高度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

"max"

使用尽可能多的垂直空间，不多于最大高度（如果设置）。起点是首选高度（如果设置）。组件的高度可能会根据父布局、纵横比管理和其他因素而缩小或增大。

注意

这是一个实验性功能，将来可能会更改。请自行谨慎使用。如果不需要这种级别的控制，请优先使用 sizing_mode。

margin = 5

类型:

Nullable(Either(Int, Tuple(Int, Int), Tuple(Int, Int, Int, Int)))

允许在组件周围创建额外的空间。元组中的值按以下顺序排列 - 上边距、右边距、下边距和左边距，类似于 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"

组件将响应式调整大小以适应可用宽度和高度，同时保持原始或提供的纵横比。

source = ColumnDataSource(id='p66401', ...)

类型:

Instance(DataSource)

小部件的数据源。

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 也不会出于任何原因直接使用这些标签。

view = CDSView(id='p66434', ...)

类型:

Instance(CDSView)

渲染表格行时要使用的 DataSource 的视图。如果没有在初始化期间传递视图，则会创建整个 DataSource 的默认视图。

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) – 用于代替默认值的主题值

返回值:

无

类方法 clear_extensions() → None

清除任何当前定义的自定义扩展。

序列化调用将导致任何当前定义的自定义扩展包含在生成的文档中，无论它们是否被利用。此方法可用于清除所有现有的自定义扩展定义。

clone(**overrides: Any) → Self

复制 HasProps 对象。

这会创建原始模型的浅克隆，即任何可变容器或子模型都不会被复制。允许在克隆时覆盖特定的属性。

类方法 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）

返回值:

从属性名称到其值的映射

返回类型:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

使用谓词查询 HasProps 实例的属性值。

参数:

• query (可调用对象) – 一个可调用对象，它接收属性描述符并返回 True 或 False

• include_defaults (bool, 可选) – 是否包含尚未由用户显式设置的属性（默认值：True）

返回值:

属性名称和值的映射，用于匹配属性

返回类型:

dict

references() → set[Model]

返回此对象引用的所有Models。

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

从该对象中移除回调函数

select(selector: SelectorType) → Iterable[Model]

查询此对象及其所有引用，以查找与给定选择器匹配的对象。

参数:

selector (类似 JSON 的数据)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

查询此对象及其所有引用，以查找与给定选择器匹配的对象。如果找到多个对象，则引发错误。返回单个匹配对象，如果未找到任何对象，则返回 None :param selector: :type selector: 类似 JSON 的数据

返回值:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

从 JSON 中设置此对象上的属性值。

参数:

• name (str) – 要设置的属性的名称

• value (JSON 值) – 要设置为属性的值

• setter (ClientSession 或 ServerSession 或 None, 可选) –

  这用于防止 Bokeh 应用程序的“回旋镖”更新。

  在 Bokeh 服务器应用程序的上下文中，传入的属性更新将使用正在执行更新的会话进行注释。此值将通过更新触发的任何后续更改通知进行传播。会话可以将其自身与事件设置器进行比较，并抑制任何源自其自身的更新。

返回值:

无

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

使用指定的属性/值更新来更新与给定选择器匹配的对象。

参数:

• selector (类似 JSON 的数据)

• 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 TextEditor(*args: Any, id: ID | None = None, **kwargs: Any)

基类: CellEditor

多行字符串单元格编辑器。

JSON 原型

{
  "id": "p66454", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}

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 也不会出于任何原因直接使用这些标签。

apply_theme(property_values: dict[str, Any]) → None

应用一组主题值，这些值将用于代替默认值，但不会覆盖应用程序设置的值。

传递的字典可以按原样保留并与其他实例共享以节省内存（因此调用方和 HasProps 实例都不应修改它）。

参数:

property_values (dict) – 用于代替默认值的主题值

返回值:

无

classmethod clear_extensions() → None

清除任何当前定义的自定义扩展。

序列化调用将导致任何当前定义的自定义扩展包含在生成的文档中，无论它们是否被利用。此方法可用于清除所有现有的自定义扩展定义。

clone(**overrides: Any) → Self

复制 HasProps 对象。

这会创建原始模型的浅克隆，即任何可变容器或子模型都不会被复制。允许在克隆时覆盖特定的属性。

classmethod dataspecs() → dict[str, DataSpec]

收集此类上所有DataSpec属性的名称。

此方法**始终**遍历类层次结构，并包含在任何父类上定义的属性。

返回值:

DataSpec属性的名称

返回类型:

set[str]

classmethod descriptors() → list[PropertyDescriptor[Any]]

属性描述符列表，按定义顺序排列。

destroy() → None

清理对文档和属性的引用

equals(other: HasProps) → bool

模型的结构相等。

参数:

other (HasProps) – 要比较的另一个实例

返回值:

如果属性在结构上相等，则为 True，否则为 False

js_link(attr: str, other: Model, other_attr: str, attr_selector: int | str | None = None) → None

使用 JavaScript 链接两个 Bokeh 模型属性。

这是一种便捷方法，简化了添加 CustomJS 回调以更新一个 Bokeh 模型属性，无论何时另一个属性的值发生变化。

参数:

• attr (str) – 此模型上 Bokeh 属性的名称

• other (Model) – 要链接到 self.attr 的 Bokeh 模型

• other_attr (str) – other 上要链接在一起的属性

• attr_selector (int | str) – 链接可订阅 attr 中项目的索引

在版本 1.1 中添加

引发:

ValueError –

示例

使用 js_link 的此代码

select.js_link('value', plot, 'sizing_mode')

等效于以下内容

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

此外，要使用 attr_selector 将范围滑块的左侧附加到绘图的 x_range

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

等效于

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)

js_on_change(event: str, *callbacks: JSChangeCallback) → None

将 CustomJS 回调附加到任意 BokehJS 模型事件。

在 BokehJS 端，模型属性的更改事件采用 "change:property_name" 的形式。为方便起见，如果传递给此方法的事件名称也是模型上某个属性的名称，则会自动在其前面加上 "change:"

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

但是，除了属性更改事件之外，还有其他一些事件可能对响应有用。例如，要在一个 ColumnDataSource 中流式传输数据时运行回调，请使用源上的 "stream" 事件

source.js_on_change('streaming', callback)

classmethod lookup(name: str, *, raises: bool = True) → PropertyDescriptor[Any] | None

在类上查找给定属性名称的 Bokeh 属性的 PropertyDescriptor。

参数:

• name (str) – 要搜索的属性的名称

• raises (bool) – 如果缺少属性，是否引发异常或返回 None

返回值:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

on_change(attr: str, *callbacks: PropertyCallback) → None

在此对象上添加一个回调，以便在 attr 发生更改时触发。

参数:

• attr (str) – 此对象上的属性名称

• *callbacks (callable) – 要注册的回调函数

返回值:

无

示例

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）

返回值:

从属性名称到其值的映射

返回类型:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

使用谓词查询 HasProps 实例的属性值。

参数:

• query (可调用对象) – 一个可调用对象，它接收属性描述符并返回 True 或 False

• include_defaults (bool, 可选) – 是否包含尚未由用户显式设置的属性（默认值：True）

返回值:

属性名称和值的映射，用于匹配属性

返回类型:

dict

references() → set[Model]

返回此对象引用的所有Models。

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

从该对象中移除回调函数

select(selector: SelectorType) → Iterable[Model]

查询此对象及其所有引用，以查找与给定选择器匹配的对象。

参数:

selector (类似 JSON 的数据)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

查询此对象及其所有引用，以查找与给定选择器匹配的对象。如果找到多个对象，则引发错误。返回单个匹配对象，如果未找到任何对象，则返回 None :param selector: :type selector: 类似 JSON 的数据

返回值:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

从 JSON 中设置此对象上的属性值。

参数:

• name (str) – 要设置的属性的名称

• value (JSON 值) – 要设置为属性的值

• setter (ClientSession 或 ServerSession 或 None, 可选) –

  这用于防止 Bokeh 应用程序的“回旋镖”更新。

  在 Bokeh 服务器应用程序的上下文中，传入的属性更新将使用正在执行更新的会话进行注释。此值将通过更新触发的任何后续更改通知进行传播。会话可以将其自身与事件设置器进行比较，并抑制任何源自其自身的更新。

返回值:

无

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

使用指定的属性/值更新来更新与给定选择器匹配的对象。

参数:

• selector (类似 JSON 的数据)

• 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 TimeEditor(*args: Any, id: ID | None = None, **kwargs: Any)

基类: CellEditor

基于微调器的时段单元格编辑器。

JSON 原型

{
  "id": "p66458", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}

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 也不会出于任何原因直接使用这些标签。

apply_theme(property_values: dict[str, Any]) → None

应用一组主题值，这些值将用于代替默认值，但不会覆盖应用程序设置的值。

传递的字典可以按原样保留并与其他实例共享以节省内存（因此调用方和 HasProps 实例都不应修改它）。

参数:

property_values (dict) – 用于代替默认值的主题值

返回值:

无

classmethod clear_extensions() → None

清除任何当前定义的自定义扩展。

序列化调用将导致任何当前定义的自定义扩展包含在生成的文档中，无论它们是否被利用。此方法可用于清除所有现有的自定义扩展定义。

克隆(**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)

classmethod properties(*, _with_props: bool = False) → set[str] | dict[str, Property[Any]]

收集此类上属性的名称。

警告

在 Bokeh 的未来版本中，此方法将返回一个字典，该字典将属性名称映射到属性对象。为了使此方法的当前用法面向未来，请将返回值包装在 list 中。

返回值:

属性名称

classmethod properties_with_refs() → dict[str, Property[Any]]

收集此类上所有也具有引用的属性的名称。

此方法**始终**遍历类层次结构，并包含在任何父类上定义的属性。

返回值:

具有引用的属性的名称

返回类型:

set[str]

properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

收集一个字典，将属性名称映射到其值。

此方法**始终**遍历类层次结构，并包含在任何父类上定义的属性。

不可序列化的属性将被跳过，并且属性值将采用“序列化”格式，这可能与您通常从属性中读取的值略有不同；此方法的目的是返回无损重构对象实例所需的信息。

参数:

include_defaults (bool, optional) – 是否包含自对象创建以来尚未显式设置的属性。（默认值：True）

返回值:

从属性名称到其值的映射

返回类型:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[str, Any]

使用谓词查询 HasProps 实例的属性值。

参数:

• query (可调用对象) – 一个可调用对象，它接收属性描述符并返回 True 或 False

• include_defaults (bool, 可选) – 是否包含尚未由用户显式设置的属性（默认值：True）

返回值:

属性名称和值的映射，用于匹配属性

返回类型:

dict

references() → set[Model]

返回此对象引用的所有Models。

remove_on_change(attr: str, *callbacks: Callable[[str, Any, Any], None]) → None

从该对象中移除回调函数

select(selector: SelectorType) → Iterable[Model]

查询此对象及其所有引用，以查找与给定选择器匹配的对象。

参数:

selector (类似 JSON 的数据)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

查询此对象及其所有引用，以查找与给定选择器匹配的对象。如果找到多个对象，则引发错误。返回单个匹配对象，如果未找到任何对象，则返回 None :param selector: :type selector: 类似 JSON 的数据

返回值:

Model

set_from_json(name: str, value: Any, *, setter: Setter | None = None) → None

从 JSON 中设置此对象上的属性值。

参数:

• name (str) – 要设置的属性的名称

• value (JSON 值) – 要设置为属性的值

• setter (ClientSession 或 ServerSession 或 None, 可选) –

  这用于防止 Bokeh 应用程序的“回旋镖”更新。

  在 Bokeh 服务器应用程序的上下文中，传入的属性更新将使用正在执行更新的会话进行注释。此值将通过更新触发的任何后续更改通知进行传播。会话可以将其自身与事件设置器进行比较，并抑制任何源自其自身的更新。

返回值:

无

set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) → None

使用指定的属性/值更新来更新与给定选择器匹配的对象。

参数:

• selector (类似 JSON 的数据)

• 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）