文本

与文本相关的模型

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

基础类：MathText

使用 AsciiMath 符号渲染数学内容。

JSON 原型

{
  "id": "p62918", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "text": {
    "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 也不会直接出于任何原因使用这些标签。

text = Undefined

类型:

Required(String)

要渲染的文本值。

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。

返回值:

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

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

返回值:

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

基础类：MathText

使用 MathML 符号渲染数学内容。

有关更多信息，请参阅 数学符号 在 用户指南 中。

JSON 原型

{
  "id": "p62923", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "text": {
    "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 也不会直接出于任何原因使用这些标签。

text = Undefined

类型:

Required(String)

要渲染的文本值。

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。

返回值:

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

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

返回值:

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

Bases: BaseText

数学内容渲染器的基类。

注意

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

JSON 原型

{
  "id": "p62928", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "text": {
    "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 也不会直接出于任何原因使用这些标签。

text = Undefined

类型:

Required(String)

要渲染的文本值。

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:

在此对象上添加一个回调，以在 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,

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。

返回值:

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

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

返回值:

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

Bases: BaseText

表示在允许文本解析的上下文中纯文本。

JSON 原型

{
  "id": "p62933", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "text": {
    "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 也不会直接出于任何原因使用这些标签。

text = Undefined

类型:

Required(String)

要渲染的文本值。

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

生成适合从图形派生的函数的 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。

返回值:

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

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

返回值:

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

基础类：MathText

使用 LaTeX 符号渲染数学内容。

有关更多信息，请参阅 数学符号 在 用户指南 中。

注意

Bokeh 使用 MathJax 渲染包含数学符号的文本。

MathJax 仅支持数学模式宏（不支持文本模式宏）。您可以在此处查看标准 TeX/LaTeX 和 MathJax 之间的更多区别：https://docs.mathjax.org/en/latest/input/tex/differences.html

JSON 原型

{
  "id": "p62938", 
  "inline": false, 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "macros": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "text": {
    "name": "unset", 
    "type": "symbol"
  }
}

inline = False

类型:

布尔值

数学文本是内联显示还是否（用于 TeX 输入）。默认为 False。

macros = {}

类型:

Dict(String, Either(String, Tuple(String, Int)))

用户定义的 TeX 宏。

这是一个从控制序列名称（没有前导反斜杠）到替换字符串或替换字符串和参数数量元组的映射。

示例

TeX(text=r"\R \rightarrow \R^2", macros={"RR": r"{\bf R}"})

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

text = Undefined

类型:

Required(String)

要渲染的文本值。

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[[], 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

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。

返回值:

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

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

返回值:

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）