字形#

显示各种视觉形状，其属性可以与 ColumnDataSources 中的数据列相关联。

下面是所有字形的完整列表

所有字形都通过基类 Glyph 共享一个最小的通用接口

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

基类：Model

所有字形模型的基类。

注意

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

JSON 原型
{
  "decorations": [], 
  "id": "p57310", 
  "js_event_callbacks": {
    "type": "map"
  }, 
  "js_property_callbacks": {
    "type": "map"
  }, 
  "name": null, 
  "subscribed_events": {
    "type": "set"
  }, 
  "syncable": true, 
  "tags": []
}
decorations = []#
类型：

列表

字形装饰的集合，例如箭头。

使用 GlyphRenderer.add_decoration() 可以轻松地为字形渲染器的所有字形设置。 当需要更精细的控制时，使用此属性。

注意

装饰只用于帮助字形的视觉外观，但它们不参与命中测试等。

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

布尔值

指示此模型在网页浏览器中更新时是否应同步回 Bokeh 服务器。 设置为 False 在处理频繁更新的对象（我们不需要更新值）时减少网络流量可能很有用。

注意

将此属性设置为 False 将阻止此对象上的任何 on_change() 回调触发。 但是，任何 JS 端回调仍然有效。

tags = []#
类型：

列表

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

当查询文档以检索特定 Bokeh 模型时，此数据可能很有用

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

或者只是将任何必要的元数据附加到模型的便捷方法，这些元数据可以通过 CustomJS 回调等访问。

注意

不会对提供的任何标签进行唯一性保证或其他条件强制，也不会直接由 Bokeh 用于任何原因。

apply_theme(property_values: dict[str, Any]) → None#

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

传入的字典可能会被保留并与其他实例共享以节省内存（因此调用方或 HasProps 实例都不应该修改它）。

参数：

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

返回值：

None

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 模型属性以响应另一个模型属性的更改。

参数：

  • 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]#

生成适用于从 glyph 派生的函数的 Python Parameter 值。

返回值：

list(Parameter)

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

收集此类上的属性名称。

警告

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

返回值：

属性名称

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

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

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

返回值：

具有引用的属性名称

返回类型：

set[str]

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

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

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

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

参数：

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

返回值：

从属性名称到它们值的映射

返回类型：

dict

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

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

参数：

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

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

返回值：

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

返回类型：

dict

references() → set[Model]#

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

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

从此对象中移除回调

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

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

参数：

selector (JSON-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) : 要设置的属性名称

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

  • models (dict or None, optional) –

    模型 ID 到模型的映射（默认值：None）

    这在需要更新的属性也具有包含引用的值的情况下是必需的。

  • 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）

本页内容