选择#

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

基类: SelectionPolicy

当数据源在多个渲染器之间共享时,仅当每个渲染器的点都被选中时,数据源中的行才会被选中。选择是从所有渲染器的命中测试结果的交集中进行的。

JSON 原型
{
  "id": "p64760", 
  "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.scatter([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.scatter([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 (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, 可选) – 是否包括自对象创建以来尚未显式设置的属性。(默认值: 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, 可选) – 是否包括用户尚未显式设置的属性 (默认值: 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

返回:

模型

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

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

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

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

  • setter (ClientSessionServerSessionNone, 可选) –

    这用于防止对 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 Selection(*args: Any, id: ID | None = None, **kwargs: Any)[source]#

基类: Model

Selection 表示 DataSource 中数据的某一部分,可以在绘图中以可视方式进行操作。

选择通常通过使用 SelectTool 在绘图中选择点来创建,但也可以通过编程方式指定。

对于大多数字形,indices 属性是要使用的相关值。

JSON 原型
{
  "id": "p64764", 
  "image_indices": [], 
  "indices": [], 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "line_indices": [], 
  "multiline_indices": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}
image_indices = []#
类型:

列表

indices = []#
类型:

Seq(Int)

选择中包含的“散点”级别索引。例如,对于 Circle 字形上的选择,此列表记录了选择了哪些单独的圆的索引。

对于“多”字形,如 PatchesMultiLineMultiPolygons 等,此列表记录了选择了哪些整个子项的索引。例如,MultiPolygon 的哪些单独多边形被选中。

line_indices = []#
类型:

Seq(Int)

Line 字形上选择中包含的点索引。

此值记录了通过选择工具在 Line 上选择的各个点的索引。

multiline_indices = {}#
类型:

Dict(Int, Seq(Int))

MultiLine 上选择中包含的详细点索引。

此值记录了 MultiLine 上选择中哪些点在哪些线上。键是顶级索引(即哪条线),它映射到索引列表(即该线上的哪些点)。

如果您只需要知道选择了哪些线,而不需要知道这些线上选择了哪些单独的点,那么您可以查看此字典的键(转换为整数)。

name = None#
类型:

Nullable(String)

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

在查询文档以检索特定的 Bokeh 模型时,此名称可能很有用。

>>> plot.scatter([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.scatter([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 (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, 可选) – 是否包括自对象创建以来尚未显式设置的属性。(默认值: 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, 可选) – 是否包括用户尚未显式设置的属性 (默认值: 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

返回:

模型

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

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

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

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

  • setter (ClientSessionServerSessionNone, 可选) –

    这用于防止对 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 SelectionPolicy(*args: Any, id: ID | None = None, **kwargs: Any)[source]#

基类: Model

注意

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

JSON 原型
{
  "id": "p64772", 
  "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.scatter([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.scatter([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 (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)

类方法 properties(*, _with_props: 布尔值 = False) 集合[字符串] | 字典[字符串, Property[Any]]#

收集此类上属性的名称。

警告

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

返回:

属性名称

类方法 properties_with_refs() 字典[字符串, Property[Any]]#

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

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

返回:

具有引用的属性的名称

返回类型:

set[str]

properties_with_values(*, include_defaults: 布尔值 = True, include_undefined: 布尔值 = False) 字典[字符串, Any]#

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

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

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

参数:

include_defaults (bool, 可选) – 是否包括自对象创建以来尚未显式设置的属性。(默认值: True)

返回:

从属性名称到其值的映射

返回类型:

dict

query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], 布尔值], *, include_defaults: 布尔值 = True, include_undefined: 布尔值 = False) 字典[字符串, Any]#

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

参数:
  • query (callable) – 接受属性描述符并返回 True 或 False 的可调用对象

  • include_defaults (bool, 可选) – 是否包括用户尚未显式设置的属性 (默认值: True)

返回:

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

返回类型:

dict

references() 集合[Model]#

返回此对象引用的所有 Models

remove_on_change(attr: 字符串, *callbacks: Callable[[字符串, 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

返回:

模型

set_from_json(name: 字符串, value: Any, *, setter: Setter | None = None) None#

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

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

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

  • setter (ClientSessionServerSessionNone, 可选) –

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

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

返回:

None

set_select(selector: type[Model] | SelectorType, updates: 字典[字符串, Any]) None#

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

参数:
  • selector (JSON-like)

  • updates (dict)

返回:

None

themed_values() 字典[字符串, Any] | None#

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

结果作为从属性名称到值的字典返回,如果此实例没有任何主题覆盖任何值,则返回 None

返回:

dict 或 None

to_serializable(serializer: Serializer) ObjectRefRep#

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

trigger(attr: 字符串, 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)
属性 document: Document | None#

此模型所附加的 Document (可以为 None)

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

基类: SelectionPolicy

当多个渲染器共享一个数据源时,从任何渲染器上选择一个点都会导致数据源中的该行被选中。选择是从所有渲染器的命中测试结果的并集中进行的。

JSON 原型
{
  "id": "p64776", 
  "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.scatter([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.scatter([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: 字典[字符串, Any]) None#

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

传入的字典可以保持原样并与其他实例共享以节省内存(因此,调用方和 HasProps 实例都不应修改它)。

参数:

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

返回:

None

类方法 clear_extensions() None#

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

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

clone(**overrides: Any) Self#

复制 HasProps 对象。

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

类方法 dataspecs() 字典[字符串, DataSpec]#

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

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

返回:

DataSpec 属性的名称

返回类型:

set[str]

类方法 descriptors() 列表[PropertyDescriptor[Any]]#

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

destroy() None#

清理对文档和属性的引用

equals(other: HasProps) 布尔值#

模型的结构相等性。

参数:

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: 字符串, *callbacks: JSChangeCallback) None#

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

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

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

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

source.js_on_change('streaming', callback)
类方法 lookup(name: 字符串, *, raises: 布尔值 = True) PropertyDescriptor[Any] | None#

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

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

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

返回:

名为 name 的属性的描述符

返回类型:

PropertyDescriptor

on_change(attr: 字符串, *callbacks: PropertyCallback) None#

在此对象上添加回调,以在 attr 更改时触发。

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

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

返回:

None

示例

widget.on_change('value', callback1, callback2, ..., callback_n)
on_event(event: 字符串 | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) None#

当在此模型上发生指定的事件时运行回调

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

类方法 parameters() 列表[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 (callable) – 接受属性描述符并返回 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

返回:

模型

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

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

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

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

  • setter (ClientSessionServerSessionNone, 可选) –

    这用于防止对 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)