比较

表示由 BokehJS 在客户端（浏览器）端执行的比较。这些比较可能对指定如何对 DataTable 列进行排序很有用。

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

基类：Model

表示要在客户端执行的比较的 Comparison 模型的基类。

JavaScript 实现应该实现以下方法

compute(x: unknown, y: unknown): -1 | 0 | 1 {
    //  compare and return -1, 0, or 1
}

注意

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

JSON 原型

{
  "id": "p57332", 
  "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) – 用作默认值的主题值

返回值:

None

classmethod clear_extensions() → None

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

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

clone(**overrides: Any) → Self

复制 HasProps 对象。

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

classmethod dataspecs() → dict[str, DataSpec]

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

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

返回值:

DataSpec 属性的名称

返回类型：:

set[str]

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

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

destroy() → None

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

equals(other: HasProps) → bool

模型的结构相等。

参数:

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

返回值:

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

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

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

这是一个方便的方法，它简化了添加 CustomJS 回调以更新一个 Bokeh 模型属性，只要另一个模型属性的值发生变化。

参数:

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

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

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

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

在版本 1.1 中添加

引发：:

ValueError –

示例

这段使用 js_link 的代码

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

等效于以下代码

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

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

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

这等效于

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

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

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

在 BokehJS 方面，模型属性的更改事件的形式为 "change:property_name"。为了方便起见，如果传递给此方法的事件名称也是模型上属性的名称，那么它将自动加上前缀 "change:"

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

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

source.js_on_change('streaming', callback)

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

在类上找到 Bokeh 属性的 PropertyDescriptor，给出属性名称。

参数:

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

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

返回值:

名为 name 的属性的描述符

返回类型：:

PropertyDescriptor

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

在该对象上添加一个回调函数，当 attr 发生变化时触发。

参数:

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

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

返回值:

None

示例

widget.on_change('value', callback1, callback2, ..., callback_n)

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

当指定事件发生在该模型上时运行回调函数。

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

classmethod parameters() → list[Parameter]

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

返回值:

list(Parameter)

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

收集该类上的属性名称。

警告

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

返回值:

属性名称

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

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

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

返回值:

具有引用的属性名称

返回类型：:

set[str]

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

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

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

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

参数:

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

返回值:

从属性名称到其值的映射

返回类型：:

dict

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

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

参数:

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

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

返回值:

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

返回类型：:

dict

references() → set[Model]

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

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

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

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (JSON-like)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

查询该对象及其所有引用，以查找与给定选择器匹配的对象。如果找到多个对象，则会引发错误。返回单个匹配对象，如果未找到则返回 None。 :param selector: :type selector: JSON-like

返回值:

Model

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

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

参数:

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

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

• setter (ClientSession or ServerSession or None, optional) –

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

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

返回值:

None

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

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

参数:

• selector (JSON-like)

• updates (dict)

返回值:

None

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

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

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

返回值:

字典或 None

to_serializable(serializer: Serializer) → ObjectRefRep

将该对象转换为可序列化表示形式。

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

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

返回值:

None

update(**kwargs: Any) → None

从给定的关键字参数更新对象的属性。

返回值:

None

示例

以下等效

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

该模型所附加的 Document（可以是 None）

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

Bases: Comparison

通过评估用户提供的 JavaScript 函数来执行客户端比较。此比较对 DataTable 列很有用。

警告

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

JSON 原型

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

args = {}

类型:

Dict(String, AnyRef)

名称到 Python 对象的映射。尤其是那些可以是 bokeh 的模型。这些对象在回调代码段中作为回调的命名参数的值可用。无需手动包含关联的图形渲染器的數據源，因为它可以通过 this 关键字在代码范围内使用（例如 this.data 将提供对原始数据的访问）。

code = ''

类型:

String

要在浏览器中执行的 JavaScript 代码片段。代码被制成生成器函数的主体，并且 args 中的所有命名对象都作为代码可以使用的参数可用。必须返回 -1、0 或 1。

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

返回值:

None

classmethod clear_extensions() → None

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

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

clone(**overrides: Any) → Self

复制 HasProps 对象。

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

classmethod dataspecs() → dict[str, DataSpec]

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

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

返回值:

DataSpec 属性的名称

返回类型：:

set[str]

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

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

destroy() → None

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

equals(other: HasProps) → bool

模型的结构相等。

参数:

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

返回值:

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

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

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

这是一个方便的方法，它简化了添加 CustomJS 回调以更新一个 Bokeh 模型属性，只要另一个模型属性的值发生变化。

参数:

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

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

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

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

在版本 1.1 中添加

引发：:

ValueError –

示例

这段使用 js_link 的代码

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

等效于以下代码

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

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

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

这等效于

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

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

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

在 BokehJS 方面，模型属性的更改事件的形式为 "change:property_name"。为了方便起见，如果传递给此方法的事件名称也是模型上属性的名称，那么它将自动加上前缀 "change:"

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

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

source.js_on_change('streaming', callback)

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

在类上找到 Bokeh 属性的 PropertyDescriptor，给出属性名称。

参数:

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

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

返回值:

名为 name 的属性的描述符

返回类型：:

PropertyDescriptor

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

在该对象上添加一个回调函数，当 attr 发生变化时触发。

参数:

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

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

返回值:

None

示例

widget.on_change('value', callback1, callback2, ..., callback_n)

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

当指定事件发生在该模型上时运行回调函数。

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

classmethod parameters() → list[Parameter]

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

返回值:

list(Parameter)

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

收集该类上的属性名称。

警告

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

返回值:

属性名称

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

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

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

返回值:

具有引用的属性名称

返回类型：:

set[str]

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

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

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

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

参数:

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

返回值:

从属性名称到其值的映射

返回类型：:

dict

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

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

参数:

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

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

返回值:

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

返回类型：:

dict

references() → set[Model]

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

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

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

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (JSON-like)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model |

返回值:

Model

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

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

参数:

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

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

• setter (ClientSession or ServerSession or None, optional) –

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

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

返回值:

None

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

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

参数:

• selector (JSON-like)

• updates (dict)

返回值:

None

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

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

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

返回值:

字典或 None

to_serializable(serializer: Serializer) → ObjectRefRep

将该对象转换为可序列化表示形式。

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

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

返回值:

None

update(**kwargs: Any) → None

从给定的关键字参数更新对象的属性。

返回值:

None

示例

以下等效

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

该模型所附加的 Document（可以是 None）

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

Bases: Comparison

用于对 NaN 值进行排序的客户端比较操作。此比较操作对 DataTable 列很有用。

JSON 原型

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

ascending_first = False

类型:

布尔值

在升序排序中，NaN 值是否应该出现在最前面或最后面。

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

返回值:

None

classmethod clear_extensions() → None

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

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

clone(**overrides: Any) → Self

复制 HasProps 对象。

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

classmethod dataspecs() → dict[str, DataSpec]

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

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

返回值:

DataSpec 属性的名称

返回类型：:

set[str]

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

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

destroy() → None

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

equals(other: HasProps) → bool

模型的结构相等。

参数:

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

返回值:

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

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

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

这是一个方便的方法，它简化了添加 CustomJS 回调以更新一个 Bokeh 模型属性，只要另一个模型属性的值发生变化。

参数:

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

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

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

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

在版本 1.1 中添加

引发：:

ValueError –

示例

这段使用 js_link 的代码

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

等效于以下代码

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

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

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

这等效于

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

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

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

在 BokehJS 方面，模型属性的更改事件的形式为 "change:property_name"。为了方便起见，如果传递给此方法的事件名称也是模型上属性的名称，那么它将自动加上前缀 "change:"

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

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

source.js_on_change('streaming', callback)

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

在类上找到 Bokeh 属性的 PropertyDescriptor，给出属性名称。

参数:

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

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

返回值:

名为 name 的属性的描述符

返回类型：:

PropertyDescriptor

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

在该对象上添加一个回调函数，当 attr 发生变化时触发。

参数:

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

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

返回值:

None

示例

widget.on_change('value', callback1, callback2, ..., callback_n)

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

当指定事件发生在该模型上时运行回调函数。

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

classmethod parameters() → list[Parameter]

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

参数:

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

返回值:

从属性名称到其值的映射

返回类型：:

dict

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

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

参数:

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

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

返回值:

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

返回类型：:

dict

references() → set[Model]

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

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

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

select(selector: SelectorType) → Iterable[Model]

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

参数:

selector (JSON-like)

返回值:

seq[Model]

select_one(selector: SelectorType) → Model | None

查询该对象及其所有引用，以查找与给定选择器匹配的对象。如果找到多个对象，则会引发错误。返回单个匹配对象，如果未找到则返回 None。 :param selector: :type selector: JSON-like

返回值:

Model

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

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

参数:

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

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

• setter (ClientSession or ServerSession or None, optional) –

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

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

返回值:

None

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

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

参数:

• selector (JSON-like)

• updates (dict)

返回值:

None

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

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

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

返回值:

字典或 None

to_serializable(serializer: Serializer) → ObjectRefRep

将该对象转换为可序列化表示形式。

trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) → None

unapply_theme() → None

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

返回值:

None

update(**kwargs: Any) → None

从给定的关键字参数更新对象的属性。

返回值:

None

示例

以下等效

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)

property document: Document | None

该模型所附加的 Document（可以是 None）