glyphs#
显示各种视觉形状,其属性可以与来自 ColumnDataSources
的数据列关联。
完整的图示列表如下
- Annular Wedge
- Annulus
- Arc
- Bezier
- Block
- Circle
- Ellipse
- HArea
- HAreaStep
- HBar
- HexTile
- HSpan
- HStrip
- Image
- ImageRGBA
- ImageStack
- ImageURL
- Line
- Marker
- MathMLGlyph
- MathTextGlyph
- MultiLine
- MultiPolygons
- Ngon
- Patch
- Patches
- Quad
- Quadratic
- Ray
- Rect
- Scatter
- Segment
- Step
- TeXGlyph
- Text
- VArea
- VAreaStep
- VBar
- VSpan
- VStrip
- Wedge
- XYGlyph
所有图示都通过基类 Glyph
共享一个最小的公共接口
- class Glyph(*args: Any, id: ID | None = None, **kwargs: Any)[source]#
Bases:
Model
所有图示模型的基础类。
注意
这是一个抽象基类,用于帮助组织 Bokeh 模型类型的层次结构。它本身实例化是没有用的。
JSON 原型
{ "decorations": [], "id": "p59235", "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#
-
此模型的一个任意的、用户提供的名称。
在查询文档以检索特定的 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) – 用于代替默认值的主题值
- 返回值:
无
- classmethod clear_extensions() None #
清除当前定义的所有自定义扩展。
序列化调用将导致任何当前定义的自定义扩展包含在生成的文档中,无论是否使用。此方法可用于清除所有现有的自定义扩展定义。
- classmethod descriptors() list[PropertyDescriptor[Any]] #
属性描述符列表,按定义顺序排列。
- 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 模型属性的操作。- 参数:
在版本 1.1 中添加
- 引发:
示例
使用
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
的属性的描述符- 返回类型:
- on_change(attr: str, *callbacks: PropertyCallback) None #
在此对象上添加一个回调,以便在
attr
更改时触发。- 参数:
attr (str) – 此对象上的属性名称
*callbacks (callable) – 要注册的回调函数
- 返回值:
无
示例
widget.on_change('value', callback1, callback2, ..., callback_n)
- on_event(event: str | type[Event], *callbacks: Callable[[Event], None] | Callable[[], None]) None #
当指定事件在此 Model 上发生时运行回调
并非所有 Model 都支持所有事件。有关哪些 Model 能够触发事件的更多信息,请参阅 bokeh.events 中的特定事件。
- classmethod properties(*, _with_props: bool = False) set[str] | dict[str, Property[Any]] #
收集此类上的属性名称。
警告
在未来的 Bokeh 版本中,此方法将返回一个字典,将属性名称映射到属性对象。为了使此方法的当前用法在未来保持有效,请将返回值包装在 list 中。
- 返回值:
属性名称
- classmethod properties_with_refs() dict[str, Property[Any]] #
收集此类上所有也具有引用的属性的名称。
此方法始终遍历类层次结构,并包括在任何父类上定义的属性。
- properties_with_values(*, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any] #
收集将属性名称映射到其值的字典。
此方法始终遍历类层次结构,并包括在任何父类上定义的属性。
不可序列化的属性将被跳过,并且属性值采用“序列化”格式,这可能与您通常从属性中读取的值略有不同;此方法的目的是返回无损地重建对象实例所需的信息。
- query_properties_with_values(query: Callable[[PropertyDescriptor[Any]], bool], *, include_defaults: bool = True, include_undefined: bool = False) dict[str, Any] #
使用谓词查询
HasProps
实例的属性值。
- 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 服务器应用程序的上下文中,传入的属性更新将使用正在执行更新的会话进行注释。此值会传播到更新触发的任何后续更改通知。会话可以将事件 setter 与自身进行比较,并抑制源自自身的任何更新。
- 返回值:
无
- set_select(selector: type[Model] | SelectorType, updates: dict[str, Any]) None #
使用指定的属性/值更新来更新与给定选择器匹配的对象。
- 参数:
selector (JSON-like)
updates (dict)
- 返回值:
无
- 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 #