css#

CSS 对象模型的各种抽象。

class GlobalImportedStyleSheet(*args: Any, id: ID | None = None, **kwargs: Any)[source]#

Bases: ImportedStyleSheet

一个导入的样式表，它被追加到 <head> 元素。

注意

样式表将只追加一次，无论它在其他模型中使用多少次。

JSON 原型
{
  "id": "p57347", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "url": {
    "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#
类型：

Bool

指示此模型是否应在 Web 浏览器中更新时同步回 Bokeh 服务器。设置为 False 可能有助于在处理经常更新的对象时减少网络流量，而我们不需要其更新的值。

注意

将此属性设置为 False 将阻止对该对象的任何 on_change() 回调触发。但是，任何 JS 端回调仍将起作用。

tags = []#
类型：

List

一个可选的任意用户提供的附加到此模型的值列表。

当查询文档以检索特定 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 = 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

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

这是一种简便方法，简化了添加 CustomJS 回调以在另一个 Bokeh 模型属性更改值时更新一个 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 (可调用对象) – 要注册的回调函数

返回值：

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, 可选) – 是否包含自对象创建以来未明确设置的属性。 (默认值: True)

返回值：

从属性名称到其值的映射

返回类型:

dict

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

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

参数：

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

  • include_defaults (bool, 可选) – 是否包含用户未明确设置的属性 (默认值: True)

返回值：

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

返回类型:

dict

references() → set[Model]#

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

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

从该对象中删除回调。

select(selector: SelectorType) → Iterable[Model]#

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

参数：

selector (JSON-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 GlobalInlineStyleSheet(*args: Any, id: ID | None = None, **kwargs: Any)[source]#

Bases: InlineStyleSheet

一个附加到 <head> 元素的内联样式表。

注意

样式表将只追加一次，无论它在其他模型中使用多少次。

JSON 原型
{
  "css": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "id": "p57352", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}
css = 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 不会出于任何原因直接使用该名称。

syncable = True#
类型：

Bool

指示此模型是否应在 Web 浏览器中更新时同步回 Bokeh 服务器。设置为 False 可能有助于在处理经常更新的对象时减少网络流量，而我们不需要其更新的值。

注意

将此属性设置为 False 将阻止对该对象的任何 on_change() 回调触发。但是，任何 JS 端回调仍将起作用。

tags = []#
类型：

List

一个可选的任意用户提供的附加到此模型的值列表。

当查询文档以检索特定 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

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

这是一种简便方法，简化了添加 CustomJS 回调以在另一个 Bokeh 模型属性更改值时更新一个 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 (可调用对象) – 要注册的回调函数

返回值：

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, 可选) – 是否包含自对象创建以来未明确设置的属性。 (默认值: True)

返回值：

从属性名称到其值的映射

返回类型:

dict

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

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

参数：

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

  • include_defaults (bool, 可选) – 是否包含用户未明确设置的属性 (默认值: True)

返回值：

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

返回类型:

dict

references() → set[Model]#

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

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

从该对象中删除回调。

select(selector: SelectorType) → Iterable[Model]#

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

参数：

selector (JSON-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 ImportedStyleSheet(*args: Any, id: ID | None = None, **kwargs: Any)[source]#

Bases: StyleSheet

导入的样式表，等效于 <link rel="stylesheet" href="${url}">.

注意

根据上下文，此样式表将被追加到父级阴影根节点（如果在组件中使用）或追加到 <head> 元素。如果您想在任何上下文中全局追加，请使用 GlobalImportedStyleSheet 代替。

JSON 原型
{
  "id": "p57357", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": [], 
  "url": {
    "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#
类型：

Bool

指示此模型是否应在 Web 浏览器中更新时同步回 Bokeh 服务器。设置为 False 可能有助于在处理经常更新的对象时减少网络流量，而我们不需要其更新的值。

注意

将此属性设置为 False 将阻止对该对象的任何 on_change() 回调触发。但是，任何 JS 端回调仍将起作用。

tags = []#
类型：

List

一个可选的任意用户提供的附加到此模型的值列表。

当查询文档以检索特定 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 = 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

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

这是一种简便方法，简化了添加 CustomJS 回调以在另一个 Bokeh 模型属性更改值时更新一个 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(eventCustomJS 回调附加到任意 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 (可调用对象) – 要注册的回调函数

返回值：

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, 可选) – 是否包含自对象创建以来未明确设置的属性。 (默认值: True)

返回值：

从属性名称到其值的映射

返回类型:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) → dict[HasProps 实例的属性值。

参数：

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

  • include_defaults (bool, 可选) – 是否包含用户未明确设置的属性 (默认值: True)

返回值：

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

返回类型:

dict

references() → set[Model]#

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

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

从该对象中删除回调。

select(selector: SelectorType) → Iterable[Model]#

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

参数：

selector (JSON-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 InlineStyleSheet(*args: Any, id: ID | None = None, **kwargs: Any)[source]#

Bases: StyleSheet

与 <style type="text/css">${css}</style> 相当的内联样式表。

注意

根据上下文，此样式表将附加到父级影子根元素（如果在组件中使用），或者附加到 <head> 元素。如果您希望无论上下文如何都全局附加，请改用 GlobalInlineStyleSheet。

JSON 原型
{
  "css": {
    "name": "unset", 
    "type": "symbol"
  }, 
  "id": "p57362", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}
css = 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 不会出于任何原因直接使用该名称。

syncable = True#
类型：

Bool

指示此模型是否应在 Web 浏览器中更新时同步回 Bokeh 服务器。设置为 False 可能有助于在处理经常更新的对象时减少网络流量，而我们不需要其更新的值。

注意

将此属性设置为 False 将阻止对该对象的任何 on_change() 回调触发。但是，任何 JS 端回调仍将起作用。

tags = []#
类型：

List

一个可选的任意用户提供的附加到此模型的值列表。

当查询文档以检索特定 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

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

这是一种简便方法，简化了添加 CustomJS 回调以在另一个 Bokeh 模型属性更改值时更新一个 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 (可调用对象) – 要注册的回调函数

返回值：

None

例子

widget.on_change('value', callback1, callback2, ..., callback_n)
on_event(event: str | type[Event], *callbacks: Callable[[Event], 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, 可选) – 是否包含自对象创建以来未明确设置的属性。 (默认值: True)

返回值：

从属性名称到其值的映射

返回类型:

dict

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

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

参数：

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

  • include_defaults (bool, 可选) – 是否包含用户未明确设置的属性 (默认值: True)

返回值：

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

返回类型:

dict

references() → set[Model]#

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

remove_on_change(attr: str

从该对象中删除回调。

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 Styles(*args: Any, id: ID | None = None, **kwargs: Any)[source]#

Bases: Model

允许配置 DOM 元素的样式属性。

JSON 原型
{
  "align_content": null, 
  "align_items": null, 
  "align_self": null, 
  "alignment_baseline": null, 
  "all": null, 
  "animation": null, 
  "animation_delay": null, 
  "animation_direction": null, 
  "animation_duration": null, 
  "animation_fill_mode": null, 
  "animation_iteration_count": null, 
  "animation_name": null, 
  "animation_play_state": null, 
  "animation_timing_function": null, 
  "aspect_ratio": null, 
  "backface_visibility": null, 
  "background": null, 
  "background_attachment": null, 
  "background_clip": null, 
  "background_color": null, 
  "background_image": null, 
  "background_origin": null, 
  "background_position": null, 
  "background_position_x": null, 
  "background_position_y": null, 
  "background_repeat": null, 
  "background_size": null, 
  "baseline_shift": null, 
  "block_size": null, 
  "border": null, 
  "border_block_end": null, 
  "border_block_end_color": null, 
  "border_block_end_style": null, 
  "border_block_end_width": null, 
  "border_block_start": null, 
  "border_block_start_color": null, 
  "border_block_start_style": null, 
  "border_block_start_width": null, 
  "border_bottom": null, 
  "border_bottom_color": null, 
  "border_bottom_left_radius": null, 
  "border_bottom_right_radius": null, 
  "border_bottom_style": null, 
  "border_bottom_width": null, 
  "border_collapse": null, 
  "border_color": null, 
  "border_image": null, 
  "border_image_outset": null, 
  "border_image_repeat": null, 
  "border_image_slice": null, 
  "border_image_source": null, 
  "border_image_width": null, 
  "border_inline_end": null, 
  "border_inline_end_color": null, 
  "border_inline_end_style": null, 
  "border_inline_end_width": null, 
  "border_inline_start": null, 
  "border_inline_start_color": null, 
  "border_inline_start_style": null, 
  "border_inline_start_width": null, 
  "border_left": null, 
  "border_left_color": null, 
  "border_left_style": null, 
  "border_left_width": null, 
  "border_radius": null, 
  "border_right": null, 
  "border_right_color": null, 
  "border_right_style": null, 
  "border_right_width": null, 
  "border_spacing": null, 
  "border_style": null, 
  "border_top": null, 
  "border_top_color": null, 
  "border_top_left_radius": null, 
  "border_top_right_radius": null, 
  "border_top_style": null, 
  "border_top_width": null, 
  "border_width": null, 
  "bottom": null, 
  "box_shadow": null, 
  "box_sizing": null, 
  "break_after": null, 
  "break_before": null, 
  "break_inside": null, 
  "caption_side": null, 
  "caret_color": null, 
  "clear": null, 
  "clip": null, 
  "clip_path": null, 
  "clip_rule": null, 
  "color": null, 
  "color_interpolation": null, 
  "color_interpolation_filters": null, 
  "column_count": null, 
  "column_fill": null, 
  "column_gap": null, 
  "column_rule": null, 
  "column_rule_color": null, 
  "column_rule_style": null, 
  "column_rule_width": null, 
  "column_span": null, 
  "column_width": null, 
  "columns": null, 
  "content": null, 
  "counter_increment": null, 
  "counter_reset": null, 
  "cursor": null, 
  "direction": null, 
  "display": null, 
  "dominant_baseline": null, 
  "empty_cells": null, 
  "fill": null, 
  "fill_opacity": null, 
  "fill_rule": null, 
  "filter": null, 
  "flex": null, 
  "flex_basis": null, 
  "flex_direction": null, 
  "flex_flow": null, 
  "flex_grow": null, 
  "flex_shrink": null, 
  "flex_wrap": null, 
  "float": null, 
  "flood_color": null, 
  "flood_opacity": null, 
  "font": null, 
  "font_family": null, 
  "font_feature_settings": null, 
  "font_kerning": null, 
  "font_size": null, 
  "font_size_adjust": null, 
  "font_stretch": null, 
  "font_style": null, 
  "font_synthesis": null, 
  "font_variant": null, 
  "font_variant_caps": null, 
  "font_variant_east_asian": null, 
  "font_variant_ligatures": null, 
  "font_variant_numeric": null, 
  "font_variant_position": null, 
  "font_weight": null, 
  "gap": null, 
  "glyph_orientation_vertical": null, 
  "grid": null, 
  "grid_area": null, 
  "grid_auto_columns": null, 
  "grid_auto_flow": null, 
  "grid_auto_rows": null, 
  "grid_column": null, 
  "grid_column_end": null, 
  "grid_column_gap": null, 
  "grid_column_start": null, 
  "grid_gap": null, 
  "grid_row": null, 
  "grid_row_end": null, 
  "grid_row_gap": null, 
  "grid_row_start": null, 
  "grid_template": null, 
  "grid_template_areas": null, 
  "grid_template_columns": null, 
  "grid_template_rows": null, 
  "height": null, 
  "hyphens": null, 
  "id": "p57367", 
  "image_orientation": null, 
  "image_rendering": null, 
  "inline_size": null, 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "justify_content": null, 
  "justify_items": null, 
  "justify_self": null, 
  "left": null, 
  "letter_spacing": null, 
  "lighting_color": null, 
  "line_break": null, 
  "line_height": null, 
  "list_style": null, 
  "list_style_image": null, 
  "list_style_position": null, 
  "list_style_type": null, 
  "margin": null, 
  "margin_block_end": null, 
  "margin_block_start": null, 
  "margin_bottom": null, 
  "margin_inline_end": null, 
  "margin_inline_start": null, 
  "margin_left": null, 
  "margin_right": null, 
  "margin_top": null, 
  "marker": null, 
  "marker_end": null, 
  "marker_mid": null, 
  "marker_start": null, 
  "mask": null, 
  "mask_composite": null, 
  "mask_image": null, 
  "mask_position": null, 
  "mask_repeat": null, 
  "mask_size": null, 
  "mask_type": null, 
  "max_block_size": null, 
  "max_height": null, 
  "max_inline_size": null, 
  "max_width": null, 
  "min_block_size": null, 
  "min_height": null, 
  "min_inline_size": null, 
  "min_width": null, 
  "name": null, 
  "object_fit": null, 
  "object_position": null, 
  "opacity": null, 
  "order": null, 
  "orphans": null, 
  "outline": null, 
  "outline_color": null, 
  "outline_offset": null, 
  "outline_style": null, 
  "outline_width": null, 
  "overflow": null, 
  "overflow_anchor": null, 
  "overflow_wrap": null, 
  "overflow_x": null, 
  "overflow_y": null, 
  "overscroll_behavior": null, 
  "overscroll_behavior_block": null, 
  "overscroll_behavior_inline": null, 
  "overscroll_behavior_x": null, 
  "overscroll_behavior_y": null, 
  "padding": null, 
  "padding_block_end": null, 
  "padding_block_start": null, 
  "padding_bottom": null, 
  "padding_inline_end": null, 
  "padding_inline_start": null, 
  "padding_left": null, 
  "padding_right": null, 
  "padding_top": null, 
  "page_break_after": null, 
  "page_break_before": null, 
  "page_break_inside": null, 
  "paint_order": null, 
  "perspective": null, 
  "perspective_origin": null, 
  "place_content": null, 
  "place_items": null, 
  "place_self": null, 
  "pointer_events": null, 
  "position": null, 
  "quotes": null, 
  "resize": null, 
  "right": null, 
  "rotate": null, 
  "row_gap": null, 
  "ruby_align": null, 
  "ruby_position": null, 
  "scale": null, 
  "scroll_behavior": null, 
  "shape_rendering": null, 
  "stop_color": null, 
  "stop_opacity": null, 
  "stroke": null, 
  "stroke_dasharray": null, 
  "stroke_dashoffset": null, 
  "stroke_linecap": null, 
  "stroke_linejoin": null, 
  "stroke_miterlimit": null, 
  "stroke_opacity": null, 
  "stroke_width": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tab_size": null, 
  "table_layout": null, 
  "tags": [], 
  "text_align": null, 
  "text_align_last": null, 
  "text_anchor": null, 
  "text_combine_upright": null, 
  "text_decoration": null, 
  "text_decoration_color": null, 
  "text_decoration_line": null, 
  "text_decoration_style": null, 
  "text_emphasis": null, 
  "text_emphasis_color": null, 
  "text_emphasis_position": null, 
  "text_emphasis_style": null, 
  "text_indent": null, 
  "text_justify": null, 
  "text_orientation": null, 
  "text_overflow": null, 
  "text_rendering": null, 
  "text_shadow": null, 
  "text_transform": null, 
  "text_underline_position": null, 
  "top": null, 
  "touch_action": null, 
  "transform": null, 
  "transform_box": null, 
  "transform_origin": null, 
  "transform_style": null, 
  "transition": null, 
  "transition_delay": null, 
  "transition_duration": null, 
  "transition_property": null, 
  "transition_timing_function": null, 
  "translate": null, 
  "unicode_bidi": null, 
  "user_select": null, 
  "vertical_align": null, 
  "visibility": null, 
  "white_space": null, 
  "widows": null, 
  "width": null, 
  "will_change": null, 
  "word_break": null, 
  "word_spacing": null, 
  "word_wrap": null, 
  "writing_mode": null, 
  "z_index": null
}
min_inline_size = None#
类型：

Nullable(String)

The min-inline-size CSS property defines the horizontal or vertical minimal size of an element’s block, depending on its writing mode. It corresponds to either the min-width or the min-height property, depending on the value of writing-mode.

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#
类型：

Bool

指示此模型是否应在 Web 浏览器中更新时同步回 Bokeh 服务器。设置为 False 可能有助于在处理经常更新的对象时减少网络流量，而我们不需要其更新的值。

注意

将此属性设置为 False 将阻止对该对象的任何 on_change() 回调触发。但是，任何 JS 端回调仍将起作用。

tags = []#
类型：

List

一个可选的任意用户提供的附加到此模型的值列表。

当查询文档以检索特定 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

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

这是一种简便方法，简化了添加 CustomJS 回调以在另一个 Bokeh 模型属性更改值时更新一个 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 (可调用对象) – 要注册的回调函数

返回值：

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

生成适合从图形派生的函数的 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, 可选) – 是否包含自对象创建以来未明确设置的属性。 (默认值: True)

返回值：

从属性名称到其值的映射

返回类型:

dict

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

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

参数：

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

  • include_defaults (bool, 可选) – 是否包含用户未明确设置的属性 (默认值: True)

返回值：

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

返回类型:

dict

references() → set[Model]#

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

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

从该对象中删除回调。

select(selector: SelectorType) → Iterable[Model]#

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

参数：

selector (JSON-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）

On this page