plots#
表示顶级绘图对象的模型。
- class GridPlot(*args: Any, id: ID | None = None, **kwargs: Any)[source]#
Bases:
LayoutDOM
,GridCommon
在矩形网格上排列的绘图和其他可布局对象的集合。
JSON 原型
{ "align": "auto", "aspect_ratio": null, "children": [], "cols": null, "context_menu": null, "css_classes": [], "css_variables": { "type": "map" }, "disabled": false, "elements": [], "flow_mode": "block", "height": null, "height_policy": "auto", "id": "p61394", "js_event_callbacks": { "type": "map" }, "js_property_callbacks": { "type": "map" }, "margin": null, "max_height": null, "max_width": null, "min_height": null, "min_width": null, "name": null, "resizable": false, "rows": null, "sizing_mode": null, "spacing": 0, "styles": { "type": "map" }, "stylesheets": [], "subscribed_events": { "type": "set" }, "syncable": true, "tags": [], "toolbar": { "id": "p61395", "name": "Toolbar", "type": "object" }, "toolbar_location": "above", "visible": true, "width": null, "width_policy": "auto" }
- align = 'auto'#
-
父容器内的对齐点。
此属性仅在该组件是布局的子元素(例如网格)时才有用。自对齐可以被父容器(例如网格轨道对齐)覆盖。
- aspect_ratio = None#
-
描述组件宽度和高度之间的比例关系。
如果组件的任何尺寸在大小上是灵活的,则此方法有效。如果设置为一个数字,则将保持
width / height = aspect_ratio
关系。否则,如果设置为"auto"
,则将使用组件的首选宽度和高度来确定纵横比(如果未设置,则不会保留纵横比)。
- cols = None#
-
描述网格如何维护其列宽。
这对应于 CSS 网格的轨道大小选项。特别是允许以下值
长度,例如
100px
,5.5em
百分比,例如
33%
flex,例如 1fr
枚举,例如
max-content
,min-content
,auto
等等。
如果提供单个值,则它适用于所有列。可以提供一个值列表来调整所有列的大小,或提供一个字典来为各个列提供大小。
有关详细信息,请参阅 https://mdn.org.cn/en-US/docs/Web/CSS/grid-template-columns 或 https://w3c.github.io/csswg-drafts/css-grid/#track-sizing。
- css_variables = {}#
-
允许定义动态计算的 CSS 变量。
例如,这可以用于协调画布渲染器和/或视觉效果与基于 HTML 的 UI 元素之间的定位和样式。
此处定义的变量等效于在 CSS 样式表中
:host { ... }
下设置相同的变量。注意
此属性是实验性的,可能会在任何时候更改。
- height = None#
- 类型:
组件的高度(以像素为单位)。
这可以是固定高度或首选高度,具体取决于高度大小策略。
- height_policy = 'auto'#
- 类型:
描述组件如何维护其高度。
"auto"
使用组件的首选大小策略。
"fixed"
使用正好
height
像素。如果组件无法容纳在可用的垂直空间中,则会溢出。"fit"
使用组件的首选高度(如果设置),并允许其适合最小和最大高度边界(如果设置)内的可用垂直空间。组件的高度既不会被积极地最小化,也不会被最大化。
"min"
使用尽可能少的垂直空间,不小于最小高度(如果设置)。起点是首选高度(如果设置)。组件的高度可能会根据父布局、纵横比管理和其他因素而缩小或增长。
"max"
使用尽可能多的垂直空间,不超过最大高度(如果设置)。起点是首选高度(如果设置)。组件的高度可能会根据父布局、纵横比管理和其他因素而缩小或增长。
注意
这是一个实验性功能,可能会在将来更改。请自行决定使用它。如果不需要这种级别的控制,建议使用
sizing_mode
。
- margin = None#
-
允许在组件周围创建额外的空间。元组中的值按以下顺序排列 - 顶部边距、右侧边距、底部边距和左侧边距,类似于 CSS 标准。负边距值可用于从任何方向缩小空间。
- max_height = None#
- 类型:
如果高度可调,则组件的最大高度(以像素为单位)。
- max_width = None#
- 类型:
如果宽度可调,则组件的最大宽度(以像素为单位)。
- min_height = None#
- 类型:
如果高度可调,则组件的最小高度(以像素为单位)。
- min_width = None#
- 类型:
如果宽度可调整,则组件的最小宽度(以像素为单位)。
- name = None#
-
为此模型提供的任意用户提供的名称。
当查询文档以检索特定 Bokeh 模型时,此名称可能会有用。
>>> plot.circle([1,2,3], [4,5,6], name="temp") >>> plot.select(name="temp") [GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]
注意
对提供的任何名称不进行唯一性保证或其他条件强制,并且 Bokeh 不会出于任何原因直接使用该名称。
- resizable = False#
- 类型:
Either
(Bool
,Enum
(Dimensions
))
布局是否可交互调整大小,如果是,则在哪些维度。
- rows = None#
-
描述网格应如何保持其行的高度。
这对应于 CSS 网格的轨道大小选项。特别是允许以下值
长度,例如
100px
,5.5em
百分比,例如
33%
flex,例如 1fr
枚举,例如
max-content
,min-content
,auto
等等。
如果提供单个值,则它适用于所有行。可以提供值列表来调整所有行的大小,或提供字典来提供单个行的尺寸。
有关详细信息,请参见 https://mdn.org.cn/en-US/docs/Web/CSS/grid-template-rows 或 https://w3c.github.io/csswg-drafts/css-grid/#track-sizing。
- sizing_mode = None#
- 类型:
组件应如何调整自身大小。
这是用于维护组件宽度和高度的高级设置。要获得对尺寸的更细粒度的控制,请改用
width_policy
、height_policy
和aspect_ratio
(这些优先于sizing_mode
)。可能的情况
"inherit"
尺寸模式从父布局继承。如果没有父布局(或父布局不是布局),则此值将被视为没有提供
sizing_mode
的值。"fixed"
组件没有响应。它将保留其原始宽度和高度,而不管任何后续浏览器窗口调整大小事件。
"stretch_width"
组件将响应式调整大小以拉伸到可用宽度,而不保持任何纵横比。组件的高度取决于组件的类型,并且可能是固定的或适合组件的内容。
"stretch_height"
组件将响应式调整大小以拉伸到可用高度,而不保持任何纵横比。组件的宽度取决于组件的类型,并且可能是固定的或适合组件的内容。
"stretch_both"
组件完全响应,宽度和高度独立,并将占用所有可用的水平和垂直空间,即使这会改变组件的纵横比。
"scale_width"
组件将响应式调整大小以拉伸到可用宽度,同时保持原始或提供的纵横比。
"scale_height"
组件将响应式调整大小以拉伸到可用高度,同时保持原始或提供的纵横比。
"scale_both"
组件将响应式调整大小以适应可用宽度和高度,同时保持原始或提供的纵横比。
- spacing = 0#
- 类型:
子节点之间的间隙(以像素为单位)。
如果间距在两个维度上都相同,则为一个数字,否则为一对数字,分别指示垂直和水平维度的间距。
- stylesheets = []#
- 类型:
用于基础 DOM 元素的额外样式表。
请注意,所有 bokeh 的组件都使用 shadow DOM,因此任何包含的样式表都必须反映这一点,例如使用
:host
CSS 伪选择器来访问根 DOM 元素。
- 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 不会出于任何原因直接使用这些标记。
- width = None#
- 类型:
组件的宽度(以像素为单位)。
这可以是固定宽度或首选宽度,具体取决于宽度大小策略。
- width_policy = 'auto'#
- 类型:
描述组件应该如何保持其宽度。
"auto"
使用组件的首选大小策略。
"fixed"
使用正好
width
像素。如果组件无法适应可用水平空间,它将溢出。"fit"
使用组件的首选宽度(如果已设置)并允许它在最小和最大宽度边界(如果已设置)内适应可用水平空间。组件的宽度既不会被强制缩小也不会被强制扩大。
"min"
尽可能少地使用水平空间,不少于最小宽度(如果已设置)。起点是首选宽度(如果已设置)。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或扩大。
"max"
尽可能多地使用水平空间,不多于最大宽度(如果已设置)。起点是首选宽度(如果已设置)。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或扩大。
注意
这是一个实验性功能,可能会在将来更改。请自行决定使用它。如果不需要这种级别的控制,建议使用
sizing_mode
。
- apply_theme(property_values: dict[str, Any]) None #
应用一组主题值,这些主题值将用于代替默认值,但不会覆盖应用程序设置的值。
传入的字典可以保留原样并与其他实例共享以节省内存(因此调用者和
HasProps
实例都不应该修改它)。- 参数:
property_values (dict) – 用于代替默认值的主题值
- 返回值:
None
- classmethod clear_extensions() None #
清除任何当前定义的自定义扩展。
序列化调用将导致任何当前定义的自定义扩展被包含在生成的文档中,无论它们是否被使用。此方法可用于清除所有现有的自定义扩展定义。
- classmethod dataspecs() dict[str, DataSpec] #
收集此类中所有
DataSpec
属性的名称。此方法 *总是* 遍历类层次结构,并包含在任何父类中定义的属性。
- 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) – 要注册的回调函数
- 返回值:
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 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 服务器应用程序的上下文中,对属性的传入更新将用执行更新的会话进行注释。此值会传播到更新触发的任何后续更改通知。会话可以将事件设置程序与其自身进行比较,并抑制来自自身的所有更新。
- 返回值:
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
。- 返回值:
字典或无
- to_serializable(serializer: Serializer) ObjectRefRep #
将此对象转换为可序列化表示形式。
- trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = None) None #
- class Plot(*args: Any, id: ID | None = None, **kwargs: Any)[source]#
Bases:
LayoutDOM
表示包含图形、指南、注释的绘图的模型。
JSON 原型
{ "above": [], "align": "auto", "aspect_ratio": null, "aspect_scale": 1, "attribution": [], "background_fill_alpha": 1.0, "background_fill_color": "#ffffff", "below": [], "border_fill_alpha": 1.0, "border_fill_color": "#ffffff", "center": [], "context_menu": null, "css_classes": [], "css_variables": { "type": "map" }, "disabled": false, "elements": [], "extra_x_ranges": { "type": "map" }, "extra_x_scales": { "type": "map" }, "extra_y_ranges": { "type": "map" }, "extra_y_scales": { "type": "map" }, "flow_mode": "block", "frame_align": true, "frame_height": null, "frame_width": null, "height": 600, "height_policy": "auto", "hidpi": true, "hold_render": false, "id": "p61459", "js_event_callbacks": { "type": "map" }, "js_property_callbacks": { "type": "map" }, "left": [], "lod_factor": 10, "lod_interval": 300, "lod_threshold": 2000, "lod_timeout": 500, "margin": null, "match_aspect": false, "max_height": null, "max_width": null, "min_border": 5, "min_border_bottom": null, "min_border_left": null, "min_border_right": null, "min_border_top": null, "min_height": null, "min_width": null, "name": null, "outline_line_alpha": 1.0, "outline_line_cap": "butt", "outline_line_color": "#e5e5e5", "outline_line_dash": [], "outline_line_dash_offset": 0, "outline_line_join": "bevel", "outline_line_width": 1, "output_backend": "canvas", "renderers": [], "reset_policy": "standard", "resizable": false, "right": [], "sizing_mode": null, "styles": { "type": "map" }, "stylesheets": [], "subscribed_events": { "type": "set" }, "syncable": true, "tags": [], "title": { "id": "p61464", "name": "Title", "type": "object" }, "title_location": "above", "toolbar": { "id": "p61465", "name": "Toolbar", "type": "object" }, "toolbar_inner": false, "toolbar_location": "right", "toolbar_sticky": true, "visible": true, "width": 600, "width_policy": "auto", "x_range": { "id": "p61460", "name": "DataRange1d", "type": "object" }, "x_scale": { "id": "p61462", "name": "LinearScale", "type": "object" }, "y_range": { "id": "p61461", "name": "DataRange1d", "type": "object" }, "y_scale": { "id": "p61463", "name": "LinearScale", "type": "object" } }
- align = 'auto'#
-
父容器内的对齐点。
此属性仅在该组件是布局的子元素(例如网格)时才有用。自对齐可以被父容器(例如网格轨道对齐)覆盖。
- aspect_ratio = None#
-
描述组件宽度和高度之间的比例关系。
如果组件的任何尺寸在大小上是灵活的,则此方法有效。如果设置为一个数字,则将保持
width / height = aspect_ratio
关系。否则,如果设置为"auto"
,则将使用组件的首选宽度和高度来确定纵横比(如果未设置,则不会保留纵横比)。
- aspect_scale = 1#
- 类型:
用于增加纵横比控制的值。此值乘积加到为
match_aspect
计算所需的值。aspect_scale
定义为图形宽度与高度的比率。例如,
aspect_scale
值为 2 的绘图将导致屏幕上以数据单位绘制的正方形以长宽比为 2 的矩形显示。注意
此设置仅在
match_aspect
设置为True
时生效。
- attribution = []#
- 类型:
允许承认或给予数据、图块等提供者的荣誉。
这可以是 HTML 或纯文本形式。渲染器(如图块渲染器)可以提供其他归属,这些归属将在此处提供的归属之后添加。
注意
此功能是实验性的,可能会在短期内发生变化。
- css_variables = {}#
-
允许定义动态计算的 CSS 变量。
例如,这可以用于协调画布渲染器和/或视觉效果与基于 HTML 的 UI 元素之间的定位和样式。
此处定义的变量等效于在 CSS 样式表中
:host { ... }
下设置相同的变量。注意
此属性是实验性的,可能会在任何时候更改。
- extra_x_scales = {}#
-
用于映射 x 坐标的额外命名比例。
这对于添加额外的轴很有用。
注意
此功能是实验性的,可能会在短期内发生变化。
- extra_y_scales = {}#
-
用于映射 y 坐标的额外命名比例。
这对于添加额外的轴很有用。
注意
此功能是实验性的,可能会在短期内发生变化。
- frame_align = True#
-
允许指定在多图布局中对齐哪些框架边缘。
默认情况下对齐所有边缘,但用户可以选择退出对每个单独边缘或所有边缘的对齐。还要注意,其他属性可能会禁用某些边缘的对齐,尤其是在使用固定框架大小(
frame_width
和frame_height
属性)时。
- height = 600#
- 类型:
组件的高度(以像素为单位)。
这可以是固定高度或首选高度,具体取决于高度大小策略。
- height_policy = 'auto'#
- 类型:
描述组件如何维护其高度。
"auto"
使用组件的首选大小策略。
"fixed"
使用正好
height
像素。如果组件无法容纳在可用的垂直空间中,则会溢出。"fit"
使用组件的首选高度(如果设置),并允许其适合最小和最大高度边界(如果设置)内的可用垂直空间。组件的高度既不会被积极地最小化,也不会被最大化。
"min"
使用尽可能少的垂直空间,不小于最小高度(如果设置)。起点是首选高度(如果设置)。组件的高度可能会根据父布局、纵横比管理和其他因素而缩小或增长。
"max"
使用尽可能多的垂直空间,不超过最大高度(如果设置)。起点是首选高度(如果设置)。组件的高度可能会根据父布局、纵横比管理和其他因素而缩小或增长。
注意
这是一个实验性功能,可能会在将来更改。请自行决定使用它。如果不需要这种级别的控制,建议使用
sizing_mode
。
- hold_render = False#
- 类型:
设置为 True 时,所有重新绘制绘图的请求都将被阻止。
这在定期更新许多图形时很有用。例如,假设我们在一个绘图上有 10 条线,每条线都有自己的数据源。我们在一个循环中每秒向它们中的每一个流式传输,如下所示
for line in lines: line.stream(new_points())
这段代码的问题在于,每一次流式传输都会触发绘图的重新渲染。即使在最后一次流式传输时只重新绘制也能产生几乎相同的视觉效果。特别是对于包含许多点的线,这会变得计算量很大,并可能冻结您的浏览器。使用一个方便的方法 hold,我们可以控制何时启动渲染,如下所示
with plot.hold(render=True): for line in lines: line.stream(new_points())
在这种情况下,我们只在最后一次流式传输之后渲染新追加的点。
- inner_height = Undefined#
- 类型:
只读
这是绘图画布的确切高度,即实际绘图的高度,不包括工具栏等。请注意,这是在 Web 浏览器中计算的,因此该属性仅在能够进行双向通信的后端(服务器、笔记本)中有效。
注意
这是一个实验性功能,API 可能会在不久的将来发生变化。
- inner_width = Undefined#
- 类型:
只读
这是绘图画布的确切宽度,即实际绘图的宽度,不包括工具栏等。请注意,这是在 Web 浏览器中计算的,因此该属性仅在能够进行双向通信的后端(服务器、笔记本)中有效。
注意
这是一个实验性功能,API 可能会在不久的将来发生变化。
- lod_timeout = 500#
- 类型:
用于检查交互式工具事件是否仍在发生的超时(以毫秒为单位)。启用细节级别模式后,每
lod_timeout
毫秒执行一次检查。如果未发生交互式工具事件,则会禁用细节级别模式。
- margin = None#
-
允许在组件周围创建额外的空间。元组中的值按以下顺序排列 - 顶部边距、右侧边距、底部边距和左侧边距,类似于 CSS 标准。负边距值可用于从任何方向缩小空间。
- match_aspect = False#
- 类型:
指定绘图的长宽比行为。长宽比定义为宽度与高度的比率。此属性控制 Bokeh 是否应该尝试将数据空间的(宽度/高度)与屏幕空间的像素(宽度/高度)进行匹配。
默认值为
False
,表示数据长宽比和屏幕长宽比独立变化。True
表示轴的绘图长宽比将与轴的像素范围长宽比匹配。最终结果是数据空间中的 1x1 区域在像素中是正方形,反之亦然,1x1 像素在数据单位中是正方形。注意
此设置仅在存在两个数据范围时生效。此设置仅设置初始绘图绘制和随后的重置。工具(单轴缩放、无约束框缩放)可能会更改长宽比。
警告
此设置与跨多个绘图链接数据范围不兼容。这样做可能会导致未定义的行为。
- max_height = None#
- 类型:
如果高度可调,则组件的最大高度(以像素为单位)。
- max_width = None#
- 类型:
如果宽度可调,则组件的最大宽度(以像素为单位)。
- min_border = 5#
-
一个方便的属性,用于将所有
min_border_X
属性设置为相同的值。如果显式设置了单个边框属性,它将覆盖min_border
。
- min_height = None#
- 类型:
如果高度可调,则组件的最小高度(以像素为单位)。
- min_width = None#
- 类型:
如果宽度可调整,则组件的最小宽度(以像素为单位)。
- name = None#
-
为此模型提供的任意用户提供的名称。
当查询文档以检索特定 Bokeh 模型时,此名称可能会有用。
>>> plot.circle([1,2,3], [4,5,6], name="temp") >>> plot.select(name="temp") [GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]
注意
对提供的任何名称不进行唯一性保证或其他条件强制,并且 Bokeh 不会出于任何原因直接使用该名称。
- outer_height = Undefined#
- 类型:
只读
这是布局的精确高度,即实际绘图的高度,包括工具栏等。注意,这是在 Web 浏览器中计算的,因此此属性仅在支持双向通信的后端(服务器、笔记本)中有效。
注意
这是一个实验性功能,API 可能会在不久的将来发生变化。
- outer_width = Undefined#
- 类型:
只读
这是布局的精确宽度,即实际绘图的高度,包括工具栏等。注意,这是在 Web 浏览器中计算的,因此此属性仅在支持双向通信的后端(服务器、笔记本)中有效。
注意
这是一个实验性功能,API 可能会在不久的将来发生变化。
- outline_line_dash = []#
- 类型:
绘图边框轮廓的线条虚线样式。
- output_backend = 'canvas'#
- 类型:
指定绘图区域的输出后端。默认值为 HTML5 Canvas。
注意
当设置为
webgl
时,没有 WebGL 渲染实现的图形将回退到 2D 画布上的渲染。
- reset_policy = 'standard'#
- 类型:
绘图应该如何响应重置。默认情况下,标准操作是清除所有工具状态历史记录,将绘图范围恢复到其原始值,撤消所有选择并发出
Reset
事件。如果需要自定义,此属性可以设置为"event_only"
,这将抑制除重置事件之外的所有操作。
- resizable = False#
- 类型:
Either
(Bool
,Enum
(Dimensions
))
布局是否可交互调整大小,如果是,则在哪些维度。
- sizing_mode = None#
- 类型:
组件应如何调整自身大小。
这是用于维护组件宽度和高度的高级设置。要获得对尺寸的更细粒度的控制,请改用
width_policy
、height_policy
和aspect_ratio
(这些优先于sizing_mode
)。可能的情况
"inherit"
尺寸模式从父布局继承。如果没有父布局(或父布局不是布局),则此值将被视为没有提供
sizing_mode
的值。"fixed"
组件没有响应。它将保留其原始宽度和高度,而不管任何后续浏览器窗口调整大小事件。
"stretch_width"
组件将响应式调整大小以拉伸到可用宽度,而不保持任何纵横比。组件的高度取决于组件的类型,并且可能是固定的或适合组件的内容。
"stretch_height"
组件将响应式调整大小以拉伸到可用高度,而不保持任何纵横比。组件的宽度取决于组件的类型,并且可能是固定的或适合组件的内容。
"stretch_both"
组件完全响应,宽度和高度独立,并将占用所有可用的水平和垂直空间,即使这会改变组件的纵横比。
"scale_width"
组件将响应式调整大小以拉伸到可用宽度,同时保持原始或提供的纵横比。
"scale_height"
组件将响应式调整大小以拉伸到可用高度,同时保持原始或提供的纵横比。
"scale_both"
组件将响应式调整大小以适应可用宽度和高度,同时保持原始或提供的纵横比。
- stylesheets = []#
- 类型:
用于基础 DOM 元素的额外样式表。
请注意,所有 bokeh 的组件都使用 shadow DOM,因此任何包含的样式表都必须反映这一点,例如使用
:host
CSS 伪选择器来访问根 DOM 元素。
- 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 不会出于任何原因直接使用这些标记。
- width = 600#
- 类型:
组件的宽度(以像素为单位)。
这可以是固定宽度或首选宽度,具体取决于宽度大小策略。
- width_policy = 'auto'#
- 类型:
描述组件应该如何保持其宽度。
"auto"
使用组件的首选大小策略。
"fixed"
使用正好
width
像素。如果组件无法适应可用水平空间,它将溢出。"fit"
使用组件的首选宽度(如果已设置)并允许它在最小和最大宽度边界(如果已设置)内适应可用水平空间。组件的宽度既不会被强制缩小也不会被强制扩大。
"min"
尽可能少地使用水平空间,不少于最小宽度(如果已设置)。起点是首选宽度(如果已设置)。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或扩大。
"max"
尽可能多地使用水平空间,不多于最大宽度(如果已设置)。起点是首选宽度(如果已设置)。组件的宽度可能会根据父布局、纵横比管理和其他因素而缩小或扩大。
注意
这是一个实验性功能,可能会在将来更改。请自行决定使用它。如果不需要这种级别的控制,建议使用
sizing_mode
。
- add_glyph(glyph: Glyph, **kwargs: Any) GlyphRenderer [source]#
- add_glyph(source: ColumnarDataSource, glyph: Glyph, **kwargs: Any) GlyphRenderer
将一个 glyph 添加到绘图中,并关联数据源和范围。
此函数将负责创建和配置一个 Glyph 对象,然后将其添加到绘图的渲染器列表中。
- 参数:
source (DataSource) – 所有 glyph 共用的数据源
glyph (Glyph) – 要添加到绘图的 glyph
- 关键字参数:
the (传递给)
initializer. (Glyph)
- 返回值:
GlyphRenderer
- add_layout(obj: Renderer, place: Literal['above', 'below', 'left', 'right', 'center'] = 'center') None [source]#
在指定位置将对象添加到绘图中。
- add_tile(tile_source: TileSource | TileProvider | str, retina: bool = False, **kwargs: Any) TileRenderer [source]#
将新的
TileRenderer
添加到Plot.renderers
中- 参数:
tile_source (TileSource, xyzservices.TileProvider, str) – 包含图块集配置的图块源实例
retina (bool) – 是否使用图块的视网膜版本(如果可用)
- 关键字参数:
renderer (将其他关键字参数传递给图块)
- 返回值:
TileRenderer
- 返回类型:
- apply_theme(property_values: dict[str, Any]) None #
应用一组主题值,这些主题值将用于代替默认值,但不会覆盖应用程序设置的值。
传入的字典可以保留原样并与其他实例共享以节省内存(因此调用者和
HasProps
实例都不应该修改它)。- 参数:
property_values (dict) – 用于代替默认值的主题值
- 返回值:
None
- classmethod clear_extensions() None #
清除任何当前定义的自定义扩展。
序列化调用将导致任何当前定义的自定义扩展被包含在生成的文档中,无论它们是否被使用。此方法可用于清除所有现有的自定义扩展定义。
- classmethod dataspecs() dict[str, DataSpec] #
收集此类中所有
DataSpec
属性的名称。此方法 *总是* 遍历类层次结构,并包含在任何父类中定义的属性。
- classmethod descriptors() list[PropertyDescriptor[Any]] #
按定义顺序排列的属性描述符列表。
- equals(other: HasProps) bool #
模型的结构相等性。
- 参数:
other (HasProps) – 要比较的另一个实例
- 返回值:
如果属性在结构上相等,则为 True,否则为 False
- hold(*, render: bool) Generator[None, None, None] [source]#
在范围内打开和关闭属性。
- 参数:
render (bool) – 打开或关闭 hold_render 属性。
- 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) – 要注册的回调函数
- 返回值:
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 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(*args, **kwargs)[source]#
查询此对象及其所有引用,以查找与给定选择器匹配的对象。
调用
select
方法有几种不同的方式。最通用的方式是提供一个类似 JSON 的查询字典作为单个参数,或作为关键字参数。- 参数:
selector (JSON-like) – 一些示例文本
- 关键字参数:
kwargs – 查询字典键/值作为关键字参数
此外,为了与
Model.select
兼容,可以将选择器字典作为selector
关键字参数传递,在这种情况下,kwargs['selector']
的值将用于查询。为了方便起见,可以通过将
name
字符串作为单个参数来进行仅对名称的查询。- 参数:
name (str) – 要查询的名称
同样,可以通过简单地提供
Model
子类作为单个参数来进行仅对类型的查询。- 参数:
type (Model) – 要查询的类型
- 返回值:
seq[Model]
示例
# These three are equivalent p.select(selector={"type": HoverTool}) p.select({"type": HoverTool}) p.select(HoverTool) # These two are also equivalent p.select({"name": "mycircle"}) p.select("mycircle") # Keyword arguments can be supplied in place of selector dict p.select({"name": "foo", "type": HoverTool}) p.select(name="foo", type=HoverTool)
- 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
。- 返回值:
字典或无
- to_serializable(serializer: Serializer) ObjectRefRep #
将此对象转换为可序列化表示形式。
- trigger(attr: str, old: Any, new: Any, hint: DocumentPatchedEvent | None = None, setter: Setter | None = 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 legend#
可展开的
Legend
对象列表。