回调函数

客户端交互性。

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

基类：Model

交互式回调的基类。

注意

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

JSON 原型

{
  "id": "p57293", 
  "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 的属性的描述符

返回类型：

属性描述符

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 (callable) – 一个可调用的函数，它接受属性描述符并返回 True 或 False

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

返回值：

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

返回类型：

dict

references() → set[Model]

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

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

从该对象中移除一个回调函数。

select(selector: SelectorType) → Iterable[Model]

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

参数：

selector (类似 JSON 的数据)

返回值：

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。

返回值：

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

基类：Callback

关闭对话框。

JSON 原型

{
  "dialog": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "id": "p57297", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}

dialog = Undefined

类型：

Required(Instance(Dialog))

要关闭的对话框实例。

此操作的行为取决于对话框的配置，特别是Dialog.close_action属性。

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 的属性的描述符

返回类型：

属性描述符

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 (callable) – 一个可调用的函数，它接受属性描述符并返回 True 或 False

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

返回值：

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

返回类型：

dict

references() → set[Model]

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

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

从该对象中移除一个回调函数。

select(selector: SelectorType) → Iterable[Model]

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

参数：

selector (类似 JSON 的数据)

返回值：

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。

返回值：

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

基类: CustomCode

执行 JavaScript 函数。

警告

此 Bokeh 模型的明确目的是嵌入原始 JavaScript 代码供浏览器执行。如果代码的任何部分都源自不受信任的用户输入，则必须在传递给 Bokeh 之前采取适当的措施对用户输入进行清理。

JSON 原型

{
  "args": {
    "type": "map"
  }, 
  "code": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "id": "p57302", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "module": "auto", 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}

args = {}

类型：

Dict(String, AnyRef)

名称到 Python 对象的映射。特别是，这些可以是 Bokeh 的模型。这些对象作为命名参数的值提供给回调的代码片段，作为回调的参数。

code = Undefined

类型：

Required(String)

在浏览器中执行的 JavaScript 代码片段。

根据module属性，它可以被解释为 JavaScript 函数或模块。

1. JS 函数。

代码被转换为函数体，并且args中所有命名的对象都可用作代码可以使用的参数。此外，cb_obj参数包含触发回调的对象，一个可选的cb_data参数包含任何特定于工具的数据（例如，HoverTool的鼠标坐标和悬停的图形索引）以及cb_context参数中的其他文档上下文。

2. ES 模块。

一个 JavaScript 模块 (ESM)，导出一个具有以下签名的默认函数

其中args是用户提供的参数的键值映射，obj指的是触发回调的对象，data是调用者提供的可选参数的键值映射，context是额外的文档上下文。

其他文档上下文由以下成员组成

• index：管理当前 Bokeh 实例中所有视图的视图管理器。如果只加载了一个 Bokeh 实例，则这等效于使用 Bokeh.index。

例如，如果需要外部资源，此函数可以是异步函数（async function () {} 或 async () => {}），这将需要使用其中一个异步 Web API，例如

module = 'auto'

类型：

Either(Auto, Bool)

是否将代码解释为 JS 函数或 ES 模块。如果设置为"auto"，则将从代码中推断出来。

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

classmethod from_file(path: PathLike, **args: any) → CustomJS

从*.js或*.mjs文件构造一个CustomJS实例。

例如，如果我们想从一个 JavaScript 模块my_module.mjs构造一个CustomJS实例，该模块接受一个名为source的参数，那么我们将使用

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 的属性的描述符

返回类型：

属性描述符

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 (callable) – 一个可调用的函数，它接受属性描述符并返回 True 或 False

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

返回值：

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

返回类型：

dict

references() → set[Model]

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

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

从该对象中移除一个回调函数。

select(selector: SelectorType) → Iterable[Model]

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

参数：

selector (类似 JSON 的数据)

返回值：

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。

返回值：

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

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

基类：Callback

打开一个对话框。

JSON 原型

{
  "dialog": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "id": "p57309", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}

dialog = Undefined

类型：

Required(Instance(Dialog))

要打开的对话框实例。

这将构建并显示一个新的对话框视图，或者如果它被隐藏则重新打开现有的对话框视图。

注意

要显示对话框的多个实例，需要克隆对话框的模型并使用另一个 OpenDialog 实例。

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 的属性的描述符

返回类型：

属性描述符

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 (callable) – 一个可调用的函数，它接受属性描述符并返回 True 或 False

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

返回值：

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

返回类型：

dict

references() → set[Model]

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

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

从该对象中移除一个回调函数。

select(selector: SelectorType) → Iterable[Model]

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

参数：

selector (类似 JSON 的数据)

返回值：

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。

返回值：

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

基类：Callback

在新的或当前的标签页或窗口中打开 URL。

JSON 原型

{
  "id": "p57314", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "same_tab": false, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "url": "http://"
}

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

same_tab = False

类型：

布尔值

在新的（False，默认）或当前（True）标签页或窗口中打开 URL。对于 same_tab=False，是否打开标签页或窗口取决于浏览器。

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

url = 'http://'

类型：

字符串

网页浏览器要跳转到的 URL。这可以是一个模板字符串，它将使用来自数据源的数据进行格式化。

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 的属性的描述符

返回类型：

属性描述符

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 (callable) – 一个可调用的函数，它接受属性描述符并返回 True 或 False

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

返回值：

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

返回类型：

dict

references() → set[Model]

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

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

从该对象中移除一个回调函数。

select(selector: SelectorType) → Iterable[Model]

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

参数：

selector (类似 JSON 的数据)

返回值：

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。

返回值：

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

基类：Callback

允许更新对象的属性。

JSON 原型

{
  "attr": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "id": "p57320", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "obj": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "value": {
    "name": "unset", 
    "type": "symbol"
  }
}

attr = Undefined

类型：

Required(String)

要修改的属性。

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

obj = Undefined

类型：

Required(Instance(HasProps))

要设置值的object。

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

value = Undefined

类型：

Required(Any)

要设置的值。

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 的属性的描述符

返回类型：

属性描述符

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 (callable) – 一个可调用的函数，它接受属性描述符并返回 True 或 False

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

返回值：

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

返回类型：

dict

references() → set[Model]

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

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

从该对象中移除一个回调函数。

select(selector: SelectorType) → Iterable[Model]

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

参数：

selector (类似 JSON 的数据)

返回值：

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。

返回值：

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

基类：Callback

切换 UI 元素的可见性。

JSON 原型

{
  "id": "p57327", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "target": {
    "name": "unset", 
    "type": "symbol"
  }
}

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

target = Undefined

类型：

Required(Instance(UIElement))

要显示或隐藏的 UI 元素。

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 的属性的描述符

返回类型：

属性描述符

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 (callable) – 一个可调用的函数，它接受属性描述符并返回 True 或 False

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

返回值：

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

返回类型：

dict

references() → set[Model]

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

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

从该对象中移除一个回调函数。

select(selector: SelectorType) → Iterable[Model]

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

参数：

selector (类似 JSON 的数据)

返回值：

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。

返回值：

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